LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
_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 
24 from lsst.utils import continueClass
25 from ._typehandling import SimpleGenericMapS
26 from ._GenericMap import MutableGenericMap, AutoKeyMeta
27 
28 
29 class 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 
63 SimpleGenericMap.register(str, SimpleGenericMapS)
64 
65 
66 # pybind11-generated constructor, can only create empty map
67 _oldInit = SimpleGenericMapS.__init__
68 
69 
70 @continueClass # noqa: F811 (FIXME: remove for py 3.8+)
71 class 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)