LSSTApplications  17.0+10,17.0+51,17.0+88,18.0.0+10,18.0.0+15,18.0.0+34,18.0.0+4,18.0.0+6,18.0.0-2-ge43143a+6,18.1.0-1-g0001055+2,18.1.0-1-g0896a44+10,18.1.0-1-g1349e88+9,18.1.0-1-g2505f39+7,18.1.0-1-g380d4d4+9,18.1.0-1-g5e4b7ea+2,18.1.0-1-g7e8fceb,18.1.0-1-g85f8cd4+7,18.1.0-1-g9a6769a+3,18.1.0-1-ga1a4c1a+6,18.1.0-1-gc037db8+2,18.1.0-1-gd55f500+3,18.1.0-1-ge10677a+7,18.1.0-10-g73b8679e+12,18.1.0-12-gf30922b,18.1.0-13-g451e75588,18.1.0-13-gbfe7f7f,18.1.0-2-g31c43f9+7,18.1.0-2-g9c63283+9,18.1.0-2-gdf0b915+9,18.1.0-2-gf03bb23+2,18.1.0-3-g52aa583+3,18.1.0-3-g8f4a2b1+1,18.1.0-3-g9cb968e+8,18.1.0-4-g7bbbad0,18.1.0-5-g510c42a+8,18.1.0-5-ga46117f,18.1.0-5-gaeab27e+9,18.1.0-6-gdda7f3e+11,18.1.0-8-g4084bf03+1,w.2019.34
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 subclasses.
  • Call this function to wrap the methods that make your object persistable.

Definition at line 88 of file python.h.

88  {
89  cls.def_static("readFits",
90  (std::shared_ptr<Class>(*)(std::string const &, int)) & PersistableFacade<Class>::readFits,
91  "fileName"_a, "hdu"_a = fits::DEFAULT_HDU);
92  cls.def_static(
93  "readFits",
94  (std::shared_ptr<Class>(*)(fits::MemFileManager &, int)) & PersistableFacade<Class>::readFits,
95  "manager"_a, "hdu"_a = fits::DEFAULT_HDU);
96  cls.def("writeFits", (void (Class::*)(std::string const &, std::string const &) const) & Class::writeFits,
97  "fileName"_a, "mode"_a = "w");
98  cls.def("writeFits",
99  (void (Class::*)(fits::MemFileManager &, std::string const &) const) & Class::writeFits,
100  "manager"_a, "mode"_a = "w");
101  cls.def("isPersistable", &Class::isPersistable);
102 }
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 63 of file python.h.

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