ProgressBar

class lsst.daf.butler.progress.ProgressBar(*args, **kwargs)

Bases: Iterable[_T], Protocol

A structural interface for progress bars that wrap iterables.

An object conforming to this interface can be obtained from the Progress.bar method.

Notes

This interface is intentionally defined as the intersection of the progress bar objects returned by the click and tqdm packages, allowing those to directly satisfy code that uses this interface.

Methods Summary

update([n])

Increment the progress bar by the given amount.

Methods Documentation

update(n: int = 1) → None

Increment the progress bar by the given amount.

Parameters:

nint, optional

Increment the progress bar by this many steps (defaults to 1). Note that this is a relative increment, not an absolute progress value.