importutils

importutils

Import related utilities and helper functions.

oslo_utils.importutils.import_any(module, *modules)

Try to import a module from a list of modules.

Parameters

modules – A list of modules to try and import

Returns

The first module found that can be imported

Raises

ImportError – If no modules can be imported from list

New in version 3.8.

oslo_utils.importutils.import_class(import_str)

Returns a class from a string including module and class.

New in version 0.3.

oslo_utils.importutils.import_module(import_str)

Import a module.

New in version 0.3.

oslo_utils.importutils.import_object(import_str, *args, **kwargs)

Import a class and return an instance of it.

New in version 0.3.

oslo_utils.importutils.import_object_ns(name_space, import_str, *args, **kwargs)

Tries to import object from default namespace.

Imports a class and return an instance of it, first by trying to find the class in a default namespace, then failing back to a full path if not found in the default namespace.

New in version 0.3.

Changed in version 2.6: Don’t capture ImportError when instanciating the object, only when importing the object class.

oslo_utils.importutils.import_versioned_module(module, version, submodule=None)

Import a versioned module in format {module}.v{version][.{submodule}].

Parameters
  • module – the module name.

  • version – the version number.

  • submodule – the submodule name.

Raises

ValueError – For any invalid input.

New in version 0.3.

Changed in version 3.17: Added module parameter.

oslo_utils.importutils.try_import(import_str, default=None)

Try to import a module and if it fails return default.

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.