API docs for “bzrlib.progress”

Progress indicators.

The usual way to use this is via bzrlib.ui.ui_factory.nested_progress_bar which will maintain a ProgressBarStack for you.

For direct use, the factory ProgressBar will return an auto-detected progress bar that should match your terminal type. You can manually create a ProgressBarStack too if you need multiple levels of cooperating progress bars. Note that bzrlib's internal functions use the ui module, so if you are using bzrlib it really is best to use bzrlib.ui.ui_factory.

Line #	Kind	Name	Docs
68	Function	ProgressBar	Abstract factory
91	Class	ProgressBarStack	A stack of progress bars.
204	Class	DummyProgress	Progress-bar standin that does nothing.
232	Class	DotsProgressBar	Undocumented
263	Class	TTYProgressBar	Progress bar display object.
443	Class	ChildProgress	A progress indicator that pushes its data to the parent
487	Class	InstrumentedProgress	TTYProgress variant that tracks outcomes
504	Function	str_tdelta	Undocumented
513	Function	get_eta	Undocumented
545	Class	ProgressPhase	Update progress object with the current phase
48	Function	_supports_progress	Detect if we can use pretty progress bars on the output stream f.
154	Class	_BaseProgressBar	No class docstring; 2/4 methods documented

def _supports_progress(f):

Detect if we can use pretty progress bars on the output stream f.

If this returns true we expect that a human may be looking at that output, and that we can repaint a line to update it.

Module b.progress