LSSTApplications  21.0.0+75b29a8a7f,21.0.0+e70536a077,21.0.0-1-ga51b5d4+62c747d40b,21.0.0-11-ga6ea59e8e+47cba9fc36,21.0.0-2-g103fe59+914993bf7c,21.0.0-2-g1367e85+e2614ded12,21.0.0-2-g45278ab+e70536a077,21.0.0-2-g4bc9b9f+7b2b5f8678,21.0.0-2-g5242d73+e2614ded12,21.0.0-2-g54e2caa+6403186824,21.0.0-2-g7f82c8f+3ac4acbffc,21.0.0-2-g8dde007+04a6aea1af,21.0.0-2-g8f08a60+9402881886,21.0.0-2-ga326454+3ac4acbffc,21.0.0-2-ga63a54e+81dd751046,21.0.0-2-gc738bc1+5f65c6e7a9,21.0.0-2-gde069b7+26c92b3210,21.0.0-2-gecfae73+0993ddc9bd,21.0.0-2-gfc62afb+e2614ded12,21.0.0-21-gba890a8+5a4f502a26,21.0.0-23-g9966ff26+03098d1af8,21.0.0-3-g357aad2+8ad216c477,21.0.0-3-g4be5c26+e2614ded12,21.0.0-3-g6d51c4a+4d2fe0280d,21.0.0-3-g7d9da8d+75b29a8a7f,21.0.0-3-gaa929c8+522e0f12c2,21.0.0-3-ge02ed75+4d2fe0280d,21.0.0-4-g3300ddd+e70536a077,21.0.0-4-gc004bbf+eac6615e82,21.0.0-4-gccdca77+f94adcd104,21.0.0-4-gd1c1571+18b81799f9,21.0.0-5-g7b47fff+4d2fe0280d,21.0.0-5-gb155db7+d2632f662b,21.0.0-5-gdf36809+637e4641ee,21.0.0-6-g722ad07+28c848f42a,21.0.0-7-g959bb79+522e0f12c2,21.0.0-7-gfd72ab2+cf01990774,21.0.0-9-g87fb7b8d+e2ab11cdd6,w.2021.04
LSSTDataManagementBasePackage
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
std::string
STL class.
std::shared_ptr
STL class.
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
ast::Channel
Channel provides input/output of AST objects.
Definition: Channel.h:60
Channel.h
ast::detail::getClassName
std::string getClassName(AstObject const *rawObj)
Get the AST class name, changing CmpMap to SeriesMap or ParallelMap as appropriate.
Definition: utils.cc:37
ast::StringStream
String-based source and sink for channels.
Definition: Stream.h:180
base.h
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
pybind11
Definition: _GenericMap.cc:40
lsst::afw.display.ds9.show
def show(frame=None)
Definition: ds9.py:89
Object.h
lsst::afw::cameraGeom::PYBIND11_MODULE
PYBIND11_MODULE(camera, mod)
Definition: camera.cc:133
Stream.h