Part of bzrlib.progress View In Hierarchy
Most code that needs to indicate progress should update one of these, and it will in turn update the display, if one is present.
Code updating the task may also set fields as hints about how to display it: show_pct, show_spinner, show_eta, show_count, show_bar. UIs will not necessarily respect all these fields.
Instance Variables | update_latency | The interval (in seconds) at which the PB should be updated. Setting this to zero suggests every update should be shown synchronously. |
show_transport_activity | If true (default), transport activity will be shown when this task is drawn. Disable it if you're sure that only irrelevant or uninteresting transport activity can occur during this task. |
Method | __init__ | Construct a new progress task. |
Method | __repr__ | Undocumented |
Method | update | Undocumented |
Method | tick | Undocumented |
Method | finished | Undocumented |
Method | make_sub_task | Undocumented |
Method | clear | Undocumented |
Method | _overall_completion_fraction | Return fractional completion of this task and its parents |
Normally you should not call this directly but rather through
ui_factory.nested_progress_bar
.
Parameters | parent_task | Enclosing ProgressTask or None. |
progress_view | ProgressView to display this ProgressTask. | |
ui_factory | The UI factory that will display updates; deprecated in favor of passing progress_view directly. |