rdtools.utils#

Utils used in the RDTools package.

class rdtools.utils.FakeModule(module_name: str, package_name: str | None = None)#

Bases: object

Fake module that raises an error when used.

This is to allow users to import modules that are not installed, but run into an error when they try to use them. This is useful for optional dependencies.

Parameters:

  • module_name (str) – The name of the module.

  • package_name (Optional[str], optional) – The name of the package. Defaults to None.

rdtools.utils.get_fake_module(module_name: str, package_name: str | None = None) → FakeModule#

Returns a fake module that raises an error when used.

Parameters:

  • module_name (str) – The name of the module.

  • package_name (Optional[str], optional) – The name of the package. Defaults to None.

Returns:

FakeModule – The fake module.