{ } Raw JSON

bundles / papyri latest / papyri / _progress

module

papyri._progress

source: /papyri/_progress.py :0

Members

Summary

Progress-bar helpers.

Extended Summary

Two shapes for two consumers:

  • progress_class(dummy=...) returns a Progress class (rich's, or a no-op DummyProgress). Use when you want to drive add_task / advance / update yourself, e.g.

    with progress_class(dummy=cfg.dummy_progress)(...) as p:
        task = p.add_task("...", total=N)
        ...
  • iter_with_progress(iterable, dummy=...) is a generator that yields (progress, item) pairs. Use when the loop body just needs the current progress to update its own description.

Additional content

Progress-bar helpers.

Two shapes for two consumers:

  • progress_class(dummy=...) returns a Progress class (rich's, or a no-op DummyProgress). Use when you want to drive add_task / advance / update yourself, e.g.

    with progress_class(dummy=cfg.dummy_progress)(...) as p:
        task = p.add_task("...", total=N)
        ...
  • iter_with_progress(iterable, dummy=...) is a generator that yields (progress, item) pairs. Use when the loop body just needs the current progress to update its own description.

Aliases

  • papyri._progress