Inheritance diagram for pip._vendor.rich.progress_bar.ProgressBar:

Collaboration diagram for pip._vendor.rich.progress_bar.ProgressBar:

Public Member Functions
	__init__ (self, Optional[float] total=100.0, float completed=0, Optional[int] width=None, bool pulse=False, StyleType style="bar.back", StyleType complete_style="bar.complete", StyleType finished_style="bar.finished", StyleType pulse_style="bar.pulse", Optional[float] animation_time=None)

str	__repr__ (self)

Optional[float]	percentage_completed (self)

None	update (self, float completed, Optional[float] total=None)

RenderResult	__rich_console__ (self, Console console, ConsoleOptions options)

Measurement	__rich_measure__ (self, Console console, ConsoleOptions options)

Public Attributes
	total

	completed

	width

	pulse

	style

	complete_style

	finished_style

	pulse_style

	animation_time

Protected Member Functions
List[Segment]	_get_pulse_segments (self, Style fore_style, Style back_style, str color_system, bool no_color, bool ascii=False)

Iterable[Segment]	_render_pulse (self, Console console, int width, bool ascii=False)

Protected Member Functions inherited from pip._vendor.rich.jupyter.JupyterMixin
Dict[str, str]	_repr_mimebundle_ ("ConsoleRenderable" self, Sequence[str] include, Sequence[str] exclude, **Any kwargs)

Detailed Description

Renders a (progress) bar. Used by rich.progress.

Args:
    total (float, optional): Number of steps in the bar. Defaults to 100. Set to None to render a pulsing animation.
    completed (float, optional): Number of steps completed. Defaults to 0.
    width (int, optional): Width of the bar, or ``None`` for maximum width. Defaults to None.
    pulse (bool, optional): Enable pulse effect. Defaults to False. Will pulse if a None total was passed.
    style (StyleType, optional): Style for the bar background. Defaults to "bar.back".
    complete_style (StyleType, optional): Style for the completed bar. Defaults to "bar.complete".
    finished_style (StyleType, optional): Style for a finished bar. Defaults to "bar.finished".
    pulse_style (StyleType, optional): Style for pulsing bars. Defaults to "bar.pulse".
    animation_time (Optional[float], optional): Time in seconds to use for animation, or None to use system time.

Member Function Documentation

◆ _get_pulse_segments()

List[Segment] pip._vendor.rich.progress_bar.ProgressBar._get_pulse_segments	(		self,
		Style	fore_style,
		Style	back_style,
		str	color_system,
		bool	no_color,
		bool	ascii = `False`
	)

protected

Get a list of segments to render a pulse animation.

Returns:
    List[Segment]: A list of segments, one segment per character.

◆ _render_pulse()

Iterable[Segment] pip._vendor.rich.progress_bar.ProgressBar._render_pulse	(		self,
		Console	console,
		int	width,
		bool	ascii = `False`
	)

protected

Renders the pulse animation.

Args:
    console (Console): Console instance.
    width (int): Width in characters of pulse animation.

Returns:
    RenderResult: [description]

Yields:
    Iterator[Segment]: Segments to render pulse

◆ percentage_completed()

Optional[float] pip._vendor.rich.progress_bar.ProgressBar.percentage_completed ( self )

Calculate percentage complete.

◆ update()

None pip._vendor.rich.progress_bar.ProgressBar.update	(		self,
		float	completed,
		Optional[float]	total = `None`
	)

Update progress with new values.

Args:
    completed (float): Number of steps completed.
    total (float, optional): Total number of steps, or ``None`` to not change. Defaults to None.

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

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

Public Member Functions