Inheritance diagram for pip._vendor.rich.progress.Progress:

Collaboration diagram for pip._vendor.rich.progress.Progress:

Public Member Functions
None	__init__ (self, *Union[str, ProgressColumn] columns, Optional[Console] console=None, bool auto_refresh=True, float refresh_per_second=10, float speed_estimate_period=30.0, bool transient=False, bool redirect_stdout=True, bool redirect_stderr=True, Optional[GetTimeCallable] get_time=None, bool disable=False, bool expand=False)

Tuple[ProgressColumn,...]	get_default_columns (cls)

Console	console (self)

List[Task]	tasks (self)

List[TaskID]	task_ids (self)

bool	finished (self)

None	start (self)

None	stop (self)

"Progress"	__enter__ (self)

None	__exit__ (self, Optional[Type[BaseException]] exc_type, Optional[BaseException] exc_val, Optional[TracebackType] exc_tb)

Iterable[ProgressType]	track (self, Union[Iterable[ProgressType], Sequence[ProgressType]] sequence, Optional[float] total=None, Optional[TaskID] task_id=None, str description="Working...", float update_period=0.1)

BinaryIO	wrap_file (self, BinaryIO file, Optional[int] total=None, *Optional[TaskID] task_id=None, str description="Reading...")

BinaryIO	open (self, Union[str, "PathLike[str]", bytes] file, Literal["rb"] mode, int buffering=-1, Optional[str] encoding=None, Optional[str] errors=None, Optional[str] newline=None, *Optional[int] total=None, Optional[TaskID] task_id=None, str description="Reading...")

TextIO	open (self, Union[str, "PathLike[str]", bytes] file, Union[Literal["r"], Literal["rt"]] mode, int buffering=-1, Optional[str] encoding=None, Optional[str] errors=None, Optional[str] newline=None, *Optional[int] total=None, Optional[TaskID] task_id=None, str description="Reading...")

Union[BinaryIO, TextIO]	open (self, Union[str, "PathLike[str]", bytes] file, Union[Literal["rb"], Literal["rt"], Literal["r"]] mode="r", int buffering=-1, Optional[str] encoding=None, Optional[str] errors=None, Optional[str] newline=None, *Optional[int] total=None, Optional[TaskID] task_id=None, str description="Reading...")

None	start_task (self, TaskID task_id)

None	stop_task (self, TaskID task_id)

None	update (self, TaskID task_id, Optional[float] total=None, Optional[float] completed=None, Optional[float] advance=None, Optional[str] description=None, Optional[bool] visible=None, bool refresh=False, *Any fields)

None	reset (self, TaskID task_id, bool start=True, Optional[float] total=None, int completed=0, Optional[bool] visible=None, Optional[str] description=None, *Any fields)

None	advance (self, TaskID task_id, float advance=1)

None	refresh (self)

RenderableType	get_renderable (self)

Iterable[RenderableType]	get_renderables (self)

Table	make_tasks_table (self, Iterable[Task] tasks)

RenderableType	__rich__ (self)

TaskID	add_task (self, str description, bool start=True, Optional[float] total=100.0, int completed=0, bool visible=True, **Any fields)

None	remove_task (self, TaskID task_id)

Public Attributes
	columns

	speed_estimate_period

	disable

	expand

	live

	get_time

	print

	log

Protected Attributes
	_lock

	_task_index

Additional Inherited Members
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 an auto-updating progress bar(s).

Args:
    console (Console, optional): Optional Console instance. Default will an internal Console instance writing to stdout.
    auto_refresh (bool, optional): Enable auto refresh. If disabled, you will need to call `refresh()`.
    refresh_per_second (Optional[float], optional): Number of times per second to refresh the progress information or None to use default (10). Defaults to None.
    speed_estimate_period: (float, optional): Period (in seconds) used to calculate the speed estimate. Defaults to 30.
    transient: (bool, optional): Clear the progress on exit. Defaults to False.
    redirect_stdout: (bool, optional): Enable redirection of stdout, so ``print`` may be used. Defaults to True.
    redirect_stderr: (bool, optional): Enable redirection of stderr. Defaults to True.
    get_time: (Callable, optional): A callable that gets the current time, or None to use Console.get_time. Defaults to None.
    disable (bool, optional): Disable progress display. Defaults to False
    expand (bool, optional): Expand tasks table to fit width. Defaults to False.

Member Function Documentation

◆ rich()

RenderableType pip._vendor.rich.progress.Progress.__rich__ ( self )

Makes the Progress class itself renderable.

◆ add_task()

TaskID pip._vendor.rich.progress.Progress.add_task	(		self,
		str	description,
		bool	start = `True`,
		Optional[float]	total = `100.0`,
		int	completed = `0`,
		bool	visible = `True`,
		**Any	fields
	)

Add a new 'task' to the Progress display.

Args:
    description (str): A description of the task.
    start (bool, optional): Start the task immediately (to calculate elapsed time). If set to False,
        you will need to call `start` manually. Defaults to True.
    total (float, optional): Number of total steps in the progress if known.
        Set to None to render a pulsing animation. Defaults to 100.
    completed (int, optional): Number of steps completed so far. Defaults to 0.
    visible (bool, optional): Enable display of the task. Defaults to True.
    **fields (str): Additional data fields required for rendering.

Returns:
    TaskID: An ID you can use when calling `update`.

◆ advance()

None pip._vendor.rich.progress.Progress.advance	(		self,
		TaskID	task_id,
		float	advance = `1`
	)

Advance task by a number of steps.

Args:
    task_id (TaskID): ID of task.
    advance (float): Number of steps to advance. Default is 1.

◆ finished()

bool pip._vendor.rich.progress.Progress.finished ( self )

Check if all tasks have been completed.

◆ get_default_columns()

Tuple[ProgressColumn, ...] pip._vendor.rich.progress.Progress.get_default_columns ( cls )

Get the default columns used for a new Progress instance:
   - a text column for the description (TextColumn)
   - the bar itself (BarColumn)
   - a text column showing completion percentage (TextColumn)
   - an estimated-time-remaining column (TimeRemainingColumn)
If the Progress instance is created without passing a columns argument,
the default columns defined here will be used.

You can also create a Progress instance using custom columns before
and/or after the defaults, as in this example:

    progress = Progress(
        SpinnerColumn(),
        *Progress.default_columns(),
        "Elapsed:",
        TimeElapsedColumn(),
    )

This code shows the creation of a Progress display, containing
a spinner to the left, the default columns, and a labeled elapsed
time column.

◆ get_renderable()

RenderableType pip._vendor.rich.progress.Progress.get_renderable ( self )

Get a renderable for the progress display.

◆ get_renderables()

Iterable[RenderableType] pip._vendor.rich.progress.Progress.get_renderables ( self )

Get a number of renderables for the progress display.

◆ make_tasks_table()

Table pip._vendor.rich.progress.Progress.make_tasks_table	(		self,
		Iterable[Task]	tasks
	)

Get a table to render the Progress display.

Args:
    tasks (Iterable[Task]): An iterable of Task instances, one per row of the table.

Returns:
    Table: A table instance.

◆ open()

Union[BinaryIO, TextIO] pip._vendor.rich.progress.Progress.open	(		self,
		Union[str, "PathLike[str]", bytes]	file,
		Union[Literal["rb"], Literal["rt"], Literal["r"]]	mode = `"r"`,
		int	buffering = `-1`,
		Optional[str]	encoding = `None`,
		Optional[str]	errors = `None`,
		Optional[str]	newline = `None`,
		*Optional[int]	total = `None`,
		Optional[TaskID]	task_id = `None`,
		str	description = `"Reading..."`
	)

Track progress while reading from a binary file.

Args:
    path (Union[str, PathLike[str]]): The path to the file to read.
    mode (str): The mode to use to open the file. Only supports "r", "rb" or "rt".
    buffering (int): The buffering strategy to use, see :func:`io.open`.
    encoding (str, optional): The encoding to use when reading in text mode, see :func:`io.open`.
    errors (str, optional): The error handling strategy for decoding errors, see :func:`io.open`.
    newline (str, optional): The strategy for handling newlines in text mode, see :func:`io.open`.
    total (int, optional): Total number of bytes to read. If none given, os.stat(path).st_size is used.
    task_id (TaskID): Task to track. Default is new task.
    description (str, optional): Description of task, if new task is created.

Returns:
    BinaryIO: A readable file-like object in binary mode.

Raises:
    ValueError: When an invalid mode is given.

◆ refresh()

None pip._vendor.rich.progress.Progress.refresh ( self )

Refresh (render) the progress information.

◆ remove_task()

None pip._vendor.rich.progress.Progress.remove_task	(		self,
		TaskID	task_id
	)

Delete a task if it exists.

Args:
    task_id (TaskID): A task ID.

◆ reset()

None pip._vendor.rich.progress.Progress.reset	(		self,
		TaskID	task_id,
		*bool	start = `True`,
		Optional[float]	total = `None`,
		int	completed = `0`,
		Optional[bool]	visible = `None`,
		Optional[str]	description = `None`,
		**Any	fields
	)

Reset a task so completed is 0 and the clock is reset.

Args:
    task_id (TaskID): ID of task.
    start (bool, optional): Start the task after reset. Defaults to True.
    total (float, optional): New total steps in task, or None to use current total. Defaults to None.
    completed (int, optional): Number of steps completed. Defaults to 0.
    visible (bool, optional): Enable display of the task. Defaults to True.
    description (str, optional): Change task description if not None. Defaults to None.
    **fields (str): Additional data fields required for rendering.

◆ start()

None pip._vendor.rich.progress.Progress.start ( self )

Start the progress display.

◆ start_task()

None pip._vendor.rich.progress.Progress.start_task	(		self,
		TaskID	task_id
	)

Start a task.

Starts a task (used when calculating elapsed time). You may need to call this manually,
if you called ``add_task`` with ``start=False``.

Args:
    task_id (TaskID): ID of task.

◆ stop()

None pip._vendor.rich.progress.Progress.stop ( self )

Stop the progress display.

◆ stop_task()

None pip._vendor.rich.progress.Progress.stop_task	(		self,
		TaskID	task_id
	)

Stop a task.

This will freeze the elapsed time on the task.

Args:
    task_id (TaskID): ID of task.

◆ task_ids()

List[TaskID] pip._vendor.rich.progress.Progress.task_ids ( self )

A list of task IDs.

◆ tasks()

List[Task] pip._vendor.rich.progress.Progress.tasks ( self )

Get a list of Task instances.

◆ track()

Iterable[ProgressType] pip._vendor.rich.progress.Progress.track	(		self,
		Union[Iterable[ProgressType], Sequence[ProgressType]]	sequence,
		Optional[float]	total = `None`,
		Optional[TaskID]	task_id = `None`,
		str	description = `"Working..."`,
		float	update_period = `0.1`
	)

Track progress by iterating over a sequence.

Args:
    sequence (Sequence[ProgressType]): A sequence of values you want to iterate over and track progress.
    total: (float, optional): Total number of steps. Default is len(sequence).
    task_id: (TaskID): Task to track. Default is new task.
    description: (str, optional): Description of task, if new task is created.
    update_period (float, optional): Minimum time (in seconds) between calls to update(). Defaults to 0.1.

Returns:
    Iterable[ProgressType]: An iterable of values taken from the provided sequence.

◆ update()

None pip._vendor.rich.progress.Progress.update	(		self,
		TaskID	task_id,
		*Optional[float]	total = `None`,
		Optional[float]	completed = `None`,
		Optional[float]	advance = `None`,
		Optional[str]	description = `None`,
		Optional[bool]	visible = `None`,
		bool	refresh = `False`,
		**Any	fields
	)

Update information associated with a task.

Args:
    task_id (TaskID): Task id (returned by add_task).
    total (float, optional): Updates task.total if not None.
    completed (float, optional): Updates task.completed if not None.
    advance (float, optional): Add a value to task.completed if not None.
    description (str, optional): Change task description if not None.
    visible (bool, optional): Set visible flag if not None.
    refresh (bool): Force a refresh of progress information. Default is False.
    **fields (Any): Additional data fields required for rendering.

◆ wrap_file()

BinaryIO pip._vendor.rich.progress.Progress.wrap_file	(		self,
		BinaryIO	file,
		Optional[int]	total = `None`,
		*Optional[TaskID]	task_id = `None`,
		str	description = `"Reading..."`
	)

Track progress file reading from a binary file.

Args:
    file (BinaryIO): A file-like object opened in binary mode.
    total (int, optional): Total number of bytes to read. This must be provided unless a task with a total is also given.
    task_id (TaskID): Task to track. Default is new task.
    description (str, optional): Description of task, if new task is created.

Returns:
    BinaryIO: A readable file-like object in binary mode.

Raises:
    ValueError: When no total value can be extracted from the arguments or the task.

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

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

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members