pip._vendor.rich.progress.Task Class Reference

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

Public Member Functions
float	get_time (self)
bool	started (self)
Optional[float]	remaining (self)
Optional[float]	elapsed (self)
bool	finished (self)
float	percentage (self)
Optional[float]	speed (self)
Optional[float]	time_remaining (self)

Public Attributes
	finished_time
	finished_speed

Static Public Attributes
TaskID	id
str	description
Optional	total [float]
float	completed
Optional	finished_time = None
bool	visible = True
Dict	fields = field(default_factory=dict)
Optional	start_time = field(default=None, init=False, repr=False)
Optional	stop_time = field(default=None, init=False, repr=False)
Optional	finished_speed = None

Protected Member Functions
None	_reset (self)

Static Protected Attributes
GetTimeCallable	_get_time
Deque	_progress
RLock	_lock = field(repr=False, default_factory=RLock)

Detailed Description

Information regarding a progress task.

This object should be considered read-only outside of the :class:`~Progress` class.

Member Function Documentation

_reset()

None pip._vendor.rich.progress.Task._reset (   self )

protected

Reset progress.

elapsed()

Optional[float] pip._vendor.rich.progress.Task.elapsed

(

self

)

Optional[float]: Time elapsed since task was started, or ``None`` if the task hasn't started.

finished()

bool pip._vendor.rich.progress.Task.finished

(

self

)

Check if the task has finished.

get_time()

float pip._vendor.rich.progress.Task.get_time

(

self

)

float: Get the current time, in seconds.

percentage()

float pip._vendor.rich.progress.Task.percentage

(

self

)

float: Get progress of task as a percentage. If a None total was set, returns 0

remaining()

Optional[float] pip._vendor.rich.progress.Task.remaining

(

self

)

Optional[float]: Get the number of steps remaining, if a non-None total was set.

speed()

Optional[float] pip._vendor.rich.progress.Task.speed

(

self

)

Optional[float]: Get the estimated speed in steps per second.

started()

bool pip._vendor.rich.progress.Task.started

(

self

)

bool: Check if the task as started.

time_remaining()

Optional[float] pip._vendor.rich.progress.Task.time_remaining

(

self

)

Optional[float]: Get estimated time to completion, or ``None`` if no data.

Member Data Documentation

_progress

Deque pip._vendor.rich.progress.Task._progress

staticprotected

Initial value:

=  field(
        default_factory=lambda: deque(maxlen=1000), init=False, repr=False
    )

---

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