lsst.afw.typehandling._GenericMap.MutableGenericMap Class Reference

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

Public Member Functions
def	pop (self, key, default=None)
def	__repr__ (self)
def	__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__()

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

inherited

Definition at line 55 of file _GenericMap.py.

    def __eq__(self, other):
        if len(self) != len(other):
            return False
 
        for key, value in self.items():
            try:
                if (value != other[key]):
                    return False
            except KeyError:
                return False
        return True
 

__repr__()

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

inherited

Definition at line 49 of file _GenericMap.py.

    def __repr__(self):
        className = type(self).__name__
        return className + "({" + ", ".join("%r: %r" % (key, value) for key, value in self.items()) + "})"
 

pop()

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

Definition at line 106 of file _GenericMap.py.

    def pop(self, key, default=None):
        try:
            value = self[key]
            del self[key]
            return value
        except KeyError:
            if default is not None:
                return default
            else:
                raise
 
 
MutableGenericMap.register(str, MutableGenericMapS)
MutableMapping.register(MutableGenericMapS)
 
 

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-32-g5ddfab5d3+60ce4897b0/python/lsst/afw/typehandling/_GenericMap.py