builder.py 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. # Protocol Buffers - Google's data interchange format
  2. # Copyright 2008 Google Inc. All rights reserved.
  3. #
  4. # Use of this source code is governed by a BSD-style
  5. # license that can be found in the LICENSE file or at
  6. # https://developers.google.com/open-source/licenses/bsd
  7. """Builds descriptors, message classes and services for generated _pb2.py.
  8. This file is only called in python generated _pb2.py files. It builds
  9. descriptors, message classes and services that users can directly use
  10. in generated code.
  11. """
  12. __author__ = 'jieluo@google.com (Jie Luo)'
  13. from google.protobuf.internal import enum_type_wrapper
  14. from google.protobuf.internal import python_message
  15. from google.protobuf import message as _message
  16. from google.protobuf import reflection as _reflection
  17. from google.protobuf import symbol_database as _symbol_database
  18. _sym_db = _symbol_database.Default()
  19. def _BuildNestedDescriptors(module, msg_des, prefix):
  20. for name, nested_msg in msg_des.nested_types_by_name.items():
  21. module_name = prefix + name.upper()
  22. module[module_name] = nested_msg
  23. _BuildNestedDescriptors(module, nested_msg, module_name + '_')
  24. for enum_des in msg_des.enum_types:
  25. module[prefix + enum_des.name.upper()] = enum_des
  26. def BuildMessageAndEnumDescriptors(file_des, module):
  27. """Builds message and enum descriptors.
  28. Args:
  29. file_des: FileDescriptor of the .proto file
  30. module: Generated _pb2 module
  31. """
  32. for (name, msg_des) in file_des.message_types_by_name.items():
  33. module_name = '_' + name.upper()
  34. module[module_name] = msg_des
  35. _BuildNestedDescriptors(module, msg_des, module_name + '_')
  36. def _BuildMessage(module_name, msg_des, prefix):
  37. create_dict = {}
  38. for name, nested_msg in msg_des.nested_types_by_name.items():
  39. create_dict[name] = _BuildMessage(
  40. module_name, nested_msg, prefix + msg_des.name + '.'
  41. )
  42. create_dict['DESCRIPTOR'] = msg_des
  43. create_dict['__module__'] = module_name
  44. create_dict['__qualname__'] = prefix + msg_des.name
  45. message_class = _reflection.GeneratedProtocolMessageType(
  46. msg_des.name, (_message.Message,), create_dict
  47. )
  48. _sym_db.RegisterMessage(message_class)
  49. return message_class
  50. def BuildTopDescriptorsAndMessages(file_des, module_name, module):
  51. """Builds top level descriptors and message classes.
  52. Args:
  53. file_des: FileDescriptor of the .proto file
  54. module_name: str, the name of generated _pb2 module
  55. module: Generated _pb2 module
  56. """
  57. # top level enums
  58. for (name, enum_des) in file_des.enum_types_by_name.items():
  59. module['_' + name.upper()] = enum_des
  60. module[name] = enum_type_wrapper.EnumTypeWrapper(enum_des)
  61. for enum_value in enum_des.values:
  62. module[enum_value.name] = enum_value.number
  63. # top level extensions
  64. for (name, extension_des) in file_des.extensions_by_name.items():
  65. module[name.upper() + '_FIELD_NUMBER'] = extension_des.number
  66. module[name] = extension_des
  67. # services
  68. for (name, service) in file_des.services_by_name.items():
  69. module['_' + name.upper()] = service
  70. # Build messages.
  71. for (name, msg_des) in file_des.message_types_by_name.items():
  72. module[name] = _BuildMessage(module_name, msg_des, '')
  73. def AddHelpersToExtensions(file_des):
  74. """no-op to keep old generated code work with new runtime.
  75. Args:
  76. file_des: FileDescriptor of the .proto file
  77. """
  78. # TODO: Remove this on-op
  79. return
  80. def BuildServices(file_des, module_name, module):
  81. """Builds services classes and services stub class.
  82. Args:
  83. file_des: FileDescriptor of the .proto file
  84. module_name: str, the name of generated _pb2 module
  85. module: Generated _pb2 module
  86. """
  87. # pylint: disable=g-import-not-at-top
  88. from google.protobuf import service_reflection
  89. # pylint: enable=g-import-not-at-top
  90. for (name, service) in file_des.services_by_name.items():
  91. module[name] = service_reflection.GeneratedServiceType(
  92. name, (),
  93. dict(DESCRIPTOR=service, __module__=module_name))
  94. stub_name = name + '_Stub'
  95. module[stub_name] = service_reflection.GeneratedServiceStubType(
  96. stub_name, (module[name],),
  97. dict(DESCRIPTOR=service, __module__=module_name))