LSSTApplications  18.0.0+54,19.0.0,19.0.0+1,19.0.0+16,19.0.0+17,19.0.0+19,19.0.0+24,19.0.0+3,19.0.0-1-g20d9b18+10,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+10,19.0.0-1-g6fe20d0+2,19.0.0-1-g8c57eb9+10,19.0.0-1-gbfe0924+1,19.0.0-1-gdc0e4a7+15,19.0.0-1-ge272bc4+10,19.0.0-1-ge3aa853+1,19.0.0-14-gbb28fe44+1,19.0.0-16-g8258e2a+1,19.0.0-2-g0d9f9cd+17,19.0.0-2-g260436e+1,19.0.0-2-g9b11441+4,19.0.0-2-gd955cfd+23,19.0.0-3-g6513920+1,19.0.0-3-gc4f6e04,19.0.0-4-g41ffa1d+3,19.0.0-4-g725f80e+19,19.0.0-4-ga8eba22,19.0.0-5-g0745e3f+1,19.0.0-5-gd943061d,19.0.0-6-gb6b8b0a+1,19.0.0-7-ge358e0fc4,19.0.0-7-gea0a0fe+6,w.2020.03
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}")
89 
def doImport(importable)
Definition: doImport.py:28