class documentation
Wrapper describing a step of an operation progress tracker.
This class wraps a ProgressTracker.Step instance and exposes convenient accessors that normalize missing fields as None.
When a step includes work estimates (work_done), the
work_fraction helper converts them into a usable fraction.
The method returns None when the fraction cannot be computed.
Example
Inspecting steps and progress:
tracker = operation.progress_tracker()
if tracker:
for step in tracker.steps():
fraction = step.work_fraction()
if fraction is None:
print(step.description())
else:
print(f"{step.description()}: {fraction:.0%}")
| Method | __init__ |
Undocumented |
| Method | __repr__ |
Undocumented |
| Method | description |
Return a human-readable description of the step. |
| Method | finished |
Return the step finished timestamp or None if unfinished. |
| Method | started |
Return the step start timestamp or None if unknown. |
| Method | work |
Return work progress details for the step when available. |
| Method | work |
Return the completed work fraction or None when unavailable. |
| Instance Variable | _step |
Undocumented |