pip._vendor.rich.console.ConsoleOptions Class Reference

Collaboration diagram for pip._vendor.rich.console.ConsoleOptions:

Public Member Functions
bool	ascii_only (self)
"ConsoleOptions"	copy (self)
"ConsoleOptions"	update (self, *Union[int, NoChange] width=NO_CHANGE, Union[int, NoChange] min_width=NO_CHANGE, Union[int, NoChange] max_width=NO_CHANGE, Union[Optional[JustifyMethod], NoChange] justify=NO_CHANGE, Union[Optional[OverflowMethod], NoChange] overflow=NO_CHANGE, Union[Optional[bool], NoChange] no_wrap=NO_CHANGE, Union[Optional[bool], NoChange] highlight=NO_CHANGE, Union[Optional[bool], NoChange] markup=NO_CHANGE, Union[Optional[int], NoChange] height=NO_CHANGE)
"ConsoleOptions"	update_width (self, int width)
"ConsoleOptions"	update_height (self, int height)
"ConsoleOptions"	reset_height (self)
"ConsoleOptions"	update_dimensions (self, int width, int height)

Static Public Attributes
ConsoleDimensions	size
bool	legacy_windows
int	min_width
int	max_width
bool	is_terminal
str	encoding
int	max_height
Optional	justify = None
Optional	overflow = None
Optional	no_wrap = False
Optional	highlight = None
Optional	markup = None
Optional	height = None

Detailed Description

Options for __rich_console__ method.

Member Function Documentation

ascii_only()

bool pip._vendor.rich.console.ConsoleOptions.ascii_only

(

self

)

Check if renderables should use ascii only.

copy()

"ConsoleOptions" pip._vendor.rich.console.ConsoleOptions.copy

(

self

)

Return a copy of the options.

Returns:
    ConsoleOptions: a copy of self.

reset_height()

"ConsoleOptions" pip._vendor.rich.console.ConsoleOptions.reset_height

(

self

)

Return a copy of the options with height set to ``None``.

Returns:
    ~ConsoleOptions: New console options instance.

update()

"ConsoleOptions" pip._vendor.rich.console.ConsoleOptions.update	(		self,
		*Union[int, NoChange]	width = NO_CHANGE,
		Union[int, NoChange]	min_width = NO_CHANGE,
		Union[int, NoChange]	max_width = NO_CHANGE,
		Union[Optional[JustifyMethod], NoChange]	justify = NO_CHANGE,
		Union[Optional[OverflowMethod], NoChange]	overflow = NO_CHANGE,
		Union[Optional[bool], NoChange]	no_wrap = NO_CHANGE,
		Union[Optional[bool], NoChange]	highlight = NO_CHANGE,
		Union[Optional[bool], NoChange]	markup = NO_CHANGE,
		Union[Optional[int], NoChange]	height = NO_CHANGE
	)

Update values, return a copy.

update_dimensions()

"ConsoleOptions" pip._vendor.rich.console.ConsoleOptions.update_dimensions	(		self,
		int	width,
		int	height
	)

Update the width and height, and return a copy.

Args:
    width (int): New width (sets both min_width and max_width).
    height (int): New height.

Returns:
    ~ConsoleOptions: New console options instance.

update_height()

"ConsoleOptions" pip._vendor.rich.console.ConsoleOptions.update_height	(		self,
		int	height
	)

Update the height, and return a copy.

Args:
    height (int): New height

Returns:
    ~ConsoleOptions: New Console options instance.

update_width()

"ConsoleOptions" pip._vendor.rich.console.ConsoleOptions.update_width	(		self,
		int	width
	)

Update just the width, return a copy.

Args:
    width (int): New width (sets both min_width and max_width)

Returns:
    ~ConsoleOptions: New console options instance.

---

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

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