quantlab.utils.progress.NullProgressReporter

class quantlab.utils.progress.NullProgressReporter

Bases: ProgressReporter

Reporter that discards every event.

Setting config.kwargs["progress"] = False selects this reporter. It is also the one to use in tests that are not about progress.

Examples

>>> reporter = NullProgressReporter()
>>> reporter.emit(ProgressEvent(kind="run_started", vendor="tiingo",
...                             total=3))
>>> reporter.close()

emit(event)

Discard event.

Parameters:

eventProgressEvent

The event, which is ignored.

Examples

>>> NullProgressReporter().emit(
...     ProgressEvent(kind="cancelled", vendor="tiingo")
... )