lsst.afw.typehandling._GenericMap.GenericMap Class Reference

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

Public Member Functions
	__repr__ (self)
	__eq__ (self, other)

Static Public Attributes
	keys = Mapping.keys
	values = Mapping.values
	items = Mapping.items

Detailed Description

An abstract `~collections.abc.Mapping` for use when sharing a
map between C++ and Python.

For compatibility with C++, ``GenericMap`` 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++.

Definition at line 30 of file _GenericMap.py.

Member Function Documentation

__eq__()

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

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__()

lsst.afw.typehandling._GenericMap.GenericMap.__repr__

(

self

)

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()) + "})"
 

Member Data Documentation

items

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

static

Definition at line 70 of file _GenericMap.py.

keys

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

static

Definition at line 68 of file _GenericMap.py.

values

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

static

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-8.0.0/Linux64/afw/g5a732f18d5+be83d3ecdb/python/lsst/afw/typehandling/_GenericMap.py