diart.progress#

Module Contents#

Classes#

ProgressBar

Helper class that provides a standard way to create an ABC using

RichProgressBar

Helper class that provides a standard way to create an ABC using

TQDMProgressBar

Helper class that provides a standard way to create an ABC using
class diart.progress.ProgressBar#

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract property default_description: Text#
Return type:

Text

abstract property initial_description: Text | None#
Return type:

Optional[Text]

abstract create(total, description=None, unit='it', **kwargs)#
Parameters:

  • total (int) –

  • description (Optional[Text]) –

  • unit (Text) –

abstract start()#
abstract update(n=1)#
Parameters:

n (int) –

abstract write(text)#
Parameters:

text (Text) –

abstract stop()#
abstract close()#
resolve_description(new_description=None)#
Parameters:

new_description (Optional[Text]) –

Return type:

Text

class diart.progress.RichProgressBar(description=None, color='green', leave=True, do_close=True)#

Bases: ProgressBar

Helper class that provides a standard way to create an ABC using inheritance.

Parameters:

  • description (Optional[Text]) –

  • color (Text) –

  • leave (bool) –

  • do_close (bool) –

property default_description: Text#
Return type:

Text

property initial_description: Text | None#
Return type:

Optional[Text]

create(total, description=None, unit='it', **kwargs)#
Parameters:

  • total (int) –

  • description (Optional[Text]) –

  • unit (Text) –

start()#
update(n=1)#
Parameters:

n (int) –

write(text)#
Parameters:

text (Text) –

stop()#
close()#
class diart.progress.TQDMProgressBar(description=None, leave=True, position=None, do_close=True)#

Bases: ProgressBar

Helper class that provides a standard way to create an ABC using inheritance.

Parameters:

  • description (Optional[Text]) –

  • leave (bool) –

  • position (Optional[int]) –

  • do_close (bool) –

property default_description: Text#
Return type:

Text

property initial_description: Text | None#
Return type:

Optional[Text]

create(total, description=None, unit='it', **kwargs)#
Parameters:

  • total (int) –

  • description (Optional[Text]) –

  • unit (Optional[Text]) –

start()#
update(n=1)#
Parameters:

n (int) –

write(text)#
Parameters:

text (Text) –

stop()#
close()#