ORIONIS API REFERENCE

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

Manage console progress tasks and their displayed state.

Method __init__ Initialize a new progress bar instance.
Method __updateBar Update the visual representation of the progress bar in the console.
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.
Instance Variable _flush Flush obtained from _stdout.flush.
Instance Variable _write Callable used to append bytes to the current multipart part.
Instance Variable bar_width Width of the progress bar in characters. Default is 50.
Instance Variable progress Initialize progress to zero.
Instance Variable total Maximum value representing 100% progress. Default is 100.
def __init__(self, total: int = 100, width: int = 50): (source)

Initialize a new progress bar instance.

Parameters
total:int, optionalMaximum value representing 100% progress. Default is 100.
width:int, optionalWidth of the progress bar in characters. Default is 50.
Returns
NoneThis method does not return a value.
def __updateBar(self): (source)

Update the visual representation of the progress bar in the console.

Calculates the percentage of completion and redraws the progress bar in place, overwriting the previous output.

Returns
NoneThis method does not return a value.
def advance(self, increment: int = 1): (source)

Advance the progress bar by a specified increment.

Notes

Progress will not exceed the total value.

Parameters
increment:int, optionalValue by which to increase the progress. Default is 1.
Returns
NoneThis method does not return a value.
def finish(self): (source)

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
NoneThis method does not return a value.
def start(self): (source)

Reset and display the progress bar at the starting state.

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

Returns
NoneThis method does not return a value.

Flush obtained from _stdout.flush.

Callable used to append bytes to the current multipart part.

bar_width = (source)

Width of the progress bar in characters. Default is 50.

progress = (source)

Initialize progress to zero.

Maximum value representing 100% progress. Default is 100.