Skip to content

pbar_registry module

Global registry for progress bars.

pbar_reg PBarRegistry

Default registry of type PBarRegistry.

PBarRegistry class

PBarRegistry()

Class for registering ProgressBar instances.

clear_instances method

PBarRegistry.clear_instances()

Clear instances.

deregister_instance method

PBarRegistry.deregister_instance(
    instance
)

Deregister an instance.

generate_bar_id class method

PBarRegistry.generate_bar_id()

Generate a unique bar id.

get_child_instances method

PBarRegistry.get_child_instances(
    instance
)

Get child (active or pending) instances of an instance.

get_first_pending_instance method

PBarRegistry.get_first_pending_instance()

Get the first pending instance.

get_last_active_instance method

PBarRegistry.get_last_active_instance()

Get the last active instance.

get_parent_instance method

PBarRegistry.get_parent_instance(
    instance
)

Get the (active) parent instance of an instance.

get_parent_instances method

PBarRegistry.get_parent_instances(
    instance
)

Get the (active) parent instances of an instance.

get_pending_instance method

PBarRegistry.get_pending_instance(
    instance
)

Get the pending instance.

If the bar id is not None, searches for the same id in the dictionary.

has_conflict method

PBarRegistry.has_conflict(
    instance
)

Return whether there is an (active) instance with the same bar id.

instances property

Dict of registered instances by their bar id.

register_instance method

PBarRegistry.register_instance(
    instance
)

Register an instance.