pip._vendor.rich.theme.Theme Class Reference

Collaboration diagram for pip._vendor.rich.theme.Theme:

Public Member Functions
	__init__ (self, Optional[Mapping[str, StyleType]] styles=None, bool inherit=True)
str	config (self)
"Theme"	from_file (cls, IO[str] config_file, Optional[str] source=None, bool inherit=True)
"Theme"	read (cls, str path, bool inherit=True, Optional[str] encoding=None)

Public Attributes
	styles

Static Public Attributes
Dict	styles [str, Style]

Detailed Description

A container for style information, used by :class:`~rich.console.Console`.

Args:
    styles (Dict[str, Style], optional): A mapping of style names on to styles. Defaults to None for a theme with no styles.
    inherit (bool, optional): Inherit default styles. Defaults to True.

Member Function Documentation

config()

str pip._vendor.rich.theme.Theme.config

(

self

)

Get contents of a config file for this theme.

from_file()

"Theme" pip._vendor.rich.theme.Theme.from_file	(		cls,
		IO[str]	config_file,
		Optional[str]	source = None,
		bool	inherit = True
	)

Load a theme from a text mode file.

Args:
    config_file (IO[str]): An open conf file.
    source (str, optional): The filename of the open file. Defaults to None.
    inherit (bool, optional): Inherit default styles. Defaults to True.

Returns:
    Theme: A New theme instance.

read()

"Theme" pip._vendor.rich.theme.Theme.read	(		cls,
		str	path,
		bool	inherit = True,
		Optional[str]	encoding = None
	)

Read a theme from a path.

Args:
    path (str): Path to a config file readable by Python configparser module.
    inherit (bool, optional): Inherit default styles. Defaults to True.
    encoding (str, optional): Encoding of the config file. Defaults to None.

Returns:
    Theme: A new theme instance.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/rich/theme.py