progressbar Namespace Reference

Classes
class	Bar
class	ETA
class	FileTransferSpeed
class	Percentage
class	ProgressBar
class	ProgressBarWidget
class	ProgressBarWidgetHFill
class	ReverseBar
class	RotatingMarker
class	Total
class	Value

Functions
def	example1 ()
def	example2 ()
def	example3 ()
def	example4 ()

Variables
string	__author__ = "Nilton Volpato"
string	__author_email__ = "first-name dot last-name @ gmail.com"
string	__date__ = "2006-05-07"
string	__version__ = "2.2"
list	default_widgets = [Percentage(), ' ', Bar()]

Function Documentation

def progressbar.example1

(

)

Definition at line 326 of file progressbar.py.

    def example1():
        widgets = ['Test: ', Percentage(), ' ', Bar(marker=RotatingMarker()),
                   ' ', ETA(), ' ', FileTransferSpeed()]
        pbar = ProgressBar(widgets=widgets, maxval=10000000).start()
        for i in range(1000000):
            # do something
            pbar.update(10*i+1)
        pbar.finish()
        print()

def progressbar.example2

(

)

Definition at line 336 of file progressbar.py.

    def example2():
        class CrazyFileTransferSpeed(FileTransferSpeed):
            "It's bigger between 45 and 80 percent"
            def update(self, pbar):
                if 45 < pbar.percentage() < 80:
                    return 'Bigger Now ' + FileTransferSpeed.update(self,pbar)
                else:
                    return FileTransferSpeed.update(self,pbar)

        widgets = [CrazyFileTransferSpeed(),' <<<', Bar(), '>>> ', Percentage(),' ', ETA()]
        pbar = ProgressBar(widgets=widgets, maxval=10000000)
        # maybe do something
        pbar.start()
        for i in range(2000000):
            # do something
            pbar.update(5*i+1)
        pbar.finish()
        print()

def progressbar.example3

(

)

Definition at line 355 of file progressbar.py.

    def example3():
        widgets = [Bar('>'), ' ', ETA(), ' ', ReverseBar('<')]
        pbar = ProgressBar(widgets=widgets, maxval=10000000).start()
        for i in range(1000000):
            # do something
            pbar.update(10*i+1)
        pbar.finish()
        print()

def progressbar.example4

(

)

Definition at line 364 of file progressbar.py.

    def example4():
        widgets = ['Test: ', Percentage(), ' ',
                   Bar(marker='0',left='[',right=']'),
                   ' ', ETA(), ' ', FileTransferSpeed()]
        pbar = ProgressBar(widgets=widgets, maxval=500)
        pbar.start()
        for i in range(100,500+1,50):
            time.sleep(0.2)
            pbar.update(i)
        pbar.finish()
        print()

Variable Documentation

string progressbar.__author__ = "Nilton Volpato"

private

Definition at line 45 of file progressbar.py.

string progressbar.__author_email__ = "first-name dot last-name @ gmail.com"

private

Definition at line 46 of file progressbar.py.

string progressbar.__date__ = "2006-05-07"

private

Definition at line 47 of file progressbar.py.

string progressbar.__version__ = "2.2"

private

Definition at line 48 of file progressbar.py.

list progressbar.default_widgets = [Percentage(), ' ', Bar()]

Definition at line 193 of file progressbar.py.