pycsamt.api.view.progress

Progress helpers used by public pyCSAMT APIs.

Functions

iter_progress(iterable, *[, enabled, desc, ...])	Yield items, optionally wrapped by tqdm.
progress_enabled([value])	Return whether progress should be displayed.

Classes

ProgressConfig([enabled, desc, leave, unit, ...])

Configuration for terminal progress display.

class pycsamt.api.view.progress.ProgressConfig(enabled='auto', desc=None, leave=False, unit='it', total=None)

Bases: object

Configuration for terminal progress display.

Parameters:

• enabled (bool | str)

• desc (str | None)

• leave (bool)

• unit (str)

• total (int | None)

enabled: bool | str = 'auto'

desc: str | None = None

leave: bool = False

unit: str = 'it'

total: int | None = None

pycsamt.api.view.progress.iter_progress(iterable, *, enabled='auto', desc=None, leave=False, unit='it', total=None)

Yield items, optionally wrapped by tqdm.

Parameters:

• iterable (Iterable[T])

• enabled (bool | str)

• desc (str | None)

• leave (bool)

• unit (str)

• total (int | None)

Return type:

Iterator[T]

pycsamt.api.view.progress.progress_enabled(value='auto')

Return whether progress should be displayed.

Parameters:

value (bool | str)

Return type:

bool