descriptor_pool_test.py 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600
  1. #! /usr/bin/env python
  2. #
  3. # Protocol Buffers - Google's data interchange format
  4. # Copyright 2008 Google Inc. All rights reserved.
  5. # https://developers.google.com/protocol-buffers/
  6. #
  7. # Redistribution and use in source and binary forms, with or without
  8. # modification, are permitted provided that the following conditions are
  9. # met:
  10. #
  11. # * Redistributions of source code must retain the above copyright
  12. # notice, this list of conditions and the following disclaimer.
  13. # * Redistributions in binary form must reproduce the above
  14. # copyright notice, this list of conditions and the following disclaimer
  15. # in the documentation and/or other materials provided with the
  16. # distribution.
  17. # * Neither the name of Google Inc. nor the names of its
  18. # contributors may be used to endorse or promote products derived from
  19. # this software without specific prior written permission.
  20. #
  21. # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22. # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23. # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24. # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25. # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26. # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27. # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28. # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29. # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30. # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31. # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32. """Tests for google.protobuf.descriptor_pool."""
  33. __author__ = 'matthewtoia@google.com (Matt Toia)'
  34. import os
  35. try:
  36. import unittest2 as unittest
  37. except ImportError:
  38. import unittest
  39. from google.protobuf import unittest_pb2
  40. from google.protobuf import descriptor_pb2
  41. from google.protobuf.internal import api_implementation
  42. from google.protobuf.internal import descriptor_pool_test1_pb2
  43. from google.protobuf.internal import descriptor_pool_test2_pb2
  44. from google.protobuf.internal import factory_test1_pb2
  45. from google.protobuf.internal import factory_test2_pb2
  46. from google.protobuf import descriptor
  47. from google.protobuf import descriptor_database
  48. from google.protobuf import descriptor_pool
  49. from google.protobuf import symbol_database
  50. class DescriptorPoolTest(unittest.TestCase):
  51. def setUp(self):
  52. self.pool = descriptor_pool.DescriptorPool()
  53. self.factory_test1_fd = descriptor_pb2.FileDescriptorProto.FromString(
  54. factory_test1_pb2.DESCRIPTOR.serialized_pb)
  55. self.factory_test2_fd = descriptor_pb2.FileDescriptorProto.FromString(
  56. factory_test2_pb2.DESCRIPTOR.serialized_pb)
  57. self.pool.Add(self.factory_test1_fd)
  58. self.pool.Add(self.factory_test2_fd)
  59. def testFindFileByName(self):
  60. name1 = 'google/protobuf/internal/factory_test1.proto'
  61. file_desc1 = self.pool.FindFileByName(name1)
  62. self.assertIsInstance(file_desc1, descriptor.FileDescriptor)
  63. self.assertEqual(name1, file_desc1.name)
  64. self.assertEqual('google.protobuf.python.internal', file_desc1.package)
  65. self.assertIn('Factory1Message', file_desc1.message_types_by_name)
  66. name2 = 'google/protobuf/internal/factory_test2.proto'
  67. file_desc2 = self.pool.FindFileByName(name2)
  68. self.assertIsInstance(file_desc2, descriptor.FileDescriptor)
  69. self.assertEqual(name2, file_desc2.name)
  70. self.assertEqual('google.protobuf.python.internal', file_desc2.package)
  71. self.assertIn('Factory2Message', file_desc2.message_types_by_name)
  72. def testFindFileByNameFailure(self):
  73. with self.assertRaises(KeyError):
  74. self.pool.FindFileByName('Does not exist')
  75. def testFindFileContainingSymbol(self):
  76. file_desc1 = self.pool.FindFileContainingSymbol(
  77. 'google.protobuf.python.internal.Factory1Message')
  78. self.assertIsInstance(file_desc1, descriptor.FileDescriptor)
  79. self.assertEqual('google/protobuf/internal/factory_test1.proto',
  80. file_desc1.name)
  81. self.assertEqual('google.protobuf.python.internal', file_desc1.package)
  82. self.assertIn('Factory1Message', file_desc1.message_types_by_name)
  83. file_desc2 = self.pool.FindFileContainingSymbol(
  84. 'google.protobuf.python.internal.Factory2Message')
  85. self.assertIsInstance(file_desc2, descriptor.FileDescriptor)
  86. self.assertEqual('google/protobuf/internal/factory_test2.proto',
  87. file_desc2.name)
  88. self.assertEqual('google.protobuf.python.internal', file_desc2.package)
  89. self.assertIn('Factory2Message', file_desc2.message_types_by_name)
  90. def testFindFileContainingSymbolFailure(self):
  91. with self.assertRaises(KeyError):
  92. self.pool.FindFileContainingSymbol('Does not exist')
  93. def testFindMessageTypeByName(self):
  94. msg1 = self.pool.FindMessageTypeByName(
  95. 'google.protobuf.python.internal.Factory1Message')
  96. self.assertIsInstance(msg1, descriptor.Descriptor)
  97. self.assertEqual('Factory1Message', msg1.name)
  98. self.assertEqual('google.protobuf.python.internal.Factory1Message',
  99. msg1.full_name)
  100. self.assertEqual(None, msg1.containing_type)
  101. nested_msg1 = msg1.nested_types[0]
  102. self.assertEqual('NestedFactory1Message', nested_msg1.name)
  103. self.assertEqual(msg1, nested_msg1.containing_type)
  104. nested_enum1 = msg1.enum_types[0]
  105. self.assertEqual('NestedFactory1Enum', nested_enum1.name)
  106. self.assertEqual(msg1, nested_enum1.containing_type)
  107. self.assertEqual(nested_msg1, msg1.fields_by_name[
  108. 'nested_factory_1_message'].message_type)
  109. self.assertEqual(nested_enum1, msg1.fields_by_name[
  110. 'nested_factory_1_enum'].enum_type)
  111. msg2 = self.pool.FindMessageTypeByName(
  112. 'google.protobuf.python.internal.Factory2Message')
  113. self.assertIsInstance(msg2, descriptor.Descriptor)
  114. self.assertEqual('Factory2Message', msg2.name)
  115. self.assertEqual('google.protobuf.python.internal.Factory2Message',
  116. msg2.full_name)
  117. self.assertIsNone(msg2.containing_type)
  118. nested_msg2 = msg2.nested_types[0]
  119. self.assertEqual('NestedFactory2Message', nested_msg2.name)
  120. self.assertEqual(msg2, nested_msg2.containing_type)
  121. nested_enum2 = msg2.enum_types[0]
  122. self.assertEqual('NestedFactory2Enum', nested_enum2.name)
  123. self.assertEqual(msg2, nested_enum2.containing_type)
  124. self.assertEqual(nested_msg2, msg2.fields_by_name[
  125. 'nested_factory_2_message'].message_type)
  126. self.assertEqual(nested_enum2, msg2.fields_by_name[
  127. 'nested_factory_2_enum'].enum_type)
  128. self.assertTrue(msg2.fields_by_name['int_with_default'].has_default_value)
  129. self.assertEqual(
  130. 1776, msg2.fields_by_name['int_with_default'].default_value)
  131. self.assertTrue(
  132. msg2.fields_by_name['double_with_default'].has_default_value)
  133. self.assertEqual(
  134. 9.99, msg2.fields_by_name['double_with_default'].default_value)
  135. self.assertTrue(
  136. msg2.fields_by_name['string_with_default'].has_default_value)
  137. self.assertEqual(
  138. 'hello world', msg2.fields_by_name['string_with_default'].default_value)
  139. self.assertTrue(msg2.fields_by_name['bool_with_default'].has_default_value)
  140. self.assertFalse(msg2.fields_by_name['bool_with_default'].default_value)
  141. self.assertTrue(msg2.fields_by_name['enum_with_default'].has_default_value)
  142. self.assertEqual(
  143. 1, msg2.fields_by_name['enum_with_default'].default_value)
  144. msg3 = self.pool.FindMessageTypeByName(
  145. 'google.protobuf.python.internal.Factory2Message.NestedFactory2Message')
  146. self.assertEqual(nested_msg2, msg3)
  147. self.assertTrue(msg2.fields_by_name['bytes_with_default'].has_default_value)
  148. self.assertEqual(
  149. b'a\xfb\x00c',
  150. msg2.fields_by_name['bytes_with_default'].default_value)
  151. self.assertEqual(1, len(msg2.oneofs))
  152. self.assertEqual(1, len(msg2.oneofs_by_name))
  153. self.assertEqual(2, len(msg2.oneofs[0].fields))
  154. for name in ['oneof_int', 'oneof_string']:
  155. self.assertEqual(msg2.oneofs[0],
  156. msg2.fields_by_name[name].containing_oneof)
  157. self.assertIn(msg2.fields_by_name[name], msg2.oneofs[0].fields)
  158. def testFindMessageTypeByNameFailure(self):
  159. with self.assertRaises(KeyError):
  160. self.pool.FindMessageTypeByName('Does not exist')
  161. def testFindEnumTypeByName(self):
  162. enum1 = self.pool.FindEnumTypeByName(
  163. 'google.protobuf.python.internal.Factory1Enum')
  164. self.assertIsInstance(enum1, descriptor.EnumDescriptor)
  165. self.assertEqual(0, enum1.values_by_name['FACTORY_1_VALUE_0'].number)
  166. self.assertEqual(1, enum1.values_by_name['FACTORY_1_VALUE_1'].number)
  167. nested_enum1 = self.pool.FindEnumTypeByName(
  168. 'google.protobuf.python.internal.Factory1Message.NestedFactory1Enum')
  169. self.assertIsInstance(nested_enum1, descriptor.EnumDescriptor)
  170. self.assertEqual(
  171. 0, nested_enum1.values_by_name['NESTED_FACTORY_1_VALUE_0'].number)
  172. self.assertEqual(
  173. 1, nested_enum1.values_by_name['NESTED_FACTORY_1_VALUE_1'].number)
  174. enum2 = self.pool.FindEnumTypeByName(
  175. 'google.protobuf.python.internal.Factory2Enum')
  176. self.assertIsInstance(enum2, descriptor.EnumDescriptor)
  177. self.assertEqual(0, enum2.values_by_name['FACTORY_2_VALUE_0'].number)
  178. self.assertEqual(1, enum2.values_by_name['FACTORY_2_VALUE_1'].number)
  179. nested_enum2 = self.pool.FindEnumTypeByName(
  180. 'google.protobuf.python.internal.Factory2Message.NestedFactory2Enum')
  181. self.assertIsInstance(nested_enum2, descriptor.EnumDescriptor)
  182. self.assertEqual(
  183. 0, nested_enum2.values_by_name['NESTED_FACTORY_2_VALUE_0'].number)
  184. self.assertEqual(
  185. 1, nested_enum2.values_by_name['NESTED_FACTORY_2_VALUE_1'].number)
  186. def testFindEnumTypeByNameFailure(self):
  187. with self.assertRaises(KeyError):
  188. self.pool.FindEnumTypeByName('Does not exist')
  189. def testUserDefinedDB(self):
  190. db = descriptor_database.DescriptorDatabase()
  191. self.pool = descriptor_pool.DescriptorPool(db)
  192. db.Add(self.factory_test1_fd)
  193. db.Add(self.factory_test2_fd)
  194. self.testFindMessageTypeByName()
  195. def testAddSerializedFile(self):
  196. db = descriptor_database.DescriptorDatabase()
  197. self.pool = descriptor_pool.DescriptorPool(db)
  198. self.pool.AddSerializedFile(self.factory_test1_fd.SerializeToString())
  199. self.pool.AddSerializedFile(self.factory_test2_fd.SerializeToString())
  200. self.testFindMessageTypeByName()
  201. def testComplexNesting(self):
  202. test1_desc = descriptor_pb2.FileDescriptorProto.FromString(
  203. descriptor_pool_test1_pb2.DESCRIPTOR.serialized_pb)
  204. test2_desc = descriptor_pb2.FileDescriptorProto.FromString(
  205. descriptor_pool_test2_pb2.DESCRIPTOR.serialized_pb)
  206. self.pool.Add(test1_desc)
  207. self.pool.Add(test2_desc)
  208. TEST1_FILE.CheckFile(self, self.pool)
  209. TEST2_FILE.CheckFile(self, self.pool)
  210. def testEnumDefaultValue(self):
  211. """Test the default value of enums which don't start at zero."""
  212. def _CheckDefaultValue(file_descriptor):
  213. default_value = (file_descriptor
  214. .message_types_by_name['DescriptorPoolTest1']
  215. .fields_by_name['nested_enum']
  216. .default_value)
  217. self.assertEqual(default_value,
  218. descriptor_pool_test1_pb2.DescriptorPoolTest1.BETA)
  219. # First check what the generated descriptor contains.
  220. _CheckDefaultValue(descriptor_pool_test1_pb2.DESCRIPTOR)
  221. # Then check the generated pool. Normally this is the same descriptor.
  222. file_descriptor = symbol_database.Default().pool.FindFileByName(
  223. 'google/protobuf/internal/descriptor_pool_test1.proto')
  224. self.assertIs(file_descriptor, descriptor_pool_test1_pb2.DESCRIPTOR)
  225. _CheckDefaultValue(file_descriptor)
  226. # Then check the dynamic pool and its internal DescriptorDatabase.
  227. descriptor_proto = descriptor_pb2.FileDescriptorProto.FromString(
  228. descriptor_pool_test1_pb2.DESCRIPTOR.serialized_pb)
  229. self.pool.Add(descriptor_proto)
  230. # And do the same check as above
  231. file_descriptor = self.pool.FindFileByName(
  232. 'google/protobuf/internal/descriptor_pool_test1.proto')
  233. _CheckDefaultValue(file_descriptor)
  234. class ProtoFile(object):
  235. def __init__(self, name, package, messages, dependencies=None):
  236. self.name = name
  237. self.package = package
  238. self.messages = messages
  239. self.dependencies = dependencies or []
  240. def CheckFile(self, test, pool):
  241. file_desc = pool.FindFileByName(self.name)
  242. test.assertEqual(self.name, file_desc.name)
  243. test.assertEqual(self.package, file_desc.package)
  244. dependencies_names = [f.name for f in file_desc.dependencies]
  245. test.assertEqual(self.dependencies, dependencies_names)
  246. for name, msg_type in self.messages.items():
  247. msg_type.CheckType(test, None, name, file_desc)
  248. class EnumType(object):
  249. def __init__(self, values):
  250. self.values = values
  251. def CheckType(self, test, msg_desc, name, file_desc):
  252. enum_desc = msg_desc.enum_types_by_name[name]
  253. test.assertEqual(name, enum_desc.name)
  254. expected_enum_full_name = '.'.join([msg_desc.full_name, name])
  255. test.assertEqual(expected_enum_full_name, enum_desc.full_name)
  256. test.assertEqual(msg_desc, enum_desc.containing_type)
  257. test.assertEqual(file_desc, enum_desc.file)
  258. for index, (value, number) in enumerate(self.values):
  259. value_desc = enum_desc.values_by_name[value]
  260. test.assertEqual(value, value_desc.name)
  261. test.assertEqual(index, value_desc.index)
  262. test.assertEqual(number, value_desc.number)
  263. test.assertEqual(enum_desc, value_desc.type)
  264. test.assertIn(value, msg_desc.enum_values_by_name)
  265. class MessageType(object):
  266. def __init__(self, type_dict, field_list, is_extendable=False,
  267. extensions=None):
  268. self.type_dict = type_dict
  269. self.field_list = field_list
  270. self.is_extendable = is_extendable
  271. self.extensions = extensions or []
  272. def CheckType(self, test, containing_type_desc, name, file_desc):
  273. if containing_type_desc is None:
  274. desc = file_desc.message_types_by_name[name]
  275. expected_full_name = '.'.join([file_desc.package, name])
  276. else:
  277. desc = containing_type_desc.nested_types_by_name[name]
  278. expected_full_name = '.'.join([containing_type_desc.full_name, name])
  279. test.assertEqual(name, desc.name)
  280. test.assertEqual(expected_full_name, desc.full_name)
  281. test.assertEqual(containing_type_desc, desc.containing_type)
  282. test.assertEqual(desc.file, file_desc)
  283. test.assertEqual(self.is_extendable, desc.is_extendable)
  284. for name, subtype in self.type_dict.items():
  285. subtype.CheckType(test, desc, name, file_desc)
  286. for index, (name, field) in enumerate(self.field_list):
  287. field.CheckField(test, desc, name, index)
  288. for index, (name, field) in enumerate(self.extensions):
  289. field.CheckField(test, desc, name, index)
  290. class EnumField(object):
  291. def __init__(self, number, type_name, default_value):
  292. self.number = number
  293. self.type_name = type_name
  294. self.default_value = default_value
  295. def CheckField(self, test, msg_desc, name, index):
  296. field_desc = msg_desc.fields_by_name[name]
  297. enum_desc = msg_desc.enum_types_by_name[self.type_name]
  298. test.assertEqual(name, field_desc.name)
  299. expected_field_full_name = '.'.join([msg_desc.full_name, name])
  300. test.assertEqual(expected_field_full_name, field_desc.full_name)
  301. test.assertEqual(index, field_desc.index)
  302. test.assertEqual(self.number, field_desc.number)
  303. test.assertEqual(descriptor.FieldDescriptor.TYPE_ENUM, field_desc.type)
  304. test.assertEqual(descriptor.FieldDescriptor.CPPTYPE_ENUM,
  305. field_desc.cpp_type)
  306. test.assertTrue(field_desc.has_default_value)
  307. test.assertEqual(enum_desc.values_by_name[self.default_value].number,
  308. field_desc.default_value)
  309. test.assertEqual(msg_desc, field_desc.containing_type)
  310. test.assertEqual(enum_desc, field_desc.enum_type)
  311. class MessageField(object):
  312. def __init__(self, number, type_name):
  313. self.number = number
  314. self.type_name = type_name
  315. def CheckField(self, test, msg_desc, name, index):
  316. field_desc = msg_desc.fields_by_name[name]
  317. field_type_desc = msg_desc.nested_types_by_name[self.type_name]
  318. test.assertEqual(name, field_desc.name)
  319. expected_field_full_name = '.'.join([msg_desc.full_name, name])
  320. test.assertEqual(expected_field_full_name, field_desc.full_name)
  321. test.assertEqual(index, field_desc.index)
  322. test.assertEqual(self.number, field_desc.number)
  323. test.assertEqual(descriptor.FieldDescriptor.TYPE_MESSAGE, field_desc.type)
  324. test.assertEqual(descriptor.FieldDescriptor.CPPTYPE_MESSAGE,
  325. field_desc.cpp_type)
  326. test.assertFalse(field_desc.has_default_value)
  327. test.assertEqual(msg_desc, field_desc.containing_type)
  328. test.assertEqual(field_type_desc, field_desc.message_type)
  329. class StringField(object):
  330. def __init__(self, number, default_value):
  331. self.number = number
  332. self.default_value = default_value
  333. def CheckField(self, test, msg_desc, name, index):
  334. field_desc = msg_desc.fields_by_name[name]
  335. test.assertEqual(name, field_desc.name)
  336. expected_field_full_name = '.'.join([msg_desc.full_name, name])
  337. test.assertEqual(expected_field_full_name, field_desc.full_name)
  338. test.assertEqual(index, field_desc.index)
  339. test.assertEqual(self.number, field_desc.number)
  340. test.assertEqual(descriptor.FieldDescriptor.TYPE_STRING, field_desc.type)
  341. test.assertEqual(descriptor.FieldDescriptor.CPPTYPE_STRING,
  342. field_desc.cpp_type)
  343. test.assertTrue(field_desc.has_default_value)
  344. test.assertEqual(self.default_value, field_desc.default_value)
  345. class ExtensionField(object):
  346. def __init__(self, number, extended_type):
  347. self.number = number
  348. self.extended_type = extended_type
  349. def CheckField(self, test, msg_desc, name, index):
  350. field_desc = msg_desc.extensions_by_name[name]
  351. test.assertEqual(name, field_desc.name)
  352. expected_field_full_name = '.'.join([msg_desc.full_name, name])
  353. test.assertEqual(expected_field_full_name, field_desc.full_name)
  354. test.assertEqual(self.number, field_desc.number)
  355. test.assertEqual(index, field_desc.index)
  356. test.assertEqual(descriptor.FieldDescriptor.TYPE_MESSAGE, field_desc.type)
  357. test.assertEqual(descriptor.FieldDescriptor.CPPTYPE_MESSAGE,
  358. field_desc.cpp_type)
  359. test.assertFalse(field_desc.has_default_value)
  360. test.assertTrue(field_desc.is_extension)
  361. test.assertEqual(msg_desc, field_desc.extension_scope)
  362. test.assertEqual(msg_desc, field_desc.message_type)
  363. test.assertEqual(self.extended_type, field_desc.containing_type.name)
  364. class AddDescriptorTest(unittest.TestCase):
  365. def _TestMessage(self, prefix):
  366. pool = descriptor_pool.DescriptorPool()
  367. pool.AddDescriptor(unittest_pb2.TestAllTypes.DESCRIPTOR)
  368. self.assertEqual(
  369. 'protobuf_unittest.TestAllTypes',
  370. pool.FindMessageTypeByName(
  371. prefix + 'protobuf_unittest.TestAllTypes').full_name)
  372. # AddDescriptor is not recursive.
  373. with self.assertRaises(KeyError):
  374. pool.FindMessageTypeByName(
  375. prefix + 'protobuf_unittest.TestAllTypes.NestedMessage')
  376. pool.AddDescriptor(unittest_pb2.TestAllTypes.NestedMessage.DESCRIPTOR)
  377. self.assertEqual(
  378. 'protobuf_unittest.TestAllTypes.NestedMessage',
  379. pool.FindMessageTypeByName(
  380. prefix + 'protobuf_unittest.TestAllTypes.NestedMessage').full_name)
  381. # Files are implicitly also indexed when messages are added.
  382. self.assertEqual(
  383. 'google/protobuf/unittest.proto',
  384. pool.FindFileByName(
  385. 'google/protobuf/unittest.proto').name)
  386. self.assertEqual(
  387. 'google/protobuf/unittest.proto',
  388. pool.FindFileContainingSymbol(
  389. prefix + 'protobuf_unittest.TestAllTypes.NestedMessage').name)
  390. def testMessage(self):
  391. self._TestMessage('')
  392. self._TestMessage('.')
  393. def _TestEnum(self, prefix):
  394. pool = descriptor_pool.DescriptorPool()
  395. pool.AddEnumDescriptor(unittest_pb2.ForeignEnum.DESCRIPTOR)
  396. self.assertEqual(
  397. 'protobuf_unittest.ForeignEnum',
  398. pool.FindEnumTypeByName(
  399. prefix + 'protobuf_unittest.ForeignEnum').full_name)
  400. # AddEnumDescriptor is not recursive.
  401. with self.assertRaises(KeyError):
  402. pool.FindEnumTypeByName(
  403. prefix + 'protobuf_unittest.ForeignEnum.NestedEnum')
  404. pool.AddEnumDescriptor(unittest_pb2.TestAllTypes.NestedEnum.DESCRIPTOR)
  405. self.assertEqual(
  406. 'protobuf_unittest.TestAllTypes.NestedEnum',
  407. pool.FindEnumTypeByName(
  408. prefix + 'protobuf_unittest.TestAllTypes.NestedEnum').full_name)
  409. # Files are implicitly also indexed when enums are added.
  410. self.assertEqual(
  411. 'google/protobuf/unittest.proto',
  412. pool.FindFileByName(
  413. 'google/protobuf/unittest.proto').name)
  414. self.assertEqual(
  415. 'google/protobuf/unittest.proto',
  416. pool.FindFileContainingSymbol(
  417. prefix + 'protobuf_unittest.TestAllTypes.NestedEnum').name)
  418. def testEnum(self):
  419. self._TestEnum('')
  420. self._TestEnum('.')
  421. def testFile(self):
  422. pool = descriptor_pool.DescriptorPool()
  423. pool.AddFileDescriptor(unittest_pb2.DESCRIPTOR)
  424. self.assertEqual(
  425. 'google/protobuf/unittest.proto',
  426. pool.FindFileByName(
  427. 'google/protobuf/unittest.proto').name)
  428. # AddFileDescriptor is not recursive; messages and enums within files must
  429. # be explicitly registered.
  430. with self.assertRaises(KeyError):
  431. pool.FindFileContainingSymbol(
  432. 'protobuf_unittest.TestAllTypes')
  433. TEST1_FILE = ProtoFile(
  434. 'google/protobuf/internal/descriptor_pool_test1.proto',
  435. 'google.protobuf.python.internal',
  436. {
  437. 'DescriptorPoolTest1': MessageType({
  438. 'NestedEnum': EnumType([('ALPHA', 1), ('BETA', 2)]),
  439. 'NestedMessage': MessageType({
  440. 'NestedEnum': EnumType([('EPSILON', 5), ('ZETA', 6)]),
  441. 'DeepNestedMessage': MessageType({
  442. 'NestedEnum': EnumType([('ETA', 7), ('THETA', 8)]),
  443. }, [
  444. ('nested_enum', EnumField(1, 'NestedEnum', 'ETA')),
  445. ('nested_field', StringField(2, 'theta')),
  446. ]),
  447. }, [
  448. ('nested_enum', EnumField(1, 'NestedEnum', 'ZETA')),
  449. ('nested_field', StringField(2, 'beta')),
  450. ('deep_nested_message', MessageField(3, 'DeepNestedMessage')),
  451. ])
  452. }, [
  453. ('nested_enum', EnumField(1, 'NestedEnum', 'BETA')),
  454. ('nested_message', MessageField(2, 'NestedMessage')),
  455. ], is_extendable=True),
  456. 'DescriptorPoolTest2': MessageType({
  457. 'NestedEnum': EnumType([('GAMMA', 3), ('DELTA', 4)]),
  458. 'NestedMessage': MessageType({
  459. 'NestedEnum': EnumType([('IOTA', 9), ('KAPPA', 10)]),
  460. 'DeepNestedMessage': MessageType({
  461. 'NestedEnum': EnumType([('LAMBDA', 11), ('MU', 12)]),
  462. }, [
  463. ('nested_enum', EnumField(1, 'NestedEnum', 'MU')),
  464. ('nested_field', StringField(2, 'lambda')),
  465. ]),
  466. }, [
  467. ('nested_enum', EnumField(1, 'NestedEnum', 'IOTA')),
  468. ('nested_field', StringField(2, 'delta')),
  469. ('deep_nested_message', MessageField(3, 'DeepNestedMessage')),
  470. ])
  471. }, [
  472. ('nested_enum', EnumField(1, 'NestedEnum', 'GAMMA')),
  473. ('nested_message', MessageField(2, 'NestedMessage')),
  474. ]),
  475. })
  476. TEST2_FILE = ProtoFile(
  477. 'google/protobuf/internal/descriptor_pool_test2.proto',
  478. 'google.protobuf.python.internal',
  479. {
  480. 'DescriptorPoolTest3': MessageType({
  481. 'NestedEnum': EnumType([('NU', 13), ('XI', 14)]),
  482. 'NestedMessage': MessageType({
  483. 'NestedEnum': EnumType([('OMICRON', 15), ('PI', 16)]),
  484. 'DeepNestedMessage': MessageType({
  485. 'NestedEnum': EnumType([('RHO', 17), ('SIGMA', 18)]),
  486. }, [
  487. ('nested_enum', EnumField(1, 'NestedEnum', 'RHO')),
  488. ('nested_field', StringField(2, 'sigma')),
  489. ]),
  490. }, [
  491. ('nested_enum', EnumField(1, 'NestedEnum', 'PI')),
  492. ('nested_field', StringField(2, 'nu')),
  493. ('deep_nested_message', MessageField(3, 'DeepNestedMessage')),
  494. ])
  495. }, [
  496. ('nested_enum', EnumField(1, 'NestedEnum', 'XI')),
  497. ('nested_message', MessageField(2, 'NestedMessage')),
  498. ], extensions=[
  499. ('descriptor_pool_test',
  500. ExtensionField(1001, 'DescriptorPoolTest1')),
  501. ]),
  502. },
  503. dependencies=['google/protobuf/internal/descriptor_pool_test1.proto'])
  504. if __name__ == '__main__':
  505. unittest.main()