utils.depends_on_optional()

Require an optional dependency when the decorated function is called.

Usage

Source

utils.depends_on_optional(
    module_name,
    install_hint=None,
)

Parameters

module_name: str

Module to require.

install_hint: str or None = None

Installation instruction for the error message.

Returns

Callable[[Callable[P, T]], Callable[P, T]]

Dependency-checking decorator.