LSSTApplications  20.0.0
LSSTDataManagementBasePackage
_SimpleGenericMap.cc
Go to the documentation of this file.
1 /*
2  * This file is part of afw.
3  *
4  * Developed for the LSST Data Management System.
5  * This product includes software developed by the LSST Project
6  * (https://www.lsst.org).
7  * See the COPYRIGHT file at the top-level directory of this distribution
8  * for details of code ownership.
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see <https://www.gnu.org/licenses/>.
22  */
23 
24 #include <memory>
25 
26 #include "pybind11/pybind11.h"
27 
28 #include "lsst/utils/python.h"
29 
32 
33 namespace py = pybind11;
34 using namespace py::literals;
35 
36 namespace lsst {
37 namespace afw {
38 namespace typehandling {
39 
40 namespace {
41 template <typename K>
42 void declareSimpleGenericMap(utils::python::WrapperCollection& wrappers, std::string const& suffix,
43  std::string const& key) {
44  using Class = SimpleGenericMap<K>;
45  using PyClass = py::class_<Class, std::shared_ptr<Class>, MutableGenericMap<K>>;
46 
47  std::string className = "SimpleGenericMap" + suffix;
48  // Give the class a custom docstring to avoid confusing Python users
49  std::string docstring =
50  "A `dict`-like `~collections.abc.MutableMapping` for use when sharing a map between C++ and "
51  "Python.\n" +
53  R"docstring(
54 Parameters
55 ----------
56 mapping : `collections.abc.Mapping`, optional
57 iterable : iterable, optional
58 **kwargs
59  A ``SimpleGenericMap`` takes the same input arguments as `dict`.
60 )docstring";
61  wrappers.wrapType(PyClass(wrappers.module, className.c_str(), docstring.c_str()),
62  [](auto& mod, auto& cls) {
63  // Don't rewrap members of MutableGenericMap
64 
65  /* need __init__(**kw), __init__(mapping, **kw), __init__(iterable, **kw)
66  * can't find a good way to insert a py::handle value from C++
67  * can't call MutableGenericMap.__setitem__ without its class_ object, which
68  * is in a different pybind11 module but can't be imported (yet)
69  */
70  cls.def(py::init<>());
71  cls.def("copy", [](Class const& self) { return Class(self); });
72 
73  // fromkeys easier to implement in Python
74  });
75 }
76 
77 } // namespace
78 
80  declareSimpleGenericMap<std::string>(wrappers, "S", "strings");
81 }
82 
83 } // namespace typehandling
84 } // namespace afw
85 } // namespace lsst
SimpleGenericMap.h
lsst::afw::typehandling::declareGenericMapRestrictions
std::string declareGenericMapRestrictions(std::string const &className, std::string const &keyName)
Definition: python.cc:32
std::string
STL class.
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
std::string::c_str
T c_str(T... args)
PyClass
py::class_< ProductBoundedField, std::shared_ptr< ProductBoundedField >, BoundedField > PyClass
Definition: productBoundedField.cc:32
lsst::utils::python::WrapperCollection
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition: python.h:242
python.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
python.h
lsst::afw::typehandling::wrapSimpleGenericMap
void wrapSimpleGenericMap(utils::python::WrapperCollection &wrappers)
Definition: _SimpleGenericMap.cc:79
key
Key< U > key
Definition: Schema.cc:281
pybind11
Definition: _GenericMap.cc:40