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.

The progress bar looks roughly like this in the console:

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

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

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

Undocumented

def clear(self):

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

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

Updates the progress bar.

Parameters
percentthe 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.

Parameters
messagethe message to be shown above the progress bar
BAR: str =

Undocumented

Value
'%3d%% ${GREEN}[${BOLD}%s%s${NORMAL}${GREEN}]${NORMAL}'
HEADER: str =

Undocumented

Value
'''${BOLD}${CYAN}%s${NORMAL}
'''
cleared: bool =

Undocumented

header =

Undocumented

last_message: str =

Undocumented

last_percent: int =

Undocumented

progress_bar =

Undocumented

term =

Undocumented

width =

Undocumented