lsst.pex.config.config.RecordingImporter Class Reference

Public Member Functions
	__init__ (self)
	__enter__ (self)
	__exit__ (self, *args)
	uninstall (self)
	find_spec (self, fullname, path, target=None)
	getModules (self)

Public Attributes
	origMetaPath

Protected Attributes
	_modules

Detailed Description

Importer (for `sys.meta_path`) that records which modules are being
imported.

*This class does not do any importing itself.*

Examples
--------
Use this class as a context manager to ensure it is properly uninstalled
when done:

>>> with RecordingImporter() as importer:
...     # import stuff
...     import numpy as np
... print("Imported: " + importer.getModules())

Definition at line 871 of file config.py.

Constructor & Destructor Documentation

__init__()

lsst.pex.config.config.RecordingImporter.__init__

(

self

)

Definition at line 888 of file config.py.

    def __init__(self):
        self._modules = set()
 

Member Function Documentation

__enter__()

lsst.pex.config.config.RecordingImporter.__enter__

(

self

)

Definition at line 891 of file config.py.

    def __enter__(self):
        self.origMetaPath = sys.meta_path
        sys.meta_path = [self] + sys.meta_path  # type: ignore
        return self
 

__exit__()

lsst.pex.config.config.RecordingImporter.__exit__	(		self,
		*	args )

Definition at line 896 of file config.py.

    def __exit__(self, *args):
        self.uninstall()
        return False  # Don't suppress exceptions
 

find_spec()

lsst.pex.config.config.RecordingImporter.find_spec	(		self,
			fullname,
			path,
			target = None )

Find a module.

Called as part of the ``import`` chain of events.

Parameters
----------
fullname : `str`
    Name of module.
path : `list` [`str`]
    Search path. Unused.
target : `~typing.Any`, optional
    Unused.

Definition at line 904 of file config.py.

    def find_spec(self, fullname, path, target=None):
        """Find a module.
 
        Called as part of the ``import`` chain of events.
 
        Parameters
        ----------
        fullname : `str`
            Name of module.
        path : `list` [`str`]
            Search path. Unused.
        target : `~typing.Any`, optional
            Unused.
        """
        self._modules.add(fullname)
        # Return None because we don't do any importing.
        return None
 

getModules()

lsst.pex.config.config.RecordingImporter.getModules

(

self

)

Get the set of modules that were imported.

Returns
-------
modules : `set` of `str`
    Set of imported module names.

Definition at line 922 of file config.py.

    def getModules(self):
        """Get the set of modules that were imported.
 
        Returns
        -------
        modules : `set` of `str`
            Set of imported module names.
        """
        return self._modules
 
 
# type ignore because type checker thinks ConfigMeta is Generic when it is not

uninstall()

lsst.pex.config.config.RecordingImporter.uninstall

(

self

)

Uninstall the importer.

Definition at line 900 of file config.py.

    def uninstall(self):
        """Uninstall the importer."""
        sys.meta_path = self.origMetaPath
 

Member Data Documentation

_modules

lsst.pex.config.config.RecordingImporter._modules

protected

Definition at line 889 of file config.py.

origMetaPath

lsst.pex.config.config.RecordingImporter.origMetaPath

Definition at line 892 of file config.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pex_config/gfbcc870c63+9a11dc8c8f/python/lsst/pex/config/config.py