descriptor.cc 52 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476
  1. // Protocol Buffers - Google's data interchange format
  2. // Copyright 2008 Google Inc. All rights reserved.
  3. // https://developers.google.com/protocol-buffers/
  4. //
  5. // Redistribution and use in source and binary forms, with or without
  6. // modification, are permitted provided that the following conditions are
  7. // met:
  8. //
  9. // * Redistributions of source code must retain the above copyright
  10. // notice, this list of conditions and the following disclaimer.
  11. // * Redistributions in binary form must reproduce the above
  12. // copyright notice, this list of conditions and the following disclaimer
  13. // in the documentation and/or other materials provided with the
  14. // distribution.
  15. // * Neither the name of Google Inc. nor the names of its
  16. // contributors may be used to endorse or promote products derived from
  17. // this software without specific prior written permission.
  18. //
  19. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30. // Author: petar@google.com (Petar Petrov)
  31. #include <Python.h>
  32. #include <frameobject.h>
  33. #include <string>
  34. #include <google/protobuf/io/coded_stream.h>
  35. #include <google/protobuf/descriptor.pb.h>
  36. #include <google/protobuf/dynamic_message.h>
  37. #include <google/protobuf/pyext/descriptor.h>
  38. #include <google/protobuf/pyext/descriptor_containers.h>
  39. #include <google/protobuf/pyext/descriptor_pool.h>
  40. #include <google/protobuf/pyext/message.h>
  41. #include <google/protobuf/pyext/scoped_pyobject_ptr.h>
  42. #if PY_MAJOR_VERSION >= 3
  43. #define PyString_FromStringAndSize PyUnicode_FromStringAndSize
  44. #define PyString_Check PyUnicode_Check
  45. #define PyString_InternFromString PyUnicode_InternFromString
  46. #define PyInt_FromLong PyLong_FromLong
  47. #define PyInt_FromSize_t PyLong_FromSize_t
  48. #if PY_VERSION_HEX < 0x03030000
  49. #error "Python 3.0 - 3.2 are not supported."
  50. #endif
  51. #define PyString_AsStringAndSize(ob, charpp, sizep) \
  52. (PyUnicode_Check(ob)? \
  53. ((*(charpp) = PyUnicode_AsUTF8AndSize(ob, (sizep))) == NULL? -1: 0): \
  54. PyBytes_AsStringAndSize(ob, (charpp), (sizep)))
  55. #endif
  56. namespace google {
  57. namespace protobuf {
  58. namespace python {
  59. PyObject* PyString_FromCppString(const string& str) {
  60. return PyString_FromStringAndSize(str.c_str(), str.size());
  61. }
  62. // Check that the calling Python code is the global scope of a _pb2.py module.
  63. // This function is used to support the current code generated by the proto
  64. // compiler, which creates descriptors, then update some properties.
  65. // For example:
  66. // message_descriptor = Descriptor(
  67. // name='Message',
  68. // fields = [FieldDescriptor(name='field')]
  69. // message_descriptor.fields[0].containing_type = message_descriptor
  70. //
  71. // This code is still executed, but the descriptors now have no other storage
  72. // than the (const) C++ pointer, and are immutable.
  73. // So we let this code pass, by simply ignoring the new value.
  74. //
  75. // From user code, descriptors still look immutable.
  76. //
  77. // TODO(amauryfa): Change the proto2 compiler to remove the assignments, and
  78. // remove this hack.
  79. bool _CalledFromGeneratedFile(int stacklevel) {
  80. PyThreadState *state = PyThreadState_GET();
  81. if (state == NULL) {
  82. return false;
  83. }
  84. PyFrameObject* frame = state->frame;
  85. if (frame == NULL) {
  86. return false;
  87. }
  88. while (stacklevel-- > 0) {
  89. frame = frame->f_back;
  90. if (frame == NULL) {
  91. return false;
  92. }
  93. }
  94. if (frame->f_globals != frame->f_locals) {
  95. // Not at global module scope
  96. return false;
  97. }
  98. if (frame->f_code->co_filename == NULL) {
  99. return false;
  100. }
  101. char* filename;
  102. Py_ssize_t filename_size;
  103. if (PyString_AsStringAndSize(frame->f_code->co_filename,
  104. &filename, &filename_size) < 0) {
  105. // filename is not a string.
  106. PyErr_Clear();
  107. return false;
  108. }
  109. if (filename_size < 7) {
  110. // filename is too short.
  111. return false;
  112. }
  113. if (strcmp(&filename[filename_size - 7], "_pb2.py") != 0) {
  114. // Filename is not ending with _pb2.
  115. return false;
  116. }
  117. return true;
  118. }
  119. // If the calling code is not a _pb2.py file, raise AttributeError.
  120. // To be used in attribute setters.
  121. static int CheckCalledFromGeneratedFile(const char* attr_name) {
  122. if (_CalledFromGeneratedFile(0)) {
  123. return 0;
  124. }
  125. PyErr_Format(PyExc_AttributeError,
  126. "attribute is not writable: %s", attr_name);
  127. return -1;
  128. }
  129. #ifndef PyVarObject_HEAD_INIT
  130. #define PyVarObject_HEAD_INIT(type, size) PyObject_HEAD_INIT(type) size,
  131. #endif
  132. #ifndef Py_TYPE
  133. #define Py_TYPE(ob) (((PyObject*)(ob))->ob_type)
  134. #endif
  135. // Helper functions for descriptor objects.
  136. // Converts options into a Python protobuf, and cache the result.
  137. //
  138. // This is a bit tricky because options can contain extension fields defined in
  139. // the same proto file. In this case the options parsed from the serialized_pb
  140. // have unkown fields, and we need to parse them again.
  141. //
  142. // Always returns a new reference.
  143. template<class DescriptorClass>
  144. static PyObject* GetOrBuildOptions(const DescriptorClass *descriptor) {
  145. hash_map<const void*, PyObject*>* descriptor_options =
  146. GetDescriptorPool()->descriptor_options;
  147. // First search in the cache.
  148. if (descriptor_options->find(descriptor) != descriptor_options->end()) {
  149. PyObject *value = (*descriptor_options)[descriptor];
  150. Py_INCREF(value);
  151. return value;
  152. }
  153. // Build the Options object: get its Python class, and make a copy of the C++
  154. // read-only instance.
  155. const Message& options(descriptor->options());
  156. const Descriptor *message_type = options.GetDescriptor();
  157. PyObject* message_class(cdescriptor_pool::GetMessageClass(
  158. GetDescriptorPool(), message_type));
  159. if (message_class == NULL) {
  160. PyErr_Format(PyExc_TypeError, "Could not retrieve class for Options: %s",
  161. message_type->full_name().c_str());
  162. return NULL;
  163. }
  164. ScopedPyObjectPtr value(PyEval_CallObject(message_class, NULL));
  165. if (value == NULL) {
  166. return NULL;
  167. }
  168. CMessage* cmsg = reinterpret_cast<CMessage*>(value.get());
  169. const Reflection* reflection = options.GetReflection();
  170. const UnknownFieldSet& unknown_fields(reflection->GetUnknownFields(options));
  171. if (unknown_fields.empty()) {
  172. cmsg->message->CopyFrom(options);
  173. } else {
  174. // Reparse options string! XXX call cmessage::MergeFromString
  175. string serialized;
  176. options.SerializeToString(&serialized);
  177. io::CodedInputStream input(
  178. reinterpret_cast<const uint8*>(serialized.c_str()), serialized.size());
  179. input.SetExtensionRegistry(GetDescriptorPool()->pool,
  180. cmessage::GetMessageFactory());
  181. bool success = cmsg->message->MergePartialFromCodedStream(&input);
  182. if (!success) {
  183. PyErr_Format(PyExc_ValueError, "Error parsing Options message");
  184. return NULL;
  185. }
  186. }
  187. // Cache the result.
  188. Py_INCREF(value);
  189. (*GetDescriptorPool()->descriptor_options)[descriptor] = value.get();
  190. return value.release();
  191. }
  192. // Copy the C++ descriptor to a Python message.
  193. // The Python message is an instance of descriptor_pb2.DescriptorProto
  194. // or similar.
  195. template<class DescriptorProtoClass, class DescriptorClass>
  196. static PyObject* CopyToPythonProto(const DescriptorClass *descriptor,
  197. PyObject *target) {
  198. const Descriptor* self_descriptor =
  199. DescriptorProtoClass::default_instance().GetDescriptor();
  200. CMessage* message = reinterpret_cast<CMessage*>(target);
  201. if (!PyObject_TypeCheck(target, &CMessage_Type) ||
  202. message->message->GetDescriptor() != self_descriptor) {
  203. PyErr_Format(PyExc_TypeError, "Not a %s message",
  204. self_descriptor->full_name().c_str());
  205. return NULL;
  206. }
  207. cmessage::AssureWritable(message);
  208. DescriptorProtoClass* descriptor_message =
  209. static_cast<DescriptorProtoClass*>(message->message);
  210. descriptor->CopyTo(descriptor_message);
  211. Py_RETURN_NONE;
  212. }
  213. // All Descriptors classes share the same memory layout.
  214. typedef struct PyBaseDescriptor {
  215. PyObject_HEAD
  216. // Pointer to the C++ proto2 descriptor.
  217. // Like all descriptors, it is owned by the global DescriptorPool.
  218. const void* descriptor;
  219. } PyBaseDescriptor;
  220. // FileDescriptor structure "inherits" from the base descriptor.
  221. typedef struct PyFileDescriptor {
  222. PyBaseDescriptor base;
  223. // The cached version of serialized pb. Either NULL, or a Bytes string.
  224. // We own the reference.
  225. PyObject *serialized_pb;
  226. } PyFileDescriptor;
  227. namespace descriptor {
  228. // Creates or retrieve a Python descriptor of the specified type.
  229. // Objects are interned: the same descriptor will return the same object if it
  230. // was kept alive.
  231. // 'was_created' is an optional pointer to a bool, and is set to true if a new
  232. // object was allocated.
  233. // Always return a new reference.
  234. PyObject* NewInternedDescriptor(PyTypeObject* type, const void* descriptor,
  235. bool* was_created) {
  236. if (was_created) {
  237. *was_created = false;
  238. }
  239. if (descriptor == NULL) {
  240. PyErr_BadInternalCall();
  241. return NULL;
  242. }
  243. // See if the object is in the map of interned descriptors
  244. hash_map<const void*, PyObject*>::iterator it =
  245. GetDescriptorPool()->interned_descriptors->find(descriptor);
  246. if (it != GetDescriptorPool()->interned_descriptors->end()) {
  247. GOOGLE_DCHECK(Py_TYPE(it->second) == type);
  248. Py_INCREF(it->second);
  249. return it->second;
  250. }
  251. // Create a new descriptor object
  252. PyBaseDescriptor* py_descriptor = PyObject_New(
  253. PyBaseDescriptor, type);
  254. if (py_descriptor == NULL) {
  255. return NULL;
  256. }
  257. py_descriptor->descriptor = descriptor;
  258. // and cache it.
  259. GetDescriptorPool()->interned_descriptors->insert(
  260. std::make_pair(descriptor, reinterpret_cast<PyObject*>(py_descriptor)));
  261. if (was_created) {
  262. *was_created = true;
  263. }
  264. return reinterpret_cast<PyObject*>(py_descriptor);
  265. }
  266. static void Dealloc(PyBaseDescriptor* self) {
  267. // Remove from interned dictionary
  268. GetDescriptorPool()->interned_descriptors->erase(self->descriptor);
  269. Py_TYPE(self)->tp_free(reinterpret_cast<PyObject*>(self));
  270. }
  271. static PyGetSetDef Getters[] = {
  272. {NULL}
  273. };
  274. PyTypeObject PyBaseDescriptor_Type = {
  275. PyVarObject_HEAD_INIT(&PyType_Type, 0)
  276. FULL_MODULE_NAME ".DescriptorBase", // tp_name
  277. sizeof(PyBaseDescriptor), // tp_basicsize
  278. 0, // tp_itemsize
  279. (destructor)Dealloc, // tp_dealloc
  280. 0, // tp_print
  281. 0, // tp_getattr
  282. 0, // tp_setattr
  283. 0, // tp_compare
  284. 0, // tp_repr
  285. 0, // tp_as_number
  286. 0, // tp_as_sequence
  287. 0, // tp_as_mapping
  288. 0, // tp_hash
  289. 0, // tp_call
  290. 0, // tp_str
  291. 0, // tp_getattro
  292. 0, // tp_setattro
  293. 0, // tp_as_buffer
  294. Py_TPFLAGS_DEFAULT, // tp_flags
  295. "Descriptors base class", // tp_doc
  296. 0, // tp_traverse
  297. 0, // tp_clear
  298. 0, // tp_richcompare
  299. 0, // tp_weaklistoffset
  300. 0, // tp_iter
  301. 0, // tp_iternext
  302. 0, // tp_methods
  303. 0, // tp_members
  304. Getters, // tp_getset
  305. };
  306. } // namespace descriptor
  307. const void* PyDescriptor_AsVoidPtr(PyObject* obj) {
  308. if (!PyObject_TypeCheck(obj, &descriptor::PyBaseDescriptor_Type)) {
  309. PyErr_SetString(PyExc_TypeError, "Not a BaseDescriptor");
  310. return NULL;
  311. }
  312. return reinterpret_cast<PyBaseDescriptor*>(obj)->descriptor;
  313. }
  314. namespace message_descriptor {
  315. // Unchecked accessor to the C++ pointer.
  316. static const Descriptor* _GetDescriptor(PyBaseDescriptor* self) {
  317. return reinterpret_cast<const Descriptor*>(self->descriptor);
  318. }
  319. static PyObject* GetName(PyBaseDescriptor* self, void *closure) {
  320. return PyString_FromCppString(_GetDescriptor(self)->name());
  321. }
  322. static PyObject* GetFullName(PyBaseDescriptor* self, void *closure) {
  323. return PyString_FromCppString(_GetDescriptor(self)->full_name());
  324. }
  325. static PyObject* GetFile(PyBaseDescriptor *self, void *closure) {
  326. return PyFileDescriptor_FromDescriptor(_GetDescriptor(self)->file());
  327. }
  328. static PyObject* GetConcreteClass(PyBaseDescriptor* self, void *closure) {
  329. PyObject* concrete_class(cdescriptor_pool::GetMessageClass(
  330. GetDescriptorPool(), _GetDescriptor(self)));
  331. Py_XINCREF(concrete_class);
  332. return concrete_class;
  333. }
  334. static PyObject* GetFieldsByName(PyBaseDescriptor* self, void *closure) {
  335. return NewMessageFieldsByName(_GetDescriptor(self));
  336. }
  337. static PyObject* GetFieldsByNumber(PyBaseDescriptor* self, void *closure) {
  338. return NewMessageFieldsByNumber(_GetDescriptor(self));
  339. }
  340. static PyObject* GetFieldsSeq(PyBaseDescriptor* self, void *closure) {
  341. return NewMessageFieldsSeq(_GetDescriptor(self));
  342. }
  343. static PyObject* GetNestedTypesByName(PyBaseDescriptor* self, void *closure) {
  344. return NewMessageNestedTypesByName(_GetDescriptor(self));
  345. }
  346. static PyObject* GetNestedTypesSeq(PyBaseDescriptor* self, void *closure) {
  347. return NewMessageNestedTypesSeq(_GetDescriptor(self));
  348. }
  349. static PyObject* GetExtensionsByName(PyBaseDescriptor* self, void *closure) {
  350. return NewMessageExtensionsByName(_GetDescriptor(self));
  351. }
  352. static PyObject* GetExtensions(PyBaseDescriptor* self, void *closure) {
  353. return NewMessageExtensionsSeq(_GetDescriptor(self));
  354. }
  355. static PyObject* GetEnumsSeq(PyBaseDescriptor* self, void *closure) {
  356. return NewMessageEnumsSeq(_GetDescriptor(self));
  357. }
  358. static PyObject* GetEnumTypesByName(PyBaseDescriptor* self, void *closure) {
  359. return NewMessageEnumsByName(_GetDescriptor(self));
  360. }
  361. static PyObject* GetEnumValuesByName(PyBaseDescriptor* self, void *closure) {
  362. return NewMessageEnumValuesByName(_GetDescriptor(self));
  363. }
  364. static PyObject* GetOneofsByName(PyBaseDescriptor* self, void *closure) {
  365. return NewMessageOneofsByName(_GetDescriptor(self));
  366. }
  367. static PyObject* GetOneofsSeq(PyBaseDescriptor* self, void *closure) {
  368. return NewMessageOneofsSeq(_GetDescriptor(self));
  369. }
  370. static PyObject* IsExtendable(PyBaseDescriptor *self, void *closure) {
  371. if (_GetDescriptor(self)->extension_range_count() > 0) {
  372. Py_RETURN_TRUE;
  373. } else {
  374. Py_RETURN_FALSE;
  375. }
  376. }
  377. static PyObject* GetExtensionRanges(PyBaseDescriptor *self, void *closure) {
  378. const Descriptor* descriptor = _GetDescriptor(self);
  379. PyObject* range_list = PyList_New(descriptor->extension_range_count());
  380. for (int i = 0; i < descriptor->extension_range_count(); i++) {
  381. const Descriptor::ExtensionRange* range = descriptor->extension_range(i);
  382. PyObject* start = PyInt_FromLong(range->start);
  383. PyObject* end = PyInt_FromLong(range->end);
  384. PyList_SetItem(range_list, i, PyTuple_Pack(2, start, end));
  385. }
  386. return range_list;
  387. }
  388. static PyObject* GetContainingType(PyBaseDescriptor *self, void *closure) {
  389. const Descriptor* containing_type =
  390. _GetDescriptor(self)->containing_type();
  391. if (containing_type) {
  392. return PyMessageDescriptor_FromDescriptor(containing_type);
  393. } else {
  394. Py_RETURN_NONE;
  395. }
  396. }
  397. static int SetContainingType(PyBaseDescriptor *self, PyObject *value,
  398. void *closure) {
  399. return CheckCalledFromGeneratedFile("containing_type");
  400. }
  401. static PyObject* GetHasOptions(PyBaseDescriptor *self, void *closure) {
  402. const MessageOptions& options(_GetDescriptor(self)->options());
  403. if (&options != &MessageOptions::default_instance()) {
  404. Py_RETURN_TRUE;
  405. } else {
  406. Py_RETURN_FALSE;
  407. }
  408. }
  409. static int SetHasOptions(PyBaseDescriptor *self, PyObject *value,
  410. void *closure) {
  411. return CheckCalledFromGeneratedFile("has_options");
  412. }
  413. static PyObject* GetOptions(PyBaseDescriptor *self) {
  414. return GetOrBuildOptions(_GetDescriptor(self));
  415. }
  416. static int SetOptions(PyBaseDescriptor *self, PyObject *value,
  417. void *closure) {
  418. return CheckCalledFromGeneratedFile("_options");
  419. }
  420. static PyObject* CopyToProto(PyBaseDescriptor *self, PyObject *target) {
  421. return CopyToPythonProto<DescriptorProto>(_GetDescriptor(self), target);
  422. }
  423. static PyObject* EnumValueName(PyBaseDescriptor *self, PyObject *args) {
  424. const char *enum_name;
  425. int number;
  426. if (!PyArg_ParseTuple(args, "si", &enum_name, &number))
  427. return NULL;
  428. const EnumDescriptor *enum_type =
  429. _GetDescriptor(self)->FindEnumTypeByName(enum_name);
  430. if (enum_type == NULL) {
  431. PyErr_SetString(PyExc_KeyError, enum_name);
  432. return NULL;
  433. }
  434. const EnumValueDescriptor *enum_value =
  435. enum_type->FindValueByNumber(number);
  436. if (enum_value == NULL) {
  437. PyErr_Format(PyExc_KeyError, "%d", number);
  438. return NULL;
  439. }
  440. return PyString_FromCppString(enum_value->name());
  441. }
  442. static PyObject* GetSyntax(PyBaseDescriptor *self, void *closure) {
  443. return PyString_InternFromString(
  444. FileDescriptor::SyntaxName(_GetDescriptor(self)->file()->syntax()));
  445. }
  446. static PyGetSetDef Getters[] = {
  447. { "name", (getter)GetName, NULL, "Last name"},
  448. { "full_name", (getter)GetFullName, NULL, "Full name"},
  449. { "_concrete_class", (getter)GetConcreteClass, NULL, "concrete class"},
  450. { "file", (getter)GetFile, NULL, "File descriptor"},
  451. { "fields", (getter)GetFieldsSeq, NULL, "Fields sequence"},
  452. { "fields_by_name", (getter)GetFieldsByName, NULL, "Fields by name"},
  453. { "fields_by_number", (getter)GetFieldsByNumber, NULL, "Fields by number"},
  454. { "nested_types", (getter)GetNestedTypesSeq, NULL, "Nested types sequence"},
  455. { "nested_types_by_name", (getter)GetNestedTypesByName, NULL,
  456. "Nested types by name"},
  457. { "extensions", (getter)GetExtensions, NULL, "Extensions Sequence"},
  458. { "extensions_by_name", (getter)GetExtensionsByName, NULL,
  459. "Extensions by name"},
  460. { "extension_ranges", (getter)GetExtensionRanges, NULL, "Extension ranges"},
  461. { "enum_types", (getter)GetEnumsSeq, NULL, "Enum sequence"},
  462. { "enum_types_by_name", (getter)GetEnumTypesByName, NULL,
  463. "Enum types by name"},
  464. { "enum_values_by_name", (getter)GetEnumValuesByName, NULL,
  465. "Enum values by name"},
  466. { "oneofs_by_name", (getter)GetOneofsByName, NULL, "Oneofs by name"},
  467. { "oneofs", (getter)GetOneofsSeq, NULL, "Oneofs by name"},
  468. { "containing_type", (getter)GetContainingType, (setter)SetContainingType,
  469. "Containing type"},
  470. { "is_extendable", (getter)IsExtendable, (setter)NULL},
  471. { "has_options", (getter)GetHasOptions, (setter)SetHasOptions, "Has Options"},
  472. { "_options", (getter)NULL, (setter)SetOptions, "Options"},
  473. { "syntax", (getter)GetSyntax, (setter)NULL, "Syntax"},
  474. {NULL}
  475. };
  476. static PyMethodDef Methods[] = {
  477. { "GetOptions", (PyCFunction)GetOptions, METH_NOARGS, },
  478. { "CopyToProto", (PyCFunction)CopyToProto, METH_O, },
  479. { "EnumValueName", (PyCFunction)EnumValueName, METH_VARARGS, },
  480. {NULL}
  481. };
  482. } // namespace message_descriptor
  483. PyTypeObject PyMessageDescriptor_Type = {
  484. PyVarObject_HEAD_INIT(&PyType_Type, 0)
  485. FULL_MODULE_NAME ".MessageDescriptor", // tp_name
  486. sizeof(PyBaseDescriptor), // tp_basicsize
  487. 0, // tp_itemsize
  488. 0, // tp_dealloc
  489. 0, // tp_print
  490. 0, // tp_getattr
  491. 0, // tp_setattr
  492. 0, // tp_compare
  493. 0, // tp_repr
  494. 0, // tp_as_number
  495. 0, // tp_as_sequence
  496. 0, // tp_as_mapping
  497. 0, // tp_hash
  498. 0, // tp_call
  499. 0, // tp_str
  500. 0, // tp_getattro
  501. 0, // tp_setattro
  502. 0, // tp_as_buffer
  503. Py_TPFLAGS_DEFAULT, // tp_flags
  504. "A Message Descriptor", // tp_doc
  505. 0, // tp_traverse
  506. 0, // tp_clear
  507. 0, // tp_richcompare
  508. 0, // tp_weaklistoffset
  509. 0, // tp_iter
  510. 0, // tp_iternext
  511. message_descriptor::Methods, // tp_methods
  512. 0, // tp_members
  513. message_descriptor::Getters, // tp_getset
  514. &descriptor::PyBaseDescriptor_Type, // tp_base
  515. };
  516. PyObject* PyMessageDescriptor_FromDescriptor(
  517. const Descriptor* message_descriptor) {
  518. return descriptor::NewInternedDescriptor(
  519. &PyMessageDescriptor_Type, message_descriptor, NULL);
  520. }
  521. const Descriptor* PyMessageDescriptor_AsDescriptor(PyObject* obj) {
  522. if (!PyObject_TypeCheck(obj, &PyMessageDescriptor_Type)) {
  523. PyErr_SetString(PyExc_TypeError, "Not a MessageDescriptor");
  524. return NULL;
  525. }
  526. return reinterpret_cast<const Descriptor*>(
  527. reinterpret_cast<PyBaseDescriptor*>(obj)->descriptor);
  528. }
  529. namespace field_descriptor {
  530. // Unchecked accessor to the C++ pointer.
  531. static const FieldDescriptor* _GetDescriptor(
  532. PyBaseDescriptor *self) {
  533. return reinterpret_cast<const FieldDescriptor*>(self->descriptor);
  534. }
  535. static PyObject* GetFullName(PyBaseDescriptor* self, void *closure) {
  536. return PyString_FromCppString(_GetDescriptor(self)->full_name());
  537. }
  538. static PyObject* GetName(PyBaseDescriptor *self, void *closure) {
  539. return PyString_FromCppString(_GetDescriptor(self)->name());
  540. }
  541. static PyObject* GetType(PyBaseDescriptor *self, void *closure) {
  542. return PyInt_FromLong(_GetDescriptor(self)->type());
  543. }
  544. static PyObject* GetCppType(PyBaseDescriptor *self, void *closure) {
  545. return PyInt_FromLong(_GetDescriptor(self)->cpp_type());
  546. }
  547. static PyObject* GetLabel(PyBaseDescriptor *self, void *closure) {
  548. return PyInt_FromLong(_GetDescriptor(self)->label());
  549. }
  550. static PyObject* GetNumber(PyBaseDescriptor *self, void *closure) {
  551. return PyInt_FromLong(_GetDescriptor(self)->number());
  552. }
  553. static PyObject* GetIndex(PyBaseDescriptor *self, void *closure) {
  554. return PyInt_FromLong(_GetDescriptor(self)->index());
  555. }
  556. static PyObject* GetID(PyBaseDescriptor *self, void *closure) {
  557. return PyLong_FromVoidPtr(self);
  558. }
  559. static PyObject* IsExtension(PyBaseDescriptor *self, void *closure) {
  560. return PyBool_FromLong(_GetDescriptor(self)->is_extension());
  561. }
  562. static PyObject* HasDefaultValue(PyBaseDescriptor *self, void *closure) {
  563. return PyBool_FromLong(_GetDescriptor(self)->has_default_value());
  564. }
  565. static PyObject* GetDefaultValue(PyBaseDescriptor *self, void *closure) {
  566. PyObject *result;
  567. switch (_GetDescriptor(self)->cpp_type()) {
  568. case FieldDescriptor::CPPTYPE_INT32: {
  569. int32 value = _GetDescriptor(self)->default_value_int32();
  570. result = PyInt_FromLong(value);
  571. break;
  572. }
  573. case FieldDescriptor::CPPTYPE_INT64: {
  574. int64 value = _GetDescriptor(self)->default_value_int64();
  575. result = PyLong_FromLongLong(value);
  576. break;
  577. }
  578. case FieldDescriptor::CPPTYPE_UINT32: {
  579. uint32 value = _GetDescriptor(self)->default_value_uint32();
  580. result = PyInt_FromSize_t(value);
  581. break;
  582. }
  583. case FieldDescriptor::CPPTYPE_UINT64: {
  584. uint64 value = _GetDescriptor(self)->default_value_uint64();
  585. result = PyLong_FromUnsignedLongLong(value);
  586. break;
  587. }
  588. case FieldDescriptor::CPPTYPE_FLOAT: {
  589. float value = _GetDescriptor(self)->default_value_float();
  590. result = PyFloat_FromDouble(value);
  591. break;
  592. }
  593. case FieldDescriptor::CPPTYPE_DOUBLE: {
  594. double value = _GetDescriptor(self)->default_value_double();
  595. result = PyFloat_FromDouble(value);
  596. break;
  597. }
  598. case FieldDescriptor::CPPTYPE_BOOL: {
  599. bool value = _GetDescriptor(self)->default_value_bool();
  600. result = PyBool_FromLong(value);
  601. break;
  602. }
  603. case FieldDescriptor::CPPTYPE_STRING: {
  604. string value = _GetDescriptor(self)->default_value_string();
  605. result = ToStringObject(_GetDescriptor(self), value);
  606. break;
  607. }
  608. case FieldDescriptor::CPPTYPE_ENUM: {
  609. const EnumValueDescriptor* value =
  610. _GetDescriptor(self)->default_value_enum();
  611. result = PyInt_FromLong(value->number());
  612. break;
  613. }
  614. default:
  615. PyErr_Format(PyExc_NotImplementedError, "default value for %s",
  616. _GetDescriptor(self)->full_name().c_str());
  617. return NULL;
  618. }
  619. return result;
  620. }
  621. static PyObject* GetCDescriptor(PyObject *self, void *closure) {
  622. Py_INCREF(self);
  623. return self;
  624. }
  625. static PyObject *GetEnumType(PyBaseDescriptor *self, void *closure) {
  626. const EnumDescriptor* enum_type = _GetDescriptor(self)->enum_type();
  627. if (enum_type) {
  628. return PyEnumDescriptor_FromDescriptor(enum_type);
  629. } else {
  630. Py_RETURN_NONE;
  631. }
  632. }
  633. static int SetEnumType(PyBaseDescriptor *self, PyObject *value, void *closure) {
  634. return CheckCalledFromGeneratedFile("enum_type");
  635. }
  636. static PyObject *GetMessageType(PyBaseDescriptor *self, void *closure) {
  637. const Descriptor* message_type = _GetDescriptor(self)->message_type();
  638. if (message_type) {
  639. return PyMessageDescriptor_FromDescriptor(message_type);
  640. } else {
  641. Py_RETURN_NONE;
  642. }
  643. }
  644. static int SetMessageType(PyBaseDescriptor *self, PyObject *value,
  645. void *closure) {
  646. return CheckCalledFromGeneratedFile("message_type");
  647. }
  648. static PyObject* GetContainingType(PyBaseDescriptor *self, void *closure) {
  649. const Descriptor* containing_type =
  650. _GetDescriptor(self)->containing_type();
  651. if (containing_type) {
  652. return PyMessageDescriptor_FromDescriptor(containing_type);
  653. } else {
  654. Py_RETURN_NONE;
  655. }
  656. }
  657. static int SetContainingType(PyBaseDescriptor *self, PyObject *value,
  658. void *closure) {
  659. return CheckCalledFromGeneratedFile("containing_type");
  660. }
  661. static PyObject* GetExtensionScope(PyBaseDescriptor *self, void *closure) {
  662. const Descriptor* extension_scope =
  663. _GetDescriptor(self)->extension_scope();
  664. if (extension_scope) {
  665. return PyMessageDescriptor_FromDescriptor(extension_scope);
  666. } else {
  667. Py_RETURN_NONE;
  668. }
  669. }
  670. static PyObject* GetContainingOneof(PyBaseDescriptor *self, void *closure) {
  671. const OneofDescriptor* containing_oneof =
  672. _GetDescriptor(self)->containing_oneof();
  673. if (containing_oneof) {
  674. return PyOneofDescriptor_FromDescriptor(containing_oneof);
  675. } else {
  676. Py_RETURN_NONE;
  677. }
  678. }
  679. static int SetContainingOneof(PyBaseDescriptor *self, PyObject *value,
  680. void *closure) {
  681. return CheckCalledFromGeneratedFile("containing_oneof");
  682. }
  683. static PyObject* GetHasOptions(PyBaseDescriptor *self, void *closure) {
  684. const FieldOptions& options(_GetDescriptor(self)->options());
  685. if (&options != &FieldOptions::default_instance()) {
  686. Py_RETURN_TRUE;
  687. } else {
  688. Py_RETURN_FALSE;
  689. }
  690. }
  691. static int SetHasOptions(PyBaseDescriptor *self, PyObject *value,
  692. void *closure) {
  693. return CheckCalledFromGeneratedFile("has_options");
  694. }
  695. static PyObject* GetOptions(PyBaseDescriptor *self) {
  696. return GetOrBuildOptions(_GetDescriptor(self));
  697. }
  698. static int SetOptions(PyBaseDescriptor *self, PyObject *value,
  699. void *closure) {
  700. return CheckCalledFromGeneratedFile("_options");
  701. }
  702. static PyGetSetDef Getters[] = {
  703. { "full_name", (getter)GetFullName, NULL, "Full name"},
  704. { "name", (getter)GetName, NULL, "Unqualified name"},
  705. { "type", (getter)GetType, NULL, "C++ Type"},
  706. { "cpp_type", (getter)GetCppType, NULL, "C++ Type"},
  707. { "label", (getter)GetLabel, NULL, "Label"},
  708. { "number", (getter)GetNumber, NULL, "Number"},
  709. { "index", (getter)GetIndex, NULL, "Index"},
  710. { "default_value", (getter)GetDefaultValue, NULL, "Default Value"},
  711. { "has_default_value", (getter)HasDefaultValue},
  712. { "is_extension", (getter)IsExtension, NULL, "ID"},
  713. { "id", (getter)GetID, NULL, "ID"},
  714. { "_cdescriptor", (getter)GetCDescriptor, NULL, "HAACK REMOVE ME"},
  715. { "message_type", (getter)GetMessageType, (setter)SetMessageType,
  716. "Message type"},
  717. { "enum_type", (getter)GetEnumType, (setter)SetEnumType, "Enum type"},
  718. { "containing_type", (getter)GetContainingType, (setter)SetContainingType,
  719. "Containing type"},
  720. { "extension_scope", (getter)GetExtensionScope, (setter)NULL,
  721. "Extension scope"},
  722. { "containing_oneof", (getter)GetContainingOneof, (setter)SetContainingOneof,
  723. "Containing oneof"},
  724. { "has_options", (getter)GetHasOptions, (setter)SetHasOptions, "Has Options"},
  725. { "_options", (getter)NULL, (setter)SetOptions, "Options"},
  726. {NULL}
  727. };
  728. static PyMethodDef Methods[] = {
  729. { "GetOptions", (PyCFunction)GetOptions, METH_NOARGS, },
  730. {NULL}
  731. };
  732. } // namespace field_descriptor
  733. PyTypeObject PyFieldDescriptor_Type = {
  734. PyVarObject_HEAD_INIT(&PyType_Type, 0)
  735. FULL_MODULE_NAME ".FieldDescriptor", // tp_name
  736. sizeof(PyBaseDescriptor), // tp_basicsize
  737. 0, // tp_itemsize
  738. 0, // tp_dealloc
  739. 0, // tp_print
  740. 0, // tp_getattr
  741. 0, // tp_setattr
  742. 0, // tp_compare
  743. 0, // tp_repr
  744. 0, // tp_as_number
  745. 0, // tp_as_sequence
  746. 0, // tp_as_mapping
  747. 0, // tp_hash
  748. 0, // tp_call
  749. 0, // tp_str
  750. 0, // tp_getattro
  751. 0, // tp_setattro
  752. 0, // tp_as_buffer
  753. Py_TPFLAGS_DEFAULT, // tp_flags
  754. "A Field Descriptor", // tp_doc
  755. 0, // tp_traverse
  756. 0, // tp_clear
  757. 0, // tp_richcompare
  758. 0, // tp_weaklistoffset
  759. 0, // tp_iter
  760. 0, // tp_iternext
  761. field_descriptor::Methods, // tp_methods
  762. 0, // tp_members
  763. field_descriptor::Getters, // tp_getset
  764. &descriptor::PyBaseDescriptor_Type, // tp_base
  765. };
  766. PyObject* PyFieldDescriptor_FromDescriptor(
  767. const FieldDescriptor* field_descriptor) {
  768. return descriptor::NewInternedDescriptor(
  769. &PyFieldDescriptor_Type, field_descriptor, NULL);
  770. }
  771. const FieldDescriptor* PyFieldDescriptor_AsDescriptor(PyObject* obj) {
  772. if (!PyObject_TypeCheck(obj, &PyFieldDescriptor_Type)) {
  773. PyErr_SetString(PyExc_TypeError, "Not a FieldDescriptor");
  774. return NULL;
  775. }
  776. return reinterpret_cast<const FieldDescriptor*>(
  777. reinterpret_cast<PyBaseDescriptor*>(obj)->descriptor);
  778. }
  779. namespace enum_descriptor {
  780. // Unchecked accessor to the C++ pointer.
  781. static const EnumDescriptor* _GetDescriptor(
  782. PyBaseDescriptor *self) {
  783. return reinterpret_cast<const EnumDescriptor*>(self->descriptor);
  784. }
  785. static PyObject* GetFullName(PyBaseDescriptor* self, void *closure) {
  786. return PyString_FromCppString(_GetDescriptor(self)->full_name());
  787. }
  788. static PyObject* GetName(PyBaseDescriptor *self, void *closure) {
  789. return PyString_FromCppString(_GetDescriptor(self)->name());
  790. }
  791. static PyObject* GetFile(PyBaseDescriptor *self, void *closure) {
  792. return PyFileDescriptor_FromDescriptor(_GetDescriptor(self)->file());
  793. }
  794. static PyObject* GetEnumvaluesByName(PyBaseDescriptor* self, void *closure) {
  795. return NewEnumValuesByName(_GetDescriptor(self));
  796. }
  797. static PyObject* GetEnumvaluesByNumber(PyBaseDescriptor* self, void *closure) {
  798. return NewEnumValuesByNumber(_GetDescriptor(self));
  799. }
  800. static PyObject* GetEnumvaluesSeq(PyBaseDescriptor* self, void *closure) {
  801. return NewEnumValuesSeq(_GetDescriptor(self));
  802. }
  803. static PyObject* GetContainingType(PyBaseDescriptor *self, void *closure) {
  804. const Descriptor* containing_type =
  805. _GetDescriptor(self)->containing_type();
  806. if (containing_type) {
  807. return PyMessageDescriptor_FromDescriptor(containing_type);
  808. } else {
  809. Py_RETURN_NONE;
  810. }
  811. }
  812. static int SetContainingType(PyBaseDescriptor *self, PyObject *value,
  813. void *closure) {
  814. return CheckCalledFromGeneratedFile("containing_type");
  815. }
  816. static PyObject* GetHasOptions(PyBaseDescriptor *self, void *closure) {
  817. const EnumOptions& options(_GetDescriptor(self)->options());
  818. if (&options != &EnumOptions::default_instance()) {
  819. Py_RETURN_TRUE;
  820. } else {
  821. Py_RETURN_FALSE;
  822. }
  823. }
  824. static int SetHasOptions(PyBaseDescriptor *self, PyObject *value,
  825. void *closure) {
  826. return CheckCalledFromGeneratedFile("has_options");
  827. }
  828. static PyObject* GetOptions(PyBaseDescriptor *self) {
  829. return GetOrBuildOptions(_GetDescriptor(self));
  830. }
  831. static int SetOptions(PyBaseDescriptor *self, PyObject *value,
  832. void *closure) {
  833. return CheckCalledFromGeneratedFile("_options");
  834. }
  835. static PyObject* CopyToProto(PyBaseDescriptor *self, PyObject *target) {
  836. return CopyToPythonProto<EnumDescriptorProto>(_GetDescriptor(self), target);
  837. }
  838. static PyMethodDef Methods[] = {
  839. { "GetOptions", (PyCFunction)GetOptions, METH_NOARGS, },
  840. { "CopyToProto", (PyCFunction)CopyToProto, METH_O, },
  841. {NULL}
  842. };
  843. static PyGetSetDef Getters[] = {
  844. { "full_name", (getter)GetFullName, NULL, "Full name"},
  845. { "name", (getter)GetName, NULL, "last name"},
  846. { "file", (getter)GetFile, NULL, "File descriptor"},
  847. { "values", (getter)GetEnumvaluesSeq, NULL, "values"},
  848. { "values_by_name", (getter)GetEnumvaluesByName, NULL,
  849. "Enum values by name"},
  850. { "values_by_number", (getter)GetEnumvaluesByNumber, NULL,
  851. "Enum values by number"},
  852. { "containing_type", (getter)GetContainingType, (setter)SetContainingType,
  853. "Containing type"},
  854. { "has_options", (getter)GetHasOptions, (setter)SetHasOptions, "Has Options"},
  855. { "_options", (getter)NULL, (setter)SetOptions, "Options"},
  856. {NULL}
  857. };
  858. } // namespace enum_descriptor
  859. PyTypeObject PyEnumDescriptor_Type = {
  860. PyVarObject_HEAD_INIT(&PyType_Type, 0)
  861. FULL_MODULE_NAME ".EnumDescriptor", // tp_name
  862. sizeof(PyBaseDescriptor), // tp_basicsize
  863. 0, // tp_itemsize
  864. 0, // tp_dealloc
  865. 0, // tp_print
  866. 0, // tp_getattr
  867. 0, // tp_setattr
  868. 0, // tp_compare
  869. 0, // tp_repr
  870. 0, // tp_as_number
  871. 0, // tp_as_sequence
  872. 0, // tp_as_mapping
  873. 0, // tp_hash
  874. 0, // tp_call
  875. 0, // tp_str
  876. 0, // tp_getattro
  877. 0, // tp_setattro
  878. 0, // tp_as_buffer
  879. Py_TPFLAGS_DEFAULT, // tp_flags
  880. "A Enum Descriptor", // tp_doc
  881. 0, // tp_traverse
  882. 0, // tp_clear
  883. 0, // tp_richcompare
  884. 0, // tp_weaklistoffset
  885. 0, // tp_iter
  886. 0, // tp_iternext
  887. enum_descriptor::Methods, // tp_getset
  888. 0, // tp_members
  889. enum_descriptor::Getters, // tp_getset
  890. &descriptor::PyBaseDescriptor_Type, // tp_base
  891. };
  892. PyObject* PyEnumDescriptor_FromDescriptor(
  893. const EnumDescriptor* enum_descriptor) {
  894. return descriptor::NewInternedDescriptor(
  895. &PyEnumDescriptor_Type, enum_descriptor, NULL);
  896. }
  897. namespace enumvalue_descriptor {
  898. // Unchecked accessor to the C++ pointer.
  899. static const EnumValueDescriptor* _GetDescriptor(
  900. PyBaseDescriptor *self) {
  901. return reinterpret_cast<const EnumValueDescriptor*>(self->descriptor);
  902. }
  903. static PyObject* GetName(PyBaseDescriptor *self, void *closure) {
  904. return PyString_FromCppString(_GetDescriptor(self)->name());
  905. }
  906. static PyObject* GetNumber(PyBaseDescriptor *self, void *closure) {
  907. return PyInt_FromLong(_GetDescriptor(self)->number());
  908. }
  909. static PyObject* GetIndex(PyBaseDescriptor *self, void *closure) {
  910. return PyInt_FromLong(_GetDescriptor(self)->index());
  911. }
  912. static PyObject* GetType(PyBaseDescriptor *self, void *closure) {
  913. return PyEnumDescriptor_FromDescriptor(_GetDescriptor(self)->type());
  914. }
  915. static PyObject* GetHasOptions(PyBaseDescriptor *self, void *closure) {
  916. const EnumValueOptions& options(_GetDescriptor(self)->options());
  917. if (&options != &EnumValueOptions::default_instance()) {
  918. Py_RETURN_TRUE;
  919. } else {
  920. Py_RETURN_FALSE;
  921. }
  922. }
  923. static int SetHasOptions(PyBaseDescriptor *self, PyObject *value,
  924. void *closure) {
  925. return CheckCalledFromGeneratedFile("has_options");
  926. }
  927. static PyObject* GetOptions(PyBaseDescriptor *self) {
  928. return GetOrBuildOptions(_GetDescriptor(self));
  929. }
  930. static int SetOptions(PyBaseDescriptor *self, PyObject *value,
  931. void *closure) {
  932. return CheckCalledFromGeneratedFile("_options");
  933. }
  934. static PyGetSetDef Getters[] = {
  935. { "name", (getter)GetName, NULL, "name"},
  936. { "number", (getter)GetNumber, NULL, "number"},
  937. { "index", (getter)GetIndex, NULL, "index"},
  938. { "type", (getter)GetType, NULL, "index"},
  939. { "has_options", (getter)GetHasOptions, (setter)SetHasOptions, "Has Options"},
  940. { "_options", (getter)NULL, (setter)SetOptions, "Options"},
  941. {NULL}
  942. };
  943. static PyMethodDef Methods[] = {
  944. { "GetOptions", (PyCFunction)GetOptions, METH_NOARGS, },
  945. {NULL}
  946. };
  947. } // namespace enumvalue_descriptor
  948. PyTypeObject PyEnumValueDescriptor_Type = {
  949. PyVarObject_HEAD_INIT(&PyType_Type, 0)
  950. FULL_MODULE_NAME ".EnumValueDescriptor", // tp_name
  951. sizeof(PyBaseDescriptor), // tp_basicsize
  952. 0, // tp_itemsize
  953. 0, // tp_dealloc
  954. 0, // tp_print
  955. 0, // tp_getattr
  956. 0, // tp_setattr
  957. 0, // tp_compare
  958. 0, // tp_repr
  959. 0, // tp_as_number
  960. 0, // tp_as_sequence
  961. 0, // tp_as_mapping
  962. 0, // tp_hash
  963. 0, // tp_call
  964. 0, // tp_str
  965. 0, // tp_getattro
  966. 0, // tp_setattro
  967. 0, // tp_as_buffer
  968. Py_TPFLAGS_DEFAULT, // tp_flags
  969. "A EnumValue Descriptor", // tp_doc
  970. 0, // tp_traverse
  971. 0, // tp_clear
  972. 0, // tp_richcompare
  973. 0, // tp_weaklistoffset
  974. 0, // tp_iter
  975. 0, // tp_iternext
  976. enumvalue_descriptor::Methods, // tp_methods
  977. 0, // tp_members
  978. enumvalue_descriptor::Getters, // tp_getset
  979. &descriptor::PyBaseDescriptor_Type, // tp_base
  980. };
  981. PyObject* PyEnumValueDescriptor_FromDescriptor(
  982. const EnumValueDescriptor* enumvalue_descriptor) {
  983. return descriptor::NewInternedDescriptor(
  984. &PyEnumValueDescriptor_Type, enumvalue_descriptor, NULL);
  985. }
  986. namespace file_descriptor {
  987. // Unchecked accessor to the C++ pointer.
  988. static const FileDescriptor* _GetDescriptor(PyFileDescriptor *self) {
  989. return reinterpret_cast<const FileDescriptor*>(self->base.descriptor);
  990. }
  991. static void Dealloc(PyFileDescriptor* self) {
  992. Py_XDECREF(self->serialized_pb);
  993. descriptor::Dealloc(&self->base);
  994. }
  995. static PyObject* GetName(PyFileDescriptor *self, void *closure) {
  996. return PyString_FromCppString(_GetDescriptor(self)->name());
  997. }
  998. static PyObject* GetPackage(PyFileDescriptor *self, void *closure) {
  999. return PyString_FromCppString(_GetDescriptor(self)->package());
  1000. }
  1001. static PyObject* GetSerializedPb(PyFileDescriptor *self, void *closure) {
  1002. PyObject *serialized_pb = self->serialized_pb;
  1003. if (serialized_pb != NULL) {
  1004. Py_INCREF(serialized_pb);
  1005. return serialized_pb;
  1006. }
  1007. FileDescriptorProto file_proto;
  1008. _GetDescriptor(self)->CopyTo(&file_proto);
  1009. string contents;
  1010. file_proto.SerializePartialToString(&contents);
  1011. self->serialized_pb = PyBytes_FromStringAndSize(
  1012. contents.c_str(), contents.size());
  1013. if (self->serialized_pb == NULL) {
  1014. return NULL;
  1015. }
  1016. Py_INCREF(self->serialized_pb);
  1017. return self->serialized_pb;
  1018. }
  1019. static PyObject* GetMessageTypesByName(PyFileDescriptor* self, void *closure) {
  1020. return NewFileMessageTypesByName(_GetDescriptor(self));
  1021. }
  1022. static PyObject* GetEnumTypesByName(PyFileDescriptor* self, void *closure) {
  1023. return NewFileEnumTypesByName(_GetDescriptor(self));
  1024. }
  1025. static PyObject* GetExtensionsByName(PyFileDescriptor* self, void *closure) {
  1026. return NewFileExtensionsByName(_GetDescriptor(self));
  1027. }
  1028. static PyObject* GetDependencies(PyFileDescriptor* self, void *closure) {
  1029. return NewFileDependencies(_GetDescriptor(self));
  1030. }
  1031. static PyObject* GetPublicDependencies(PyFileDescriptor* self, void *closure) {
  1032. return NewFilePublicDependencies(_GetDescriptor(self));
  1033. }
  1034. static PyObject* GetHasOptions(PyFileDescriptor *self, void *closure) {
  1035. const FileOptions& options(_GetDescriptor(self)->options());
  1036. if (&options != &FileOptions::default_instance()) {
  1037. Py_RETURN_TRUE;
  1038. } else {
  1039. Py_RETURN_FALSE;
  1040. }
  1041. }
  1042. static int SetHasOptions(PyFileDescriptor *self, PyObject *value,
  1043. void *closure) {
  1044. return CheckCalledFromGeneratedFile("has_options");
  1045. }
  1046. static PyObject* GetOptions(PyFileDescriptor *self) {
  1047. return GetOrBuildOptions(_GetDescriptor(self));
  1048. }
  1049. static int SetOptions(PyFileDescriptor *self, PyObject *value,
  1050. void *closure) {
  1051. return CheckCalledFromGeneratedFile("_options");
  1052. }
  1053. static PyObject* GetSyntax(PyFileDescriptor *self, void *closure) {
  1054. return PyString_InternFromString(
  1055. FileDescriptor::SyntaxName(_GetDescriptor(self)->syntax()));
  1056. }
  1057. static PyObject* CopyToProto(PyFileDescriptor *self, PyObject *target) {
  1058. return CopyToPythonProto<FileDescriptorProto>(_GetDescriptor(self), target);
  1059. }
  1060. static PyGetSetDef Getters[] = {
  1061. { "name", (getter)GetName, NULL, "name"},
  1062. { "package", (getter)GetPackage, NULL, "package"},
  1063. { "serialized_pb", (getter)GetSerializedPb},
  1064. { "message_types_by_name", (getter)GetMessageTypesByName, NULL,
  1065. "Messages by name"},
  1066. { "enum_types_by_name", (getter)GetEnumTypesByName, NULL, "Enums by name"},
  1067. { "extensions_by_name", (getter)GetExtensionsByName, NULL,
  1068. "Extensions by name"},
  1069. { "dependencies", (getter)GetDependencies, NULL, "Dependencies"},
  1070. { "public_dependencies", (getter)GetPublicDependencies, NULL, "Dependencies"},
  1071. { "has_options", (getter)GetHasOptions, (setter)SetHasOptions, "Has Options"},
  1072. { "_options", (getter)NULL, (setter)SetOptions, "Options"},
  1073. { "syntax", (getter)GetSyntax, (setter)NULL, "Syntax"},
  1074. {NULL}
  1075. };
  1076. static PyMethodDef Methods[] = {
  1077. { "GetOptions", (PyCFunction)GetOptions, METH_NOARGS, },
  1078. { "CopyToProto", (PyCFunction)CopyToProto, METH_O, },
  1079. {NULL}
  1080. };
  1081. } // namespace file_descriptor
  1082. PyTypeObject PyFileDescriptor_Type = {
  1083. PyVarObject_HEAD_INIT(&PyType_Type, 0)
  1084. FULL_MODULE_NAME ".FileDescriptor", // tp_name
  1085. sizeof(PyFileDescriptor), // tp_basicsize
  1086. 0, // tp_itemsize
  1087. (destructor)file_descriptor::Dealloc, // tp_dealloc
  1088. 0, // tp_print
  1089. 0, // tp_getattr
  1090. 0, // tp_setattr
  1091. 0, // tp_compare
  1092. 0, // tp_repr
  1093. 0, // tp_as_number
  1094. 0, // tp_as_sequence
  1095. 0, // tp_as_mapping
  1096. 0, // tp_hash
  1097. 0, // tp_call
  1098. 0, // tp_str
  1099. 0, // tp_getattro
  1100. 0, // tp_setattro
  1101. 0, // tp_as_buffer
  1102. Py_TPFLAGS_DEFAULT, // tp_flags
  1103. "A File Descriptor", // tp_doc
  1104. 0, // tp_traverse
  1105. 0, // tp_clear
  1106. 0, // tp_richcompare
  1107. 0, // tp_weaklistoffset
  1108. 0, // tp_iter
  1109. 0, // tp_iternext
  1110. file_descriptor::Methods, // tp_methods
  1111. 0, // tp_members
  1112. file_descriptor::Getters, // tp_getset
  1113. &descriptor::PyBaseDescriptor_Type, // tp_base
  1114. 0, // tp_dict
  1115. 0, // tp_descr_get
  1116. 0, // tp_descr_set
  1117. 0, // tp_dictoffset
  1118. 0, // tp_init
  1119. PyType_GenericAlloc, // tp_alloc
  1120. PyType_GenericNew, // tp_new
  1121. PyObject_Del, // tp_free
  1122. };
  1123. PyObject* PyFileDescriptor_FromDescriptor(
  1124. const FileDescriptor* file_descriptor) {
  1125. return PyFileDescriptor_FromDescriptorWithSerializedPb(file_descriptor,
  1126. NULL);
  1127. }
  1128. PyObject* PyFileDescriptor_FromDescriptorWithSerializedPb(
  1129. const FileDescriptor* file_descriptor, PyObject *serialized_pb) {
  1130. bool was_created;
  1131. PyObject* py_descriptor = descriptor::NewInternedDescriptor(
  1132. &PyFileDescriptor_Type, file_descriptor, &was_created);
  1133. if (py_descriptor == NULL) {
  1134. return NULL;
  1135. }
  1136. if (was_created) {
  1137. PyFileDescriptor* cfile_descriptor =
  1138. reinterpret_cast<PyFileDescriptor*>(py_descriptor);
  1139. Py_XINCREF(serialized_pb);
  1140. cfile_descriptor->serialized_pb = serialized_pb;
  1141. }
  1142. // TODO(amauryfa): In the case of a cached object, check that serialized_pb
  1143. // is the same as before.
  1144. return py_descriptor;
  1145. }
  1146. namespace oneof_descriptor {
  1147. // Unchecked accessor to the C++ pointer.
  1148. static const OneofDescriptor* _GetDescriptor(
  1149. PyBaseDescriptor *self) {
  1150. return reinterpret_cast<const OneofDescriptor*>(self->descriptor);
  1151. }
  1152. static PyObject* GetName(PyBaseDescriptor* self, void *closure) {
  1153. return PyString_FromCppString(_GetDescriptor(self)->name());
  1154. }
  1155. static PyObject* GetFullName(PyBaseDescriptor* self, void *closure) {
  1156. return PyString_FromCppString(_GetDescriptor(self)->full_name());
  1157. }
  1158. static PyObject* GetIndex(PyBaseDescriptor *self, void *closure) {
  1159. return PyInt_FromLong(_GetDescriptor(self)->index());
  1160. }
  1161. static PyObject* GetFields(PyBaseDescriptor* self, void *closure) {
  1162. return NewOneofFieldsSeq(_GetDescriptor(self));
  1163. }
  1164. static PyObject* GetContainingType(PyBaseDescriptor *self, void *closure) {
  1165. const Descriptor* containing_type =
  1166. _GetDescriptor(self)->containing_type();
  1167. if (containing_type) {
  1168. return PyMessageDescriptor_FromDescriptor(containing_type);
  1169. } else {
  1170. Py_RETURN_NONE;
  1171. }
  1172. }
  1173. static PyGetSetDef Getters[] = {
  1174. { "name", (getter)GetName, NULL, "Name"},
  1175. { "full_name", (getter)GetFullName, NULL, "Full name"},
  1176. { "index", (getter)GetIndex, NULL, "Index"},
  1177. { "containing_type", (getter)GetContainingType, NULL, "Containing type"},
  1178. { "fields", (getter)GetFields, NULL, "Fields"},
  1179. {NULL}
  1180. };
  1181. } // namespace oneof_descriptor
  1182. PyTypeObject PyOneofDescriptor_Type = {
  1183. PyVarObject_HEAD_INIT(&PyType_Type, 0)
  1184. FULL_MODULE_NAME ".OneofDescriptor", // tp_name
  1185. sizeof(PyBaseDescriptor), // tp_basicsize
  1186. 0, // tp_itemsize
  1187. 0, // tp_dealloc
  1188. 0, // tp_print
  1189. 0, // tp_getattr
  1190. 0, // tp_setattr
  1191. 0, // tp_compare
  1192. 0, // tp_repr
  1193. 0, // tp_as_number
  1194. 0, // tp_as_sequence
  1195. 0, // tp_as_mapping
  1196. 0, // tp_hash
  1197. 0, // tp_call
  1198. 0, // tp_str
  1199. 0, // tp_getattro
  1200. 0, // tp_setattro
  1201. 0, // tp_as_buffer
  1202. Py_TPFLAGS_DEFAULT, // tp_flags
  1203. "A Oneof Descriptor", // tp_doc
  1204. 0, // tp_traverse
  1205. 0, // tp_clear
  1206. 0, // tp_richcompare
  1207. 0, // tp_weaklistoffset
  1208. 0, // tp_iter
  1209. 0, // tp_iternext
  1210. 0, // tp_methods
  1211. 0, // tp_members
  1212. oneof_descriptor::Getters, // tp_getset
  1213. &descriptor::PyBaseDescriptor_Type, // tp_base
  1214. };
  1215. PyObject* PyOneofDescriptor_FromDescriptor(
  1216. const OneofDescriptor* oneof_descriptor) {
  1217. return descriptor::NewInternedDescriptor(
  1218. &PyOneofDescriptor_Type, oneof_descriptor, NULL);
  1219. }
  1220. // Add a enum values to a type dictionary.
  1221. static bool AddEnumValues(PyTypeObject *type,
  1222. const EnumDescriptor* enum_descriptor) {
  1223. for (int i = 0; i < enum_descriptor->value_count(); ++i) {
  1224. const EnumValueDescriptor* value = enum_descriptor->value(i);
  1225. ScopedPyObjectPtr obj(PyInt_FromLong(value->number()));
  1226. if (obj == NULL) {
  1227. return false;
  1228. }
  1229. if (PyDict_SetItemString(type->tp_dict, value->name().c_str(), obj) < 0) {
  1230. return false;
  1231. }
  1232. }
  1233. return true;
  1234. }
  1235. static bool AddIntConstant(PyTypeObject *type, const char* name, int value) {
  1236. ScopedPyObjectPtr obj(PyInt_FromLong(value));
  1237. if (PyDict_SetItemString(type->tp_dict, name, obj) < 0) {
  1238. return false;
  1239. }
  1240. return true;
  1241. }
  1242. bool InitDescriptor() {
  1243. if (PyType_Ready(&PyMessageDescriptor_Type) < 0)
  1244. return false;
  1245. if (PyType_Ready(&PyFieldDescriptor_Type) < 0)
  1246. return false;
  1247. if (!AddEnumValues(&PyFieldDescriptor_Type,
  1248. FieldDescriptorProto::Label_descriptor())) {
  1249. return false;
  1250. }
  1251. if (!AddEnumValues(&PyFieldDescriptor_Type,
  1252. FieldDescriptorProto::Type_descriptor())) {
  1253. return false;
  1254. }
  1255. #define ADD_FIELDDESC_CONSTANT(NAME) AddIntConstant( \
  1256. &PyFieldDescriptor_Type, #NAME, FieldDescriptor::NAME)
  1257. if (!ADD_FIELDDESC_CONSTANT(CPPTYPE_INT32) ||
  1258. !ADD_FIELDDESC_CONSTANT(CPPTYPE_INT64) ||
  1259. !ADD_FIELDDESC_CONSTANT(CPPTYPE_UINT32) ||
  1260. !ADD_FIELDDESC_CONSTANT(CPPTYPE_UINT64) ||
  1261. !ADD_FIELDDESC_CONSTANT(CPPTYPE_DOUBLE) ||
  1262. !ADD_FIELDDESC_CONSTANT(CPPTYPE_FLOAT) ||
  1263. !ADD_FIELDDESC_CONSTANT(CPPTYPE_BOOL) ||
  1264. !ADD_FIELDDESC_CONSTANT(CPPTYPE_ENUM) ||
  1265. !ADD_FIELDDESC_CONSTANT(CPPTYPE_STRING) ||
  1266. !ADD_FIELDDESC_CONSTANT(CPPTYPE_MESSAGE)) {
  1267. return false;
  1268. }
  1269. #undef ADD_FIELDDESC_CONSTANT
  1270. if (PyType_Ready(&PyEnumDescriptor_Type) < 0)
  1271. return false;
  1272. if (PyType_Ready(&PyEnumValueDescriptor_Type) < 0)
  1273. return false;
  1274. if (PyType_Ready(&PyFileDescriptor_Type) < 0)
  1275. return false;
  1276. if (PyType_Ready(&PyOneofDescriptor_Type) < 0)
  1277. return false;
  1278. if (!InitDescriptorMappingTypes())
  1279. return false;
  1280. return true;
  1281. }
  1282. } // namespace python
  1283. } // namespace protobuf
  1284. } // namespace google