LSST Applications g013ef56533+7c9321ec0f,g042eb84c57+c6cfa41bc3,g199a45376c+0ba108daf9,g1fd858c14a+fcad0d0313,g210f2d0738+c0f94c6586,g262e1987ae+a7e710680e,g29ae962dfc+fb55f2edb0,g2ac17093b6+61d6563b1e,g2b1d02342f+df6f932764,g2cef7863aa+aef1011c0b,g2f7ad74990+c0f94c6586,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53cf87ae69,g47891489e3+4316d04fff,g511e8cfd20+baa56acf6c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+fd7ad03fde,g64539dfbff+c0f94c6586,g67b6fd64d1+4316d04fff,g67fd3c3899+c0f94c6586,g6985122a63+4316d04fff,g74acd417e5+ca833bee28,g786e29fd12+668abc6043,g81db2e9a8d+b2ec8e584f,g87389fa792+8856018cbb,g89139ef638+4316d04fff,g8d7436a09f+0a24083b20,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+11eb8fd5b8,gbf99507273+8c5ae1fdc5,gcdda8b9158+e4c84c9d5c,gce8aa8abaa+8c5ae1fdc5,gd7ef33dd92+4316d04fff,gdab6d2f7ff+ca833bee28,ge410e46f29+4316d04fff,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.40
LSST Data Management Base Package
Loading...
Searching...
No Matches
_SimpleGenericMap.py
Go to the documentation of this file.
1# This file is part of afw.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
21
22__all__ = ["SimpleGenericMap"]
23
24from lsst.utils import continueClass
25from ._typehandling import SimpleGenericMapS
26from ._GenericMap import MutableGenericMap, AutoKeyMeta
27
28
29class SimpleGenericMap(MutableGenericMap, metaclass=AutoKeyMeta):
30 """A `dict`-like `~collections.abc.MutableMapping` for use when sharing a
31 map between C++ and Python.
32
33 For compatibility with C++, ``SimpleGenericMap`` has the following
34 restrictions:
35
36 - all keys must be of the same type
37 - values must be built-in types or subclasses of
38 `lsst.afw.typehandling.Storable`. Almost any user-defined class in
39 C++ or Python can have `~lsst.afw.typehandling.Storable` as a mixin.
40
41 As a safety precaution, `~lsst.afw.typehandling.Storable` objects that are
42 added from C++ may be copied when you retrieve them from Python, making it
43 impossible to modify them in-place. This issue does not affect objects that
44 are added from Python, or objects that are always passed by
45 :cpp:class:`shared_ptr` in C++.
46
47 Parameters
48 ----------
49 mapping : `collections.abc.Mapping`, optional
50 iterable : iterable, optional
51 dtype : `type`, optional
52 The type of key the map accepts. Not required if ``mapping`` or
53 ``iterable`` is provided.
54 **kwargs
55 Aside from the ``dtype`` keyword, a ``SimpleGenericMap`` takes the same
56 input arguments as `dict`.
57 """
58 @classmethod
59 def fromkeys(cls, iterable, value=None):
60 return cls({key: value for key in iterable})
61
62
63SimpleGenericMap.register(str, SimpleGenericMapS)
64
65
66# pybind11-generated constructor, can only create empty map
67_oldInit = SimpleGenericMapS.__init__
68
69
70@continueClass
71class SimpleGenericMapS: # noqa: F811
72 def __init__(self, source=None, **kwargs):
73 _oldInit(self)
74 if source:
75 self.update(source, **kwargs)
76 else:
77 self.update(**kwargs)