reporters

Holds functions for output rendering in conda

Functions

_get_render_func(→ Callable)	Retrieves the render function to use
render(→ None)	Used to render output in conda
get_progress_bar(→ conda.plugins.types.ProgressBarBase)	Retrieve the progress bar for the currently configured reporter backend
get_progress_bar_context_manager(...)	Retrieve progress bar context manager to use with registered reporter
get_spinner(→ conda.plugins.types.SpinnerBase)	Retrieve spinner to use with registered reporter
confirm_yn(→ bool)	Display a "yes/no" confirmation input

Attributes

logger

logger

_get_render_func(style: str | None = None) → Callable

Retrieves the render function to use

render(data, style: str | None = None, **kwargs) → None

Used to render output in conda

The output will either be rendered as "json" or normal "console" output to stdout. This function allows us to configure different reporter backends for these two types of output.

get_progress_bar(description: str, **kwargs) → conda.plugins.types.ProgressBarBase

Retrieve the progress bar for the currently configured reporter backend

get_progress_bar_context_manager() → contextlib.AbstractContextManager

Retrieve progress bar context manager to use with registered reporter

get_spinner(message: str, fail_message: str = 'failed\n') → conda.plugins.types.SpinnerBase

Retrieve spinner to use with registered reporter

confirm_yn(message: str = 'Proceed', default='yes', dry_run=None) → bool

Display a "yes/no" confirmation input