LSSTApplications  18.1.0
LSSTDataManagementBasePackage
_Storable.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 "pybind11/pybind11.h"
25 
26 #include "lsst/utils/python.h"
27 
30 
31 namespace py = pybind11;
32 using namespace py::literals;
33 
34 namespace lsst {
35 namespace afw {
36 namespace typehandling {
37 
38 using PyStorable = py::class_<Storable, std::shared_ptr<Storable>, table::io::Persistable, StorableHelper<>>;
39 
41  wrappers.addInheritanceDependency("lsst.afw.table.io");
42 
43  wrappers.wrapType(PyStorable(wrappers.module, "Storable"), [](auto& mod, auto& cls) {
44  // Do not wrap methods inherited from Persistable
45  cls.def(py::init<>()); // Dummy constructor for pure-Python subclasses
46  // Do not wrap optional Storable methods; let subclasses do it as appropriate
47  cls.def("__eq__", [](Storable const& self, Storable const& other) { return self.equals(other); },
48  "other"_a);
49  });
50 }
51 
52 } // namespace typehandling
53 } // namespace afw
54 } // namespace lsst
py::class_< Storable, std::shared_ptr< Storable >, table::io::Persistable, StorableHelper<> > PyStorable
Definition: _Storable.cc:38
void wrapStorable(utils::python::WrapperCollection &wrappers)
Definition: _Storable.cc:40
void addInheritanceDependency(std::string const &name)
Indicate an external module that provides a base class for a subsequent addType call.
Definition: python.h:343
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition: python.h:448
A base class for objects that can be persisted via afw::table::io Archive classes.
Definition: Persistable.h:74
A base class for image defects.
"Trampoline" for Storable to let it be used as a base class in Python.
Definition: python.h:50
A helper class for subdividing pybind11 module across multiple translation units (i.e.
Definition: python.h:242
PyType wrapType(PyType cls, ClassWrapperCallback function, bool setModuleName=true)
Add a type (class or enum) wrapper, deferring method and other attribute definitions until finish() i...
Definition: python.h:391