builder.py 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  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 BuildMessageAndEnumDescriptors(file_des, module):
  20. """Builds message and enum descriptors.
  21. Args:
  22. file_des: FileDescriptor of the .proto file
  23. module: Generated _pb2 module
  24. """
  25. def BuildNestedDescriptors(msg_des, prefix):
  26. for (name, nested_msg) in msg_des.nested_types_by_name.items():
  27. module_name = prefix + name.upper()
  28. module[module_name] = nested_msg
  29. BuildNestedDescriptors(nested_msg, module_name + '_')
  30. for enum_des in msg_des.enum_types:
  31. module[prefix + enum_des.name.upper()] = enum_des
  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(msg_des, module_name + '_')
  36. def BuildTopDescriptorsAndMessages(file_des, module_name, module):
  37. """Builds top level descriptors and message classes.
  38. Args:
  39. file_des: FileDescriptor of the .proto file
  40. module_name: str, the name of generated _pb2 module
  41. module: Generated _pb2 module
  42. """
  43. def BuildMessage(msg_des, prefix):
  44. create_dict = {}
  45. for (name, nested_msg) in msg_des.nested_types_by_name.items():
  46. create_dict[name] = BuildMessage(nested_msg, prefix + msg_des.name + '.')
  47. create_dict['DESCRIPTOR'] = msg_des
  48. create_dict['__module__'] = module_name
  49. create_dict['__qualname__'] = prefix + msg_des.name
  50. message_class = _reflection.GeneratedProtocolMessageType(
  51. msg_des.name, (_message.Message,), create_dict)
  52. _sym_db.RegisterMessage(message_class)
  53. return message_class
  54. # top level enums
  55. for (name, enum_des) in file_des.enum_types_by_name.items():
  56. module['_' + name.upper()] = enum_des
  57. module[name] = enum_type_wrapper.EnumTypeWrapper(enum_des)
  58. for enum_value in enum_des.values:
  59. module[enum_value.name] = enum_value.number
  60. # top level extensions
  61. for (name, extension_des) in file_des.extensions_by_name.items():
  62. module[name.upper() + '_FIELD_NUMBER'] = extension_des.number
  63. module[name] = extension_des
  64. # services
  65. for (name, service) in file_des.services_by_name.items():
  66. module['_' + name.upper()] = service
  67. # Build messages.
  68. for (name, msg_des) in file_des.message_types_by_name.items():
  69. module[name] = BuildMessage(msg_des, '')
  70. def AddHelpersToExtensions(file_des):
  71. """no-op to keep old generated code work with new runtime.
  72. Args:
  73. file_des: FileDescriptor of the .proto file
  74. """
  75. # TODO: Remove this on-op
  76. return
  77. def BuildServices(file_des, module_name, module):
  78. """Builds services classes and services stub class.
  79. Args:
  80. file_des: FileDescriptor of the .proto file
  81. module_name: str, the name of generated _pb2 module
  82. module: Generated _pb2 module
  83. """
  84. # pylint: disable=g-import-not-at-top
  85. from google.protobuf import service_reflection
  86. # pylint: enable=g-import-not-at-top
  87. for (name, service) in file_des.services_by_name.items():
  88. module[name] = service_reflection.GeneratedServiceType(
  89. name, (),
  90. dict(DESCRIPTOR=service, __module__=module_name))
  91. stub_name = name + '_Stub'
  92. module[stub_name] = service_reflection.GeneratedServiceStubType(
  93. stub_name, (module[name],),
  94. dict(DESCRIPTOR=service, __module__=module_name))