LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Functions
lsst::pex::exceptions::python Namespace Reference

Functions

template<typename T , typename E = lsst::pex::exceptions::Exception>
pybind11::class_< T, E > declareException (pybind11::module &mod, const std::string &name, const std::string &base)
 Helper function for pybind11, used to define new types of exceptions. More...
 

Function Documentation

◆ declareException()

template<typename T , typename E = lsst::pex::exceptions::Exception>
pybind11::class_<T, E> lsst::pex::exceptions::python::declareException ( pybind11::module &  mod,
const std::string name,
const std::string base 
)

Helper function for pybind11, used to define new types of exceptions.

While this function creates the class wrapper, the user is still responsible for adding all constructor and member wrappers to the returned py::class_ object.

Template Parameters
TThe C++ exception to wrap.
EThe C++ base class of T.
Parameters
[in]modModule to insert the exception into.
[in]nameName of the exception in the module.
[in]basePython name of base class (from pex::exceptions).

Definition at line 52 of file Exception.h.

53  {
54  namespace py = pybind11;
55 
56  // Wrap T as a new Python exception type with *name* and add it to the module
57  //
58  // Note that all created C++ wrapped type derive from Exception here.
59  // It is only in the pure Python wrapper layer that they get embedded in
60  // a subclass of the requested base.
61  py::class_<T, E> cls(mod, name.c_str());
62 
63  // Declare T wrapped by cls as a pex exception and register it
64  // this relies on the pure Python function "declare" defined in "wrappers"
65  // to create a corresponding Python type derived from Python standard Exception
66  auto exceptions =
67  py::reinterpret_steal<py::object>(PyImport_ImportModule("lsst.pex.exceptions.wrappers"));
68  if (!exceptions.ptr()) {
69  PyErr_SetString(PyExc_SystemError, "import failed");
70  throw py::error_already_set();
71  }
72 
73  auto declare = py::reinterpret_steal<py::object>(PyObject_GetAttrString(exceptions.ptr(), "declare"));
74  if (!declare.ptr()) {
75  PyErr_SetString(PyExc_SystemError, "could not get declare function from Python");
76  throw py::error_already_set();
77  }
78 
79  auto baseCls = py::reinterpret_steal<py::object>(PyObject_GetAttrString(exceptions.ptr(), base.c_str()));
80  if (!baseCls.ptr()) {
81  PyErr_SetString(PyExc_SystemError, "could not get base class");
82  throw py::error_already_set();
83  }
84 
85  auto exceptionName = py::reinterpret_steal<py::object>(PYBIND11_FROM_STRING(name.c_str()));
86  if (!exceptionName.ptr()) {
87  PyErr_SetString(PyExc_SystemError, "could not create name string");
88  throw py::error_already_set();
89  }
90 
91  auto result = py::reinterpret_steal<py::object>(PyObject_CallFunctionObjArgs(
92  declare.ptr(), mod.ptr(), exceptionName.ptr(), baseCls.ptr(), cls.ptr(), NULL));
93  if (!result.ptr()) {
94  PyErr_SetString(PyExc_SystemError, "could not declare exception");
95  throw py::error_already_set();
96  }
97 
98  return cls;
99 }
py::object result
Definition: _schema.cc:429
table::Key< std::string > name
Definition: Amplifier.cc:116
T c_str(T... args)
def declare(module, exception_name, base, wrapped_class)
Definition: wrappers.py:153