orionis.console.dynamic.contracts.progress

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

class IProgressBar(ABC): (source)

Undocumented

Method	`advance`	Advance the progress bar by a specified increment.
Method	`finish`	Complete the progress bar and move to a new line.
Method	`start`	Reset and display the progress bar at the starting state.

def advance(self, increment: int = 1): (source) ¶

overridden in orionis.console.ProgressBar

Advance the progress bar by a specified increment.

Notes

Progress will not exceed the total value.

Parameters
increment:`int, optional`	Value by which to increase the progress. Default is 1.

Returns
`None`	This method does not return a value.

overridden in orionis.console.ProgressBar

Complete the progress bar and move to a new line.

Sets progress to the maximum value, updates the bar, and moves the cursor to a new line for cleaner output.

Returns
`None`	This method does not return a value.

overridden in orionis.console.ProgressBar

Reset and display the progress bar at the starting state.

Sets the progress to zero and renders the initial progress bar.

Returns
`None`	This method does not return a value.