lsst.afw.typehandling._GenericMap.MutableGenericMap Class Reference

Inheritance diagram for lsst.afw.typehandling._GenericMap.MutableGenericMap:

Public Member Functions
	pop (self, key, default=None)
	__repr__ (self)
	__eq__ (self, other)

Static Public Attributes
	setdefault = MutableMapping.setdefault
	update = MutableMapping.update
	keys = Mapping.keys
	values = Mapping.values
	items = Mapping.items

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

__eq__()

lsst.afw.typehandling._GenericMap.GenericMap.__eq__ ( self, other )

inherited

Definition at line 55 of file _GenericMap.py.

__repr__()

lsst.afw.typehandling._GenericMap.GenericMap.__repr__ ( self )

inherited

Definition at line 49 of file _GenericMap.py.

pop()

lsst.afw.typehandling._GenericMap.MutableGenericMap.pop	(		self,
			key,
			default = None )

Definition at line 106 of file _GenericMap.py.

Member Data Documentation

items

lsst.afw.typehandling._GenericMap.GenericMap.items = Mapping.items

staticinherited

Definition at line 70 of file _GenericMap.py.

keys

lsst.afw.typehandling._GenericMap.GenericMap.keys = Mapping.keys

staticinherited

Definition at line 68 of file _GenericMap.py.

setdefault

lsst.afw.typehandling._GenericMap.MutableGenericMap.setdefault = MutableMapping.setdefault

static

Definition at line 102 of file _GenericMap.py.

update

lsst.afw.typehandling._GenericMap.MutableGenericMap.update = MutableMapping.update

static

Definition at line 103 of file _GenericMap.py.

values

lsst.afw.typehandling._GenericMap.GenericMap.values = Mapping.values

staticinherited

Definition at line 69 of file _GenericMap.py.

---

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

• python/lsst/afw/typehandling/_GenericMap.py