Functions
def	doImport (importable)

Function Documentation

◆ doImport()

def lsst.utils.doImport.doImport ( importable )

Import a python object given an importable string and return it.

Parameters
----------
importable : `str`
    String containing dot-separated path of a Python class, module,
    or member function.

Returns
-------
type : `type`
    Type object. Either a module or class or a function.

Raises
------
TypeError
    ``importable`` is not a `str`.
ModuleNotFoundError
    No module in the supplied import string could be found.
ImportError
    ``importable`` is found but can not be imported or the requested
    item could not be retrieved from the imported module.

Definition at line 28 of file doImport.py.

 def doImport(importable):
     """Import a python object given an importable string and return it.
 
     Parameters
     ----------
     importable : `str`
         String containing dot-separated path of a Python class, module,
         or member function.
 
     Returns
     -------
     type : `type`
         Type object. Either a module or class or a function.
 
     Raises
     ------
     TypeError
         ``importable`` is not a `str`.
     ModuleNotFoundError
         No module in the supplied import string could be found.
     ImportError
         ``importable`` is found but can not be imported or the requested
         item could not be retrieved from the imported module.
     """
     if not isinstance(importable, str):
         raise TypeError(f"Unhandled type of importable, val: {importable}")
 
     def tryImport(module, fromlist):
         pytype = importlib.import_module(module)
         # Can have functions inside classes inside modules
         for f in fromlist:
             try:
                 pytype = getattr(pytype, f)
             except AttributeError:
                 raise ImportError(f"Could not get attribute '{f}' from '{module}'")
         return pytype
 
     # Go through the import path attempting to load the module
     # and retrieve the class or function as an attribute. Shift components
     # from the module list to the attribute list until something works.
     moduleComponents = importable.split(".")
     infileComponents = []
 
     while moduleComponents:
         try:
             pytype = tryImport(".".join(moduleComponents), infileComponents)
             if not infileComponents and hasattr(pytype, moduleComponents[-1]):
                 # This module has an attribute with the same name as the
                 # module itself (like doImport.doImport, actually!).
                 # If that attribute was lifted to the package, we should
                 # return the attribute, not the module.
                 try:
                     return tryImport(".".join(moduleComponents[:-1]), moduleComponents[-1:])
                 except ModuleNotFoundError:
                     pass
             return pytype
         except ModuleNotFoundError:
             # Move element from module to file and try again
             infileComponents.insert(0, moduleComponents.pop())
 
     raise ModuleNotFoundError(f"Unable to import {importable}")

Functions

Function Documentation

◆ doImport()