MolecularDiffusion.optional

Helpers for optional dependency error messages.

Exceptions

OptionalDependencyError

Raised when an optional dependency group is required but unavailable.

Functions

install_hint(→ str)

Build a concise installation hint for an optional dependency group.

optional_import_error(→ OptionalDependencyError)

Convert an import error into an actionable optional-extra message.

require_modules(→ None)

Import-check modules and raise a grouped optional dependency error.

Module Contents

exception MolecularDiffusion.optional.OptionalDependencyError

Bases: ImportError

Raised when an optional dependency group is required but unavailable.

Initialize self. See help(type(self)) for accurate signature.

MolecularDiffusion.optional.install_hint(extra: str, missing: collections.abc.Iterable[str] | None = None) str

Build a concise installation hint for an optional dependency group.

MolecularDiffusion.optional.optional_import_error(extra: str, error: ImportError) OptionalDependencyError

Convert an import error into an actionable optional-extra message.

MolecularDiffusion.optional.require_modules(extra: str, modules: collections.abc.Iterable[str]) None

Import-check modules and raise a grouped optional dependency error.