vertebrae.utils.imports

Helpers for optional dependency imports.

Functions

optional_import(module_name, install_hint)

Import an optional dependency with a user-friendly error message.

Module Contents

vertebrae.utils.imports.optional_import(module_name, install_hint)[source]

Import an optional dependency with a user-friendly error message.

Parameters:

  • module_name (str) – Module to import.

  • install_hint (str) – Installation instructions included in the error.

Returns:

Imported module.

Raises:

ImportError – If the optional module is unavailable.

Return type:

Any