LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
Classes | Functions | Variables
lsst.utils.wrappers Namespace Reference

Classes

class  TemplateMeta
 

Functions

def isAttributeSafeToTransfer (name, value)
 
def continueClass (cls)
 
def inClass (cls, name=None)
 

Variables

 INTRINSIC_SPECIAL_ATTRIBUTES
 

Function Documentation

◆ continueClass()

def lsst.utils.wrappers.continueClass (   cls)
Re-open the decorated class, adding any new definitions into the original.

For example::

.. code-block:: python

    class Foo:
        pass

    @continueClass
    class Foo:
        def run(self):
            return None

is equivalent to::

.. code-block:: python

    class Foo:
        def run(self):
            return None

.. warning::

    Python's built-in `super` function does not behave properly in classes
    decorated with `continueClass`.  Base class methods must be invoked
    directly using their explicit types instead.

Definition at line 59 of file wrappers.py.

59 def continueClass(cls):
60  """Re-open the decorated class, adding any new definitions into the original.
61 
62  For example::
63 
64  .. code-block:: python
65 
66  class Foo:
67  pass
68 
69  @continueClass
70  class Foo:
71  def run(self):
72  return None
73 
74  is equivalent to::
75 
76  .. code-block:: python
77 
78  class Foo:
79  def run(self):
80  return None
81 
82  .. warning::
83 
84  Python's built-in `super` function does not behave properly in classes
85  decorated with `continueClass`. Base class methods must be invoked
86  directly using their explicit types instead.
87 
88  """
89  orig = getattr(sys.modules[cls.__module__], cls.__name__)
90  for name in dir(cls):
91  # Common descriptors like classmethod and staticmethod can only be
92  # accessed without invoking their magic if we use __dict__; if we use
93  # getattr on those we'll get e.g. a bound method instance on the dummy
94  # class rather than a classmethod instance we can put on the target
95  # class.
96  attr = cls.__dict__.get(name, None) or getattr(cls, name)
97  if isAttributeSafeToTransfer(name, attr):
98  setattr(orig, name, attr)
99  return orig
100 
101 
def isAttributeSafeToTransfer(name, value)
Definition: wrappers.py:45
def continueClass(cls)
Definition: wrappers.py:59

◆ inClass()

def lsst.utils.wrappers.inClass (   cls,
  name = None 
)
Add the decorated function to the given class as a method.

For example::

.. code-block:: python

    class Foo:
        pass

    @inClass(Foo)
    def run(self):
        return None

is equivalent to::

.. code-block:: python

    class Foo:
        def run(self):
            return None

Standard decorators like ``classmethod``, ``staticmethod``, and
``property`` may be used *after* this decorator.  Custom decorators
may only be used if they return an object with a ``__name__`` attribute
or the ``name`` optional argument is provided.

Definition at line 102 of file wrappers.py.

102 def inClass(cls, name=None):
103  """Add the decorated function to the given class as a method.
104 
105  For example::
106 
107  .. code-block:: python
108 
109  class Foo:
110  pass
111 
112  @inClass(Foo)
113  def run(self):
114  return None
115 
116  is equivalent to::
117 
118  .. code-block:: python
119 
120  class Foo:
121  def run(self):
122  return None
123 
124  Standard decorators like ``classmethod``, ``staticmethod``, and
125  ``property`` may be used *after* this decorator. Custom decorators
126  may only be used if they return an object with a ``__name__`` attribute
127  or the ``name`` optional argument is provided.
128  """
129  def decorate(func):
130  # Using 'name' instead of 'name1' breaks the closure because
131  # assignment signals a strictly local variable.
132  name1 = name
133  if name1 is None:
134  if hasattr(func, "__name__"):
135  name1 = func.__name__
136  else:
137  if hasattr(func, "__func__"):
138  # classmethod and staticmethod have __func__ but no __name__
139  name1 = func.__func__.__name__
140  elif hasattr(func, "fget"):
141  # property has fget but no __name__
142  name1 = func.fget.__name__
143  else:
144  raise ValueError(
145  "Could not guess attribute name for '{}'.".format(func)
146  )
147  setattr(cls, name1, func)
148  return func
149  return decorate
150 
151 
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:168
def inClass(cls, name=None)
Definition: wrappers.py:102

◆ isAttributeSafeToTransfer()

def lsst.utils.wrappers.isAttributeSafeToTransfer (   name,
  value 
)
Return True if an attribute is safe to monkeypatch-transfer to another
class.

This rejects special methods that are defined automatically for all
classes, leaving only those explicitly defined in a class decorated by
`continueClass` or registered with an instance of `TemplateMeta`.

Definition at line 45 of file wrappers.py.

45 def isAttributeSafeToTransfer(name, value):
46  """Return True if an attribute is safe to monkeypatch-transfer to another
47  class.
48 
49  This rejects special methods that are defined automatically for all
50  classes, leaving only those explicitly defined in a class decorated by
51  `continueClass` or registered with an instance of `TemplateMeta`.
52  """
53  if name.startswith("__") and (value is getattr(object, name, None) or
54  name in INTRINSIC_SPECIAL_ATTRIBUTES):
55  return False
56  return True
57 
58 
def isAttributeSafeToTransfer(name, value)
Definition: wrappers.py:45

Variable Documentation

◆ INTRINSIC_SPECIAL_ATTRIBUTES

lsst.utils.wrappers.INTRINSIC_SPECIAL_ATTRIBUTES
Initial value:
1 = frozenset((
2  "__qualname__",
3  "__module__",
4  "__metaclass__",
5  "__dict__",
6  "__weakref__",
7  "__class__",
8  "__subclasshook__",
9  "__name__",
10  "__doc__",
11 ))

Definition at line 32 of file wrappers.py.