_Storable.cc

Go to the documentation of this file.

/*
 * This file is part of afw.
 *
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#include "pybind11/pybind11.h"

#include "lsst/utils/python.h"
#include "lsst/utils/python/PySharedPtr.h"

#include "lsst/afw/typehandling/Storable.h"
#include "lsst/afw/typehandling/python.h"

namespace py = pybind11;
using namespace py::literals;

using lsst::utils::python::PySharedPtr;

namespace lsst {
namespace afw {
namespace typehandling {

using PyStorable = py::class_<Storable, PySharedPtr<Storable>, table::io::Persistable, StorableHelper<>>;

void wrapStorable(utils::python::WrapperCollection& wrappers) {
    wrappers.addInheritanceDependency("lsst.afw.table.io");

    wrappers.wrapType(PyStorable(wrappers.module, "Storable"), [](auto& mod, auto& cls) {
        // Do not wrap methods inherited from Persistable
        cls.def(py::init<>());  // Dummy constructor for pure-Python subclasses
        // Do not wrap optional Storable methods; let subclasses do it as appropriate
        cls.def("__eq__", [](Storable const& self, Storable const& other) { return self.equals(other); },
                "other"_a);
    });
}

}  // namespace typehandling
}  // namespace afw
}  // namespace lsst