ProgressIndicator

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

A context manager for printing progress indications.

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.ContextManager.ContextManager" [color=1, group=0, label=ContextManager, shape=oval, style=bold]; "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.abctools.ContextManager.ContextManager"; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_systemtools { graph [label=systemtools]; "abjad.tools.systemtools.ProgressIndicator.ProgressIndicator" [color=black, fontcolor=white, group=2, label=<<B>ProgressIndicator</B>>, shape=box, style="filled, rounded"]; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.ContextManager.ContextManager" -> "abjad.tools.systemtools.ProgressIndicator.ProgressIndicator"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

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.
__enter__() Enters progress indicator.
__eq__(expr) Is true when ID of expr equals ID of Abjad object.
__exit__(exc_type, exc_value, traceback) Exits progress indicator.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes Abjad object.
__ne__(expr) Is true when Abjad object does not equal expr.
__repr__() Gets interpreter representation of context manager.

Read-only properties

ProgressIndicator.is_warning

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

Returns true or false.

ProgressIndicator.message

Gets message of progress indicator.

Returns string.

ProgressIndicator.progress

Gets progress.

Returns integer.

ProgressIndicator.total

Gets total count.

Returns integer or none.

ProgressIndicator.verbose

Is true if progress indicator prints status. Otherwise false.

Returns true or false.

Methods

ProgressIndicator.advance()

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

Special methods

ProgressIndicator.__enter__()

Enters progress indicator.

(AbjadObject).__eq__(expr)

Is true when ID of expr equals ID of Abjad object. Otherwise false.

Returns true or false.

ProgressIndicator.__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.

(AbjadObject).__hash__()

Hashes Abjad object.

Required to be explicitly redefined on Python 3 if __eq__ changes.

Returns integer.

(AbjadObject).__ne__(expr)

Is true when Abjad object does not equal expr. Otherwise false.

Returns true or false.

ProgressIndicator.__repr__()

Gets interpreter representation of context manager.

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

Returns string.