b.u.t.TextProgressView(object) : class documentation

Display of progress bar and other information on a tty.

This shows one line of text, including possibly a network indicator, spinner, progress bar, message, etc.

One instance of this is created and held by the UI, and fed updates when a task wants to be painted.

Transports feed data to this through the ui_factory object.

The Progress views can comprise a tree with _parent_task pointers, but this only prints the stack from the nominated current task up to the root.

Method	__init__	Undocumented
Method	clear	Undocumented
Method	show_progress	Called by the task object when it has changed.
Method	show_transport_activity	Called by transports via the ui_factory, as they do IO.
Method	log_transport_activity	Undocumented
Method	_avail_width	Undocumented
Method	_show_line	Undocumented
Method	_render_bar	Undocumented
Method	_format_task	Format task-specific parts of progress bar.
Method	_render_line	Undocumented
Method	_repaint	Undocumented
Method	_format_bytes_by_direction	Undocumented

def __init__(self, term_file):

Undocumented

def _avail_width(self):

Undocumented

def _show_line(self, s):

Undocumented

def clear(self):

Undocumented

def _render_bar(self):

Undocumented

def _format_task(self, task):

Format task-specific parts of progress bar.

Returns (text_part, counter_part) both unicode strings.

def _render_line(self):

Undocumented

def _repaint(self):

Undocumented

def show_progress(self, task):

Called by the task object when it has changed.

Parameters task The top task object; its parents are also included by following links.

def show_transport_activity(self, transport, direction, byte_count):

Called by transports via the ui_factory, as they do IO.

This may update a progress bar, spinner, or similar display. By default it does nothing.

def _format_bytes_by_direction(self):

Undocumented

def log_transport_activity(self, display=False):

Undocumented

API Documentation for Bazaar, generated by pydoctor at 2022-06-16 00:25:16.