locan.dependencies.needs_package#

locan.dependencies.needs_package(package, import_names=None, has_dependency=None)[source]#

Function that returns a decorator to check for optional dependency.

Parameters:

package (str) – Package or dependency name that needs to be imported.
import_names (Optional[dict[str, str]]) – Mapping of package names onto import names.
has_dependency (Optional[dict[str, bool]]) – Dictionary with bool indicator if package (import name) is available.

Returns:

A decorator that raises ImportError if package is not available.

Return type:

callable