python-igraph API reference

List of all classes, functions and methods in python-igraph

igraph.app.shell.ProgressBar

class documentation

class ProgressBar:

View In Hierarchy

A 2-line progress bar, which looks like:

                            Header
    20% [===========----------------------------------]

The progress bar is colored, if the terminal supports color output; and adjusts to the width of the terminal.

Class Variable BAR Undocumented
Class Variable HEADER Undocumented
Method __init__ Undocumented
Instance Variable term Undocumented
Instance Variable width Undocumented
Instance Variable progress_bar Undocumented
Instance Variable header Undocumented
Instance Variable cleared Undocumented
Instance Variable last_percent Undocumented
Instance Variable last_message Undocumented
Method update Updates the progress bar.
Method update_message Updates the message of the progress bar.
Method clear Clears the progress bar (i.e. removes it from the screen)
BAR =

Undocumented

(type: str)
HEADER =

Undocumented

(type: str)
def __init__(self, term):

Undocumented

term =

Undocumented

width =

Undocumented

progress_bar =

Undocumented

header =

Undocumented

cleared =

Undocumented

(type: bool)
last_percent =

Undocumented

(type: int)
last_message =

Undocumented

(type: str)
def update(self, percent=None, message=None):

Updates the progress bar.

Parameterspercentthe percentage to be shown. If None, the previous value will be used.
messagethe message to be shown above the progress bar. If None, the previous message will be used.
def update_message(self, message):

Updates the message of the progress bar.

Parametersmessagethe message to be shown above the progress bar
def clear(self):

Clears the progress bar (i.e. removes it from the screen)

API Documentation for igraph, generated by pydoctor 21.2.2.