LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
Functions
lsst.utils.doImport Namespace Reference

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.

28 def doImport(importable):
29  """Import a python object given an importable string and return it.
30 
31  Parameters
32  ----------
33  importable : `str`
34  String containing dot-separated path of a Python class, module,
35  or member function.
36 
37  Returns
38  -------
39  type : `type`
40  Type object. Either a module or class or a function.
41 
42  Raises
43  ------
44  TypeError
45  ``importable`` is not a `str`.
46  ModuleNotFoundError
47  No module in the supplied import string could be found.
48  ImportError
49  ``importable`` is found but can not be imported or the requested
50  item could not be retrieved from the imported module.
51  """
52  if not isinstance(importable, str):
53  raise TypeError(f"Unhandled type of importable, val: {importable}")
54 
55  def tryImport(module, fromlist):
56  pytype = importlib.import_module(module)
57  # Can have functions inside classes inside modules
58  for f in fromlist:
59  try:
60  pytype = getattr(pytype, f)
61  except AttributeError:
62  raise ImportError(f"Could not get attribute '{f}' from '{module}'")
63  return pytype
64 
65  # Go through the import path attempting to load the module
66  # and retrieve the class or function as an attribute. Shift components
67  # from the module list to the attribute list until something works.
68  moduleComponents = importable.split(".")
69  infileComponents = []
70 
71  while moduleComponents:
72  try:
73  pytype = tryImport(".".join(moduleComponents), infileComponents)
74  if not infileComponents and hasattr(pytype, moduleComponents[-1]):
75  # This module has an attribute with the same name as the
76  # module itself (like doImport.doImport, actually!).
77  # If that attribute was lifted to the package, we should
78  # return the attribute, not the module.
79  try:
80  return tryImport(".".join(moduleComponents[:-1]), moduleComponents[-1:])
81  except ModuleNotFoundError:
82  pass
83  return pytype
84  except ModuleNotFoundError:
85  # Move element from module to file and try again
86  infileComponents.insert(0, moduleComponents.pop())
87 
88  raise ModuleNotFoundError(f"Unable to import {importable}")
lsst::utils.doImport.doImport
def doImport(importable)
Definition: doImport.py:28