A simple ASCII progress bar with a ticker thread. More...

Inheritance diagram for ProgressBar:

Public Member Functions
	__init__ (self, max=100, value=0, min=0, width=30, forechar="-", backchar=" ", foreword="", afterword="", interval=1, pulse=False, aftertemplate=" {afterword}", **afterargs)
	Creates a new progress bar, without drawing it yet.

	draw (self, flush=False)
	Prints the progress bar, from the beginning of the current line.

	run (self)

	stop (self)

	update (self, value=None, draw=True, flush=False)
	Updates the progress bar value, and refreshes by default; returns self.

Public Attributes
	afterargs

	aftertemplate

	afterword

	backchar

	bar

	daemon

	forechar

	foreword

	interval

	is_running

	max

	min

	pause

	percent

	printbar

	progresschar

	pulse

	pulse_pos

	value

	width

Detailed Description

A simple ASCII progress bar with a ticker thread.

Drawn like '[———/ 36% ] Progressing text..'. or for pulse mode '[ —- ] Progressing text..'.

Definition at line 546 of file common.py.

Constructor & Destructor Documentation

◆ init()

__init__	(		self,
			max = `100`,
			value = `0`,
			min = `0`,
			width = `30`,
			forechar = `"-"`,
			backchar = `" "`,
			foreword = `""`,
			afterword = `""`,
			interval = `1`,
			pulse = `False`,
			aftertemplate = `" {afterword}"`,
		**	afterargs
	)

Creates a new progress bar, without drawing it yet.

Parameters

max	progress bar maximum value, 100%
value	progress bar initial value
min	progress bar minimum value, for 0%
width	progress bar width (in characters)
forechar	character used for filling the progress bar
backchar	character used for filling the background
foreword	text in front of progress bar
afterword	text after progress bar
interval	ticker thread interval, in seconds
pulse	ignore value-min-max, use constant pulse instead
aftertemplate	afterword format() template, populated with vars(self) and afterargs
afterargs	additional keywords for aftertemplate formatting

Definition at line 564 of file common.py.

Member Function Documentation

◆ draw()

draw	(	self,
		flush = `False`
	)

Prints the progress bar, from the beginning of the current line.

Parameters

flush add linefeed to end, forcing a new line for any next print

Definition at line 646 of file common.py.

◆ run()

run ( self )

Definition at line 654 of file common.py.

◆ stop()

stop ( self )

Definition at line 661 of file common.py.

◆ update()

update	(	self,
		value = `None`,
		draw = `True`,
		flush = `False`
	)

Updates the progress bar value, and refreshes by default; returns self.

Definition at line 594 of file common.py.

Member Data Documentation

◆ afterargs

afterargs

Definition at line 579 of file common.py.

◆ aftertemplate

aftertemplate

Definition at line 578 of file common.py.

◆ afterword

afterword

Definition at line 575 of file common.py.

◆ backchar

backchar

Definition at line 573 of file common.py.

◆ bar

bar

Definition at line 585 of file common.py.

◆ daemon

daemon

Definition at line 580 of file common.py.

◆ forechar

forechar

Definition at line 572 of file common.py.

◆ foreword

foreword

Definition at line 574 of file common.py.

◆ interval

interval

Definition at line 576 of file common.py.

◆ is_running

is_running

Definition at line 591 of file common.py.

◆ max

max

Definition at line 568 of file common.py.

◆ min

min

Definition at line 570 of file common.py.

◆ pause

pause

Definition at line 583 of file common.py.

◆ percent

percent

Definition at line 581 of file common.py.

◆ printbar

printbar

Definition at line 589 of file common.py.

◆ progresschar

progresschar

Definition at line 590 of file common.py.

◆ pulse

pulse

Definition at line 577 of file common.py.

◆ pulse_pos

pulse_pos

Definition at line 584 of file common.py.

◆ value

value

Definition at line 569 of file common.py.

◆ width

width

Definition at line 571 of file common.py.

The documentation for this class was generated from the following file:

grepros/common.py

Public Member Functions

Public Attributes