Loading [MathJax]/extensions/tex2jax.js
LSST Applications g0d33ba9806+23fb6b1458,g0fba68d861+c03ca182fa,g1e78f5e6d3+6885d38a10,g1ec0fe41b4+f8df4a5e9d,g1fd858c14a+1f896281a9,g35bb328faa+fcb1d3bbc8,g4af146b050+32dc2822d5,g4d2262a081+2d16baa2ff,g53246c7159+fcb1d3bbc8,g5a012ec0e7+6ce3c67fb7,g60b5630c4e+23fb6b1458,g67b6fd64d1+b5a8974b5d,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g87b7deb4dc+4e9c20b633,g8852436030+17127e6d9c,g89139ef638+b5a8974b5d,g9125e01d80+fcb1d3bbc8,g94187f82dc+23fb6b1458,g989de1cb63+b5a8974b5d,g9f33ca652e+b775bc0ddd,g9f7030ddb1+0d26baa418,ga2b97cdc51+23fb6b1458,ga44b1db4f6+f3405f2437,gabe3b4be73+1e0a283bba,gabf8522325+a9d2faf463,gb1101e3267+1c10e8ebae,gb58c049af0+f03b321e39,gb89ab40317+b5a8974b5d,gcf25f946ba+17127e6d9c,gd6cbbdb0b4+ace4583378,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+551b1246a4,ge278dab8ac+fa73091e6d,ge410e46f29+b5a8974b5d,gf67bdafdda+b5a8974b5d,gfe06eef73a+62ba25d42b,v29.0.0.rc5
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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
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
Abstract base class for all AST objects.
Definition Object.h:51
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
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition python.h:242
PyType wrapType(PyType cls, ClassWrapperCallback function, bool setModuleName=true)
Add a type (class or enum) wrapper, deferring method and other attribute definitions until finish() i...
Definition python.h:391
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition python.h:448
AST wrapper classes and functions.
void wrapObject(WrapperCollection &)
Definition object.cc:57