nxtomomill.utils.progress.Progress

class nxtomomill.utils.progress.Progress(name: str)

Bases: object

Simple interface for defining advancement on a 100 percentage base

__init__(name: str)

Methods

__init__(name)
end_process()	Set advancement to 100 %
increase_advancement([i])	param int i: increase the advancement of n step
reset([max_])	reset the advancement to n and max advancement to max_ :param int max_:
set_advancement(value)	param int value: set advancement to value
set_max_advancement(n)	param int n: number of steps contained by the advancement. When
set_name(name)
start_process()

Attributes

progress

end_process() → None

Set advancement to 100 %

increase_advancement(i: int = 1) → None

Parameters:

i (int) – increase the advancement of n step

reset(max_: Union[None, int] = None) → None

reset the advancement to n and max advancement to max_ :param int max_:

set_advancement(value: int) → None

Parameters:

value (int) – set advancement to value

set_max_advancement(n: int) → None

Parameters:

n (int) – number of steps contained by the advancement. When

advancement reach this value, advancement will be 100 %