Progress¶

class caris.Progress¶

The progress object.

increment((Progress)self) → bool :¶

Increments the progress by one.

set_max((Progress)self, (int)max) → None :¶

Set the maximum number of items on which to report progress.

Parameters

max (int) – The maximum number of items on which to report progress

set_text((Progress)arg1, (str)arg2) → None :¶

Set the text to display for the progress information.

Parameters

text (str) – The text with which to report progress

update((Progress)self, (int)value) → bool :¶

Updates the progress to the specified amount.

Parameters

value (int) – The value to which to update the progress