Method: rich.progress.Progress.reset
Calls: 1, Exceptions: 0, Paths: 1Back
Path 1: 1 calls (1.0)
0 (1)
True (1)
200 (1)
20 (1)
False (1)
'bar' (1)
{'example': 'egg'} (1)
1def reset(
2 self,
3 task_id: TaskID,
4 *,
5 start: bool = True,
6 total: Optional[float] = None,
7 completed: int = 0,
8 visible: Optional[bool] = None,
9 description: Optional[str] = None,
10 **fields: Any,
11 ) -> None:
12 """Reset a task so completed is 0 and the clock is reset.
13
14 Args:
15 task_id (TaskID): ID of task.
16 start (bool, optional): Start the task after reset. Defaults to True.
17 total (float, optional): New total steps in task, or None to use current total. Defaults to None.
18 completed (int, optional): Number of steps completed. Defaults to 0.
19 visible (bool, optional): Enable display of the task. Defaults to True.
20 description (str, optional): Change task description if not None. Defaults to None.
21 **fields (str): Additional data fields required for rendering.
22 """
23 current_time = self.get_time()
24 with self._lock:
25 task = self._tasks[task_id]
26 task._reset()
27 task.start_time = current_time if start else None
28 if total is not None:
29 task.total = total
30 task.completed = completed
31 if visible is not None:
32 task.visible = visible
33 if fields:
34 task.fields = fields
35 if description is not None:
36 task.description = description
37 task.finished_time = None
38 self.refresh()