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 No
(
self,
task_id: TaskID,
*,
start: bool = True,
total: Optional[float] = None,
completed: int = 0,
visible: Optional[bool] = None,
description: Optional[str] = None,
**fields: Any,
)
| 1476 | self.refresh() |
| 1477 | |
| 1478 | def reset( |
| 1479 | self, |
| 1480 | task_id: TaskID, |
| 1481 | *, |
| 1482 | start: bool = True, |
| 1483 | total: Optional[float] = None, |
| 1484 | completed: int = 0, |
| 1485 | visible: Optional[bool] = None, |
| 1486 | description: Optional[str] = None, |
| 1487 | **fields: Any, |
| 1488 | ) -> None: |
| 1489 | """Reset a task so completed is 0 and the clock is reset. |
| 1490 | |
| 1491 | Args: |
| 1492 | task_id (TaskID): ID of task. |
| 1493 | start (bool, optional): Start the task after reset. Defaults to True. |
| 1494 | total (float, optional): New total steps in task, or None to use current total. Defaults to None. |
| 1495 | completed (int, optional): Number of steps completed. Defaults to 0. |
| 1496 | visible (bool, optional): Set visible flag if not None. |
| 1497 | description (str, optional): Change task description if not None. Defaults to None. |
| 1498 | **fields (str): Additional data fields required for rendering. |
| 1499 | """ |
| 1500 | current_time = self.get_time() |
| 1501 | with self._lock: |
| 1502 | task = self._tasks[task_id] |
| 1503 | task._reset() |
| 1504 | task.start_time = current_time if start else None |
| 1505 | if total is not None: |
| 1506 | task.total = total |
| 1507 | task.completed = completed |
| 1508 | if visible is not None: |
| 1509 | task.visible = visible |
| 1510 | if fields: |
| 1511 | task.fields = fields |
| 1512 | if description is not None: |
| 1513 | task.description = description |
| 1514 | task.finished_time = None |
| 1515 | self.refresh() |
| 1516 | |
| 1517 | def advance(self, task_id: TaskID, advance: float = 1) -> None: |
| 1518 | """Advance task by a number of steps. |