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
object.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  *
4  * This product includes software developed by the
5  * LSST Project (http://www.lsst.org/).
6  * See the COPYRIGHT file
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 #include <pybind11/pybind11.h>
23 
24 #include "astshim/base.h"
25 #include "astshim/Stream.h"
26 #include "astshim/Channel.h"
27 #include "astshim/Object.h"
28 
29 namespace py = pybind11;
30 using namespace pybind11::literals;
31 
32 namespace ast {
33 namespace {
34 
35 /*
36 Make an Object from a string output by Object.show()
37 
38 Used to support pickling Object and all of its subclasses
39 
40 Note: I would prefer to use a function but defining the obvious function
41 and returning that as the first item of Object.__reduce__ resulted in
42 Python rejecting it, claiming the function was not pickleable. I know how
43 to make a class pickleable, I don't know how to make a function pickleable.
44 */
45 class ObjectMaker {
46 public:
47  ObjectMaker() = default;
48  ~ObjectMaker() = default;
49  std::shared_ptr<Object> operator()(std::string const &state) {
50  ast::StringStream stream(state);
51  ast::Channel chan(stream);
52  return chan.read();
53  }
54 };
55 
56 PYBIND11_MODULE(object, mod) {
57  py::module::import("astshim.base");
58 
59  py::class_<ObjectMaker, std::shared_ptr<ObjectMaker>> makerCls(mod, "ObjectMaker");
60  makerCls.def(py::init<>());
61  makerCls.def("__call__", &ObjectMaker::operator());
62  makerCls.def("__reduce__",
63  [makerCls](ObjectMaker const &self) { return py::make_tuple(makerCls, py::tuple()); });
64 
65  py::class_<Object, std::shared_ptr<Object>> cls(mod, "Object");
66 
67  cls.def_static("fromString", &Object::fromString);
68  // do not wrap fromAstObject because it uses a bare AST pointer
69 
70  cls.def("__str__", &Object::getClassName);
71  cls.def("__repr__", [](Object const &self) { return "astshim." + self.getClassName(); });
72  cls.def("__eq__", &Object::operator==, py::is_operator());
73  cls.def("__ne__", &Object::operator!=, py::is_operator());
74 
75  cls.def_property_readonly("className", &Object::getClassName);
76  cls.def_property("id", &Object::getID, &Object::setID);
77  cls.def_property("ident", &Object::getIdent, &Object::setIdent);
78  cls.def_property_readonly("objSize", &Object::getObjSize);
79  cls.def_property("useDefs", &Object::getUseDefs, &Object::setUseDefs);
80 
81  cls.def("copy", &Object::copy);
82  cls.def("clear", &Object::clear, "attrib"_a);
83  cls.def("hasAttribute", &Object::hasAttribute, "attrib"_a);
84  cls.def("getNObject", &Object::getNObject);
85  cls.def("getRefCount", &Object::getRefCount);
86  cls.def("lock", &Object::lock, "wait"_a);
87  cls.def("same", &Object::same, "other"_a);
88  // do not wrap the ostream version of show, since there is no obvious Python equivalent to ostream
89  cls.def("show", py::overload_cast<bool>(&Object::show, py::const_), "showComments"_a = true);
90 
91  cls.def("test", &Object::test, "attrib"_a);
92  cls.def("unlock", &Object::unlock, "report"_a = false);
93  // do not wrap getRawPtr, since it returns a bare AST pointer
94 
95  // add pickling support
96  cls.def("__reduce__", [makerCls](Object const &self) {
97  std::string state = self.show(false);
98  auto unpickleArgs = py::make_tuple(state);
99  return py::make_tuple(makerCls(), unpickleArgs);
100  });
101 }
102 
103 } // namespace
104 } // namespace ast
Channel provides input/output of AST objects.
Definition: Channel.h:60
String-based source and sink for channels.
Definition: Stream.h:180
std::string getClassName(AstObject const *rawObj)
Get the AST class name, changing CmpMap to SeriesMap or ParallelMap as appropriate.
Definition: utils.cc:37
AST wrapper classes and functions.
PYBIND11_MODULE(_cameraGeom, mod)
Definition: _cameraGeom.cc:38
def show(frame=None)
Definition: ds9.py:88