Inheritance diagram for lsst.afw.typehandling._GenericMap.MutableGenericMap:
Public Member Functions | |
| pop (self, key, default=None) | |
Static Public Attributes | |
| setdefault = MutableMapping.setdefault | |
| update = MutableMapping.update | |
Detailed Description
An abstract `~collections.abc.MutableMapping` for use when sharing a
map between C++ and Python.
For compatibility with C++, ``MutableGenericMap`` has the following
restrictions:
- all keys must be of the same type
- values must be built-in types or subclasses of
`lsst.afw.typehandling.Storable`. Almost any user-defined class in
C++ or Python can have `~lsst.afw.typehandling.Storable` as a mixin.
As a safety precaution, `~lsst.afw.typehandling.Storable` objects that are
added from C++ may be copied when you retrieve them from Python, making it
impossible to modify them in-place. This issue does not affect objects that
are added from Python, or objects that are always passed by
:cpp:class:`shared_ptr` in C++.
Notes
-----
Key-type specializations of ``MutableGenericMap`` are available as, e.g.,
``MutableGenericMap[str]``.
Definition at line 77 of file _GenericMap.py.
Member Function Documentation
◆ pop()
| lsst.afw.typehandling._GenericMap.MutableGenericMap.pop | ( | self, | |
| key, | |||
| default = None ) |
Definition at line 106 of file _GenericMap.py.
106 def pop(self, key, default=None):
107 try:
108 value = self[key]
109 del self[key]
110 return value
111 except KeyError:
112 if default is not None:
113 return default
114 else:
115 raise
116
117
Member Data Documentation
◆ setdefault
|
static |
Definition at line 102 of file _GenericMap.py.
◆ update
|
static |
Definition at line 103 of file _GenericMap.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/python/lsst/afw/typehandling/_GenericMap.py
