mirrors/rich
1
0
Fork 0
mirror of https://github.com/Textualize/rich.git synced 2025-07-07 21:04:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs and typing

Browse source
This commit is contained in:
Will McGugan 2025-06-19 16:29:29 +01:00
parent d4a15f081b
commit 3813c53b9b
1 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

13
rich/progress.py
View file

@ -29,7 +29,6 @@ from typing import (
NamedTuple,
NewType,
Optional,
Sequence,
TextIO,
Tuple,
Type,
@ -103,7 +102,7 @@ class _TrackThread(Thread):
def track(
sequence: Union[Sequence[ProgressType], Iterable[ProgressType]],
sequence: Iterable[ProgressType],
description: str = "Working...",
total: Optional[float] = None,
completed: int = 0,
@ -122,8 +121,10 @@ def track(
) -> Iterable[ProgressType]:
"""Track progress by iterating over a sequence.
You can also track progress of an iterable, which might require that you additionally specify ``total``.
Args:
sequence (Iterable[ProgressType]): A sequence (must support "len") you wish to iterate over.
sequence (Iterable[ProgressType]): Values you wish to iterate over and track progress.
description (str, optional): Description of task show next to progress bar. Defaults to "Working".
total: (float, optional): Total number of steps. Default is len(sequence).
completed (int, optional): Number of steps completed so far. Defaults to 0.
@ -1189,7 +1190,7 @@ class Progress(JupyterMixin):
def track(
self,
sequence: Union[Iterable[ProgressType], Sequence[ProgressType]],
sequence: Iterable[ProgressType],
total: Optional[float] = None,
completed: int = 0,
task_id: Optional[TaskID] = None,
@ -1198,8 +1199,10 @@ class Progress(JupyterMixin):
) -> Iterable[ProgressType]:
"""Track progress by iterating over a sequence.
You can also track progress of an iterable, which might require that you additionally specify ``total``.
Args:
sequence (Sequence[ProgressType]): A sequence of values you want to iterate over and track progress.
sequence (Iterable[ProgressType]): Values you want to iterate over and track progress.
total: (float, optional): Total number of steps. Default is len(sequence).
completed (int, optional): Number of steps completed so far. Defaults to 0.
task_id: (TaskID): Task to track. Default is new task.