ClickProgressHandler

class lsst.daf.butler.cli.progress.ClickProgressHandler(**kwargs: Any)

Bases: ProgressHandler

A ProgressHandler implementation that delegates to click.progressbar.

Parameters:

**kwargs

Additional keyword arguments to pass to click.progressbar. May not include iterable, length, or label, as these are passed directly from get_progress_bar arguments.

Methods Summary

callback(ctx, params, value)	A click callback that installs this handler as the global handler for progress bars.
get_progress_bar(iterable, desc, total, level)	Create a new progress bar.
option(cmd)	A click command decorator that adds a --progress option that installs a default-constructed instance of this progress handler.

Methods Documentation

classmethod callback(ctx: Context, params: Parameter, value: Any) → None

A click callback that installs this handler as the global handler for progress bars.

Should usually be called only by the option method.

get_progress_bar(iterable: Iterable[_T] | None, desc: str | None, total: int | None, level: int) → ContextManager[ProgressBar[_T]]

Create a new progress bar.

Parameters:

iterableIterable or None

An arbitrary Python iterable that will be iterated over when the returned ProgressBar is. If None, whether the progress bar is iterable is handler-defined, but it may be updated manually.

desc: `str`

A user-friendly description for this progress bar; usually appears next to it

totalint or None

The total number of steps in this progress bar. If None`, len(iterable) should be used. If that does not work, whether the progress bar works at all is handler-defined.

levelint

A logging level value (defaults to logging.INFO) associated with the process reporting progress. Handlers are not responsible for disabling progress reporting on levels, but may utilize level information to annotate them differently.

classmethod option(cmd: Any) → Any

A click command decorator that adds a --progress option that installs a default-constructed instance of this progress handler.