locan.dependencies.needs_package

locan.dependencies.needs_package(package, import_names=None, has_dependency=None)

Function that returns a decorator to check for optional dependency.

Parameters:

• package (str) – Package or dependency name that needs to be imported.

• import_names (dict[str, str] | None) – Mapping of package names onto import names.

• has_dependency (dict[str, bool] | None) – Dictionary with bool indicator if package (import name) is available.

Returns:

A decorator that raises ImportError if package is not available.

Return type:

callable