LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
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>
24
25#include "astshim/Stream.h"
26#include "astshim/Channel.h"
27#include "astshim/Object.h"
28
29namespace py = pybind11;
30using namespace pybind11::literals;
31
32namespace ast {
33namespace {
34
35/*
36Make an Object from a string output by Object.show()
37
38Used to support pickling Object and all of its subclasses
39
40Note: I would prefer to use a function but defining the obvious function
41and returning that as the first item of Object.__reduce__ resulted in
42Python rejecting it, claiming the function was not pickleable. I know how
43to make a class pickleable, I don't know how to make a function pickleable.
44*/
45class ObjectMaker {
46public:
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
57void wrapObject(lsst::utils::python::WrapperCollection &wrappers) {
58 using PyObjectMaker = py::class_<ObjectMaker, std::shared_ptr<ObjectMaker>>;
59 static auto makerCls = wrappers.wrapType(PyObjectMaker(wrappers.module, "ObjectMaker"), [](auto &mod, auto &cls) {
60 cls.def(py::init<>());
61 cls.def("__call__", &ObjectMaker::operator());
62 cls.def("__reduce__",
63 [cls](ObjectMaker const &self) { return py::make_tuple(cls, py::tuple()); });
64 });
65
66 using PyObject = py::class_<Object, std::shared_ptr<Object>>;
67 wrappers.wrapType(PyObject(wrappers.module, "Object"), [](auto &mod, auto &cls) {
68 cls.def_static("fromString", &Object::fromString);
69 // do not wrap fromAstObject because it uses a bare AST pointer
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__", [](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
104} // namespace ast
Channel provides input/output of AST objects.
Definition Channel.h:60
void lock(bool wait)
Lock this object for exclusive use by the calling thread.
Definition Object.h:202
void show(std::ostream &os, bool showComments=true) const
Print a textual description the object to an ostream.
Definition Object.cc:158
bool same(Object const &other) const
Does this contain the same AST object as another?
Definition Object.h:212
std::shared_ptr< Object > copy() const
Return a deep copy of this object.
Definition Object.h:109
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition Object.h:139
bool test(std::string const &attrib) const
Has this attribute been explicitly set (and not subsequently cleared)?
Definition Object.h:250
bool getUseDefs() const
Get UseDefs: allow use of default values for Object attributes?
Definition Object.h:166
void setID(std::string const &id)
Set ID: object identification string that is not copied.
Definition Object.h:215
std::string getID() const
Get ID: object identification string that is not copied.
Definition Object.h:142
void clear(std::string const &attrib)
Clear the values of a specified set of attributes for an Object.
Definition Object.h:119
static std::shared_ptr< Object > fromString(std::string const &str)
Construct an Object from a string, using astFromString.
Definition Object.h:88
void unlock(bool report=false)
Unlock this object previously locked using lock, so that other threads can use this object.
Definition Object.h:280
std::string getIdent() const
Get Ident: object identification string that is copied.
Definition Object.h:145
int getObjSize() const
Get ObjSize: the in-memory size of the AST object in bytes.
Definition Object.h:156
int getNObject() const
Get NObject: number of AST objects in existence of the same type as the underlying AST class.
Definition Object.h:153
void setIdent(std::string const &ident)
Set Ident: object identification string that is copied.
Definition Object.h:218
bool hasAttribute(std::string const &attrib) const
Does this object have an attribute with the specified name?
Definition Object.h:127
void setUseDefs(bool usedefs)
Set UseDefs: allow use of default values for Object attributes?
Definition Object.h:221
int getRefCount() const
Get RefCount: number of active pointers to the underlying AST object.
Definition Object.h:163
String-based source and sink for channels.
Definition Stream.h:180
AST wrapper classes and functions.
void wrapObject(WrapperCollection &)