pbar module¶

Utilities for progress bars.

with_progress_hidden function¶

with_progress_hidden(
    *args
)

Decorator to run a function with ProgressHidden.

with_progress_shown function¶

with_progress_shown(
    *args
)

Decorator to run a function with ProgressShown.

ProgressBar class¶

ProgressBar(
    iterable=None,
    bar_id=None,
    bar_type=None,
    force_open_bar=None,
    reuse=None,
    disable=None,
    show_progress=None,
    show_progress_desc=None,
    desc_kwargs=None,
    registry=<vectorbtpro.registries.pbar_registry.PBarRegistry object>,
    silence_warnings=None,
    **kwargs
)

Context manager to manage a progress bar.

Supported types:

• 'tqdm_auto'
• 'tqdm_notebook'
• 'tqdm_gui'
• 'tqdm'

For defaults, see pbar.

active property¶

Whether the bar is active.

after_update method¶

ProgressBar.after_update()

Do something after an update.

bar property¶

Bar.

bar_id property¶

Bar id.

bar_type property¶

Bar type.

before_update method¶

ProgressBar.before_update()

Do something before an update.

close method¶

ProgressBar.close(
    reuse=None,
    close_children=True
)

Close the bar.

close_time property¶

Time the bar was closed.

desc_kwargs property¶

Keyword arguments passed to ProgressBar.set_description().

disabled property¶

Whether the bar is disabled.

displayed property¶

Whether the bar is displayed.

enter method¶

ProgressBar.enter(
    **kwargs
)

Enter the bar.

exit method¶

ProgressBar.exit(
    **kwargs
)

Exit the bar.

force_open_bar property¶

Whether to force-open a bar even if progress is not shown.

iter method¶

ProgressBar.iter()

Get iterator over ProgressBar.iterable.

iterable property¶

Iterable.

kwargs property¶

Keyword arguments passed to initialize the bar.

open method¶

ProgressBar.open(
    reuse=None
)

Open the bar.

open_time property¶

Time the bar was opened.

pending property¶

Whether the bar is pending.

prepare_desc method¶

ProgressBar.prepare_desc(
    desc
)

Prepare description.

refresh method¶

ProgressBar.refresh()

Refresh the bar.

refresh_time property¶

Time the bar was refreshed.

registry property¶

Registry of type PBarRegistry.

If None, registry is disabled.

remove_bar method¶

ProgressBar.remove_bar()

Remove the bar.

reset method¶

ProgressBar.reset()

Reset the bar.

reuse property¶

Whether the bar can be reused.

set_bar method¶

ProgressBar.set_bar(
    bar=None
)

Set the bar.

set_description method¶

ProgressBar.set_description(
    desc,
    as_postfix=None,
    refresh=None
)

Set description.

Uses the method ProgressBar.set_prefix() if as_postfix=True in ProgressBar.desc_kwargs. Otherwise, uses the method ProgressBar.set_postfix().

Uses ProgressBar.desc_kwargs as keyword arguments.

set_description_str method¶

ProgressBar.set_description_str(
    desc,
    as_postfix=None,
    refresh=None
)

Set description without preparation.

Uses the method ProgressBar.set_prefix_str() if as_postfix=True in ProgressBar.desc_kwargs. Otherwise, uses the method ProgressBar.set_postfix_str().

Uses ProgressBar.desc_kwargs as keyword arguments.

set_postfix method¶

ProgressBar.set_postfix(
    desc,
    refresh=None
)

Set postfix.

Prepares it with ProgressBar.prepare_desc().

set_postfix_str method¶

ProgressBar.set_postfix_str(
    desc,
    refresh=None
)

Set postfix without preparation.

set_prefix method¶

ProgressBar.set_prefix(
    desc,
    refresh=None
)

Set prefix.

Prepares it with ProgressBar.prepare_desc().

set_prefix_str method¶

ProgressBar.set_prefix_str(
    desc,
    refresh=None
)

Set prefix without preparation.

should_display property¶

Whether the bar should be displayed.

show_progress property¶

Whether to show the bar.

show_progress_desc property¶

Whether show the bar description.

silence_warnings property¶

Whether to silence warnings.

update method¶

ProgressBar.update(
    n=1
)

Update with one or more iterations.

update_time property¶

Time the bar was updated.

update_to method¶

ProgressBar.update_to(
    n
)

Update to a specific number.

ProgressHidden class¶

ProgressHidden(
    disable_registry=True,
    disable_machinery=True
)

Context manager to hide progress.

disable_machinery property¶

Whether to disable machinery.

disable_registry property¶

Whether to disable registry.

init_settings property¶

Initial settings.

ProgressShown class¶

ProgressShown(
    enable_registry=True,
    enable_machinery=True
)

Context manager to show progress.

enable_machinery property¶

Whether to enable machinery.

enable_registry property¶

Whether to enable registry.

init_settings property¶

Initial settings.