lsstDebug.Info Class Reference

Public Member Functions
	__init__ (self, modname)
	__getattr__ (self, what)
	__setattr__ (self, what, value)

Protected Attributes
	_modname

Detailed Description

An object cognisant of debugging parameters appropriate for module
``modname``.

Any request for a value will return False unless that value has
been set, either in the module or as an attribute of this object.

E.g.

.. code-block:: python

    import lsstDebug

    display = lsstDebug.Info(__name__).display

will set display to `False`, unless display has been set with

.. code-block:: python

    lsstDebug.Info(__name__).display = True

Why is this interesting?  Because you can replace `lsstDebug.Info` with
your own version, e.g.

.. code-block:: python

    import lsstDebug

    def DebugInfo(name):
        # N.b. lsstDebug.Info(name) would call us recursively
        di = lsstDebug.getInfo(name)
        if name == "foo":
            di.display = dict(repair=1, background=2, calibrate=3)

        return di

    lsstDebug.Info = DebugInfo

Parameters
----------
modname : `str`
    Module name.

Raises
------
KeyError
    Raised if ``modname`` is not loaded.

Definition at line 28 of file lsstDebug.py.

Constructor & Destructor Documentation

__init__()

lsstDebug.Info.__init__	(		self,
			modname )

Definition at line 76 of file lsstDebug.py.

    def __init__(self, modname):
        import sys
        self.__dict__["_dict"] = sys.modules[modname].__dict__
        self._modname = modname
 

Member Function Documentation

__getattr__()

lsstDebug.Info.__getattr__	(		self,
			what )

Return the value of the variable "what" in ``self.__modname``
if set, else False

Definition at line 81 of file lsstDebug.py.

    def __getattr__(self, what):
        """Return the value of the variable "what" in ``self.__modname``
        if set, else False"""
        return self._dict.get(what, False)
 

__setattr__()

lsstDebug.Info.__setattr__	(		self,
			what,
			value )

Set the value of the variable "what" in ``self.__modname``
to value

Definition at line 86 of file lsstDebug.py.

    def __setattr__(self, what, value):
        """Set the value of the variable "what" in ``self.__modname``
        to value"""
        self._dict[what] = value
 
 

Member Data Documentation

_modname

lsstDebug.Info._modname

protected

Definition at line 79 of file lsstDebug.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/base/g52b1c1532d+a6fc98d2e7/python/lsstDebug.py