LSSTApplications  20.0.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"
28 
31 
32 namespace py = pybind11;
33 using namespace py::literals;
34 
36 
37 namespace lsst {
38 namespace afw {
39 namespace typehandling {
40 
41 using PyStorable = py::class_<Storable, PySharedPtr<Storable>, table::io::Persistable, StorableHelper<>>;
42 
44  wrappers.addInheritanceDependency("lsst.afw.table.io");
45 
46  wrappers.wrapType(PyStorable(wrappers.module, "Storable"), [](auto& mod, auto& cls) {
47  // Do not wrap methods inherited from Persistable
48  cls.def(py::init<>()); // Dummy constructor for pure-Python subclasses
49  // Do not wrap optional Storable methods; let subclasses do it as appropriate
50  cls.def("__eq__", [](Storable const& self, Storable const& other) { return self.equals(other); },
51  "other"_a);
52  });
53 }
54 
55 } // namespace typehandling
56 } // namespace afw
57 } // namespace lsst
lsst::utils::python::WrapperCollection::addInheritanceDependency
void addInheritanceDependency(std::string const &name)
Indicate an external module that provides a base class for a subsequent addType call.
Definition: python.h:343
lsst::utils::python::PySharedPtr
A shared pointer that tracks both a C++ object and its associated PyObject.
Definition: PySharedPtr.h:49
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::typehandling::wrapStorable
void wrapStorable(utils::python::WrapperCollection &wrappers)
Definition: _Storable.cc:43
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
lsst::afw::typehandling::PyStorable
py::class_< Storable, PySharedPtr< Storable >, table::io::Persistable, StorableHelper<> > PyStorable
Definition: _Storable.cc:41
lsst::utils::python::WrapperCollection::wrapType
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
lsst::utils::python::WrapperCollection
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition: python.h:242
Storable.h
python.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
python.h
lsst::afw::table::io::Persistable
A base class for objects that can be persisted via afw::table::io Archive classes.
Definition: Persistable.h:74
pybind11
Definition: _GenericMap.cc:40
PySharedPtr.h
lsst::utils::python::WrapperCollection::module
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition: python.h:448
lsst::afw::typehandling::StorableHelper
"Trampoline" for Storable to let it be used as a base class in Python.
Definition: python.h:50