ProgressIndicator

digraph InheritanceGraph { graph [bgcolor=transparent, color=lightsteelblue2, fontname=Arial, fontsize=10, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, splines=spline, style="dashed, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=10, height=0, penwidth=2, shape=box, style="filled, rounded", width=0]; edge [color=lightslategrey, penwidth=1]; subgraph "cluster_abjad.system" { graph [label="abjad.system"]; node [color=1]; "abjad.system.AbjadObject.AbjadObject" [URL="../api/abjad/system/AbjadObject.html#abjad.system.AbjadObject.AbjadObject", label="Abjad\nObject", target=_top]; "abjad.system.ContextManager.ContextManager" [URL="../api/abjad/system/ContextManager.html#abjad.system.ContextManager.ContextManager", label="Context\nManager", shape=oval, style=bold, target=_top]; "abjad.system.ProgressIndicator.ProgressIndicator" [URL="../api/abjad/system/ProgressIndicator.html#abjad.system.ProgressIndicator.ProgressIndicator", color=black, fontcolor=white, label="Progress\nIndicator", target=_top]; "abjad.system.AbjadObject.AbjadObject" -> "abjad.system.ContextManager.ContextManager"; "abjad.system.ContextManager.ContextManager" -> "abjad.system.ProgressIndicator.ProgressIndicator"; } subgraph cluster_builtins { graph [label=builtins]; node [color=2]; "builtins.object" [URL="https://docs.python.org/3.6/library/functions.html#object", label=object, target=_top]; } "builtins.object" -> "abjad.system.AbjadObject.AbjadObject"; }

class abjad.system.ProgressIndicator.ProgressIndicator(message='', total=None, verbose=True, is_warning=None)

A context manager for printing progress indications.


Attributes Summary

END
RED
__enter__ Enters progress indicator.
__exit__ Exits progress indicator.
__repr__ Gets interpreter representation of context manager.
advance Advances the progress indicator’s progress count.
is_warning Is true if progress indicator prints in red when its progress goes above zero.
message Gets message of progress indicator.
progress Gets progress.
total Gets total count.
verbose Is true if progress indicator prints status.

Special methods

__enter__()

Enters progress indicator.

__exit__(exc_type, exc_value, traceback)

Exits progress indicator.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to '' or 'storage'. Interprets '' equal to 'storage'.

Returns string.

__repr__()

Gets interpreter representation of context manager.

>>> context_manager = abjad.ProgressIndicator()
>>> context_manager
<ProgressIndicator()>

Returns string.


Methods

advance()

Advances the progress indicator’s progress count. Overwrites the current terminal line with the progress indicators message and new count.


Read-only properties

is_warning

Is true if progress indicator prints in red when its progress goes above zero.

Returns true or false.

message

Gets message of progress indicator.

Returns string.

progress

Gets progress.

Returns integer.

total

Gets total count.

Returns integer or none.

verbose

Is true if progress indicator prints status.

Returns true or false.