LSSTApplications  18.0.0+56,19.0.0+1,19.0.0+18,19.0.0+19,19.0.0+21,19.0.0+26,19.0.0+5,19.0.0-1-g20d9b18+12,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+12,19.0.0-1-g6fe20d0+4,19.0.0-1-g8c57eb9+12,19.0.0-1-ga72da6b,19.0.0-1-gbfe0924+3,19.0.0-1-gdc0e4a7+17,19.0.0-1-ge272bc4+12,19.0.0-1-ge3aa853+3,19.0.0-16-g3a790c8c,19.0.0-18-g955d782+1,19.0.0-2-g0d9f9cd+19,19.0.0-2-g260436e+3,19.0.0-2-g9b11441+6,19.0.0-2-gd955cfd+25,19.0.0-3-g6513920+3,19.0.0-3-gc4f6e04+2,19.0.0-4-g41ffa1d+5,19.0.0-4-g725f80e+21,19.0.0-5-g0745e3f+3,19.0.0-6-g5a632bb5+1,19.0.0-6-gb6b8b0a+3,19.0.0-7-g686a884,19.0.0-7-gea0a0fe+8,19.0.0-9-gd2f60f3c3,w.2020.03
LSSTDataManagementBasePackage
Functions
lsst::afw::table::io::python Namespace Reference

Functions

template<typename T >
void declarePersistableFacade (pybind11::module &module, std::string const &suffix)
 Wraps an instantiation of PersistableFacade. More...
 
template<typename Class , typename... Args>
void addPersistableMethods (pybind11::class_< Class, Args... > &cls)
 Add table::io::Persistable and PersistableFacade methods to the pybind11 wrapper for a class. More...
 

Function Documentation

◆ addPersistableMethods()

template<typename Class , typename... Args>
void lsst::afw::table::io::python::addPersistableMethods ( pybind11::class_< Class, Args... > &  cls)

Add table::io::Persistable and PersistableFacade methods to the pybind11 wrapper for a class.

Use this instead of declarePersistableFacade to avoid circular import issues in Python; it allows your class to be used without importing lsst.afw.table.

Use as follows:

  • When declaring the pybind11 class that wraps your Class do not list table::io::PersistableFacade<Class> and table::io::Persistable as base classes.
  • Call this function to wrap the methods that make your object persistable.

Definition at line 90 of file python.h.

90  {
91  cls.def_static("readFits",
92  (std::shared_ptr<Class>(*)(std::string const &, int)) & PersistableFacade<Class>::readFits,
93  "fileName"_a, "hdu"_a = fits::DEFAULT_HDU);
94  cls.def_static(
95  "readFits",
96  (std::shared_ptr<Class>(*)(fits::MemFileManager &, int)) & PersistableFacade<Class>::readFits,
97  "manager"_a, "hdu"_a = fits::DEFAULT_HDU);
98  cls.def("writeFits", (void (Class::*)(std::string const &, std::string const &) const) & Class::writeFits,
99  "fileName"_a, "mode"_a = "w");
100  cls.def("writeFits",
101  (void (Class::*)(fits::MemFileManager &, std::string const &) const) & Class::writeFits,
102  "manager"_a, "mode"_a = "w");
103  cls.def("isPersistable", &Class::isPersistable);
104 }
STL class.
const int DEFAULT_HDU
Specify that the default HDU should be read.
Definition: fitsDefaults.h:18

◆ declarePersistableFacade()

template<typename T >
void lsst::afw::table::io::python::declarePersistableFacade ( pybind11::module &  module,
std::string const &  suffix 
)

Wraps an instantiation of PersistableFacade.

Deprecated:
Use addPersistableMethods for all new code.

Pybind11 shall assume that PersistableFacade is managed using std::shared_ptr, as this is required for compatibility with existing subclasses of PersistableFacade. This means that wrapping will only work if new classes also use std::shared_ptr as their holder type.

Template Parameters
TThe type of object this PersistableFacade is for.
Parameters
moduleThe pybind11 module that shall contain PersistableFacade<T>
suffixA string to disambiguate this class from other PersistableFacades. The Python name of this class shall be PersistableFacade<suffix>.

Definition at line 65 of file python.h.

65  {
66  using namespace pybind11::literals;
67 
68  pybind11::class_<PersistableFacade<T>, std::shared_ptr<PersistableFacade<T>>> cls(
69  module, ("PersistableFacade" + suffix).c_str());
70  cls.def_static("readFits",
71  (std::shared_ptr<T>(*)(std::string const &, int)) & PersistableFacade<T>::readFits,
72  "fileName"_a, "hdu"_a = fits::DEFAULT_HDU);
73  cls.def_static("readFits",
74  (std::shared_ptr<T>(*)(fits::MemFileManager &, int)) & PersistableFacade<T>::readFits,
75  "manager"_a, "hdu"_a = fits::DEFAULT_HDU);
76 }
STL class.
const int DEFAULT_HDU
Specify that the default HDU should be read.
Definition: fitsDefaults.h:18