Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/google/protobuf/internal/builder.py: 87%

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 

9This file is only called in python generated _pb2.py files. It builds 

10descriptors, message classes and services that users can directly use 

11in generated code. 

12""" 

13 

14__author__ = 'jieluo@google.com (Jie Luo)' 

15 

16from google.protobuf import message as _message 

17from google.protobuf import reflection as _reflection 

18from google.protobuf import symbol_database as _symbol_database 

19from google.protobuf.internal import enum_type_wrapper 

20from google.protobuf.internal import python_message 

21 

22_sym_db = _symbol_database.Default() 

23 

24 

25def _BuildNestedDescriptors(module, 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(module, nested_msg, module_name + '_') 

30 for enum_des in msg_des.enum_types: 

31 module[prefix + enum_des.name.upper()] = enum_des 

32 

33 

34def BuildMessageAndEnumDescriptors(file_des, module): 

35 """Builds message and enum descriptors. 

36 

37 Args: 

38 file_des: FileDescriptor of the .proto file 

39 module: Generated _pb2 module 

40 """ 

41 for name, msg_des in file_des.message_types_by_name.items(): 

42 module_name = '_' + name.upper() 

43 module[module_name] = msg_des 

44 _BuildNestedDescriptors(module, msg_des, module_name + '_') 

45 

46 

47def _BuildMessage(module_name, msg_des, prefix): 

48 create_dict = {} 

49 for name, nested_msg in msg_des.nested_types_by_name.items(): 

50 create_dict[name] = _BuildMessage( 

51 module_name, nested_msg, prefix + msg_des.name + '.' 

52 ) 

53 create_dict['DESCRIPTOR'] = msg_des 

54 create_dict['__module__'] = module_name 

55 create_dict['__qualname__'] = prefix + msg_des.name 

56 message_class = _reflection.GeneratedProtocolMessageType( 

57 msg_des.name, (_message.Message,), create_dict 

58 ) 

59 _sym_db.RegisterMessage(message_class) 

60 return message_class 

61 

62 

63def BuildTopDescriptorsAndMessages(file_des, module_name, module): 

64 """Builds top level descriptors and message classes. 

65 

66 Args: 

67 file_des: FileDescriptor of the .proto file 

68 module_name: str, the name of generated _pb2 module 

69 module: Generated _pb2 module 

70 """ 

71 

72 # top level enums 

73 for name, enum_des in file_des.enum_types_by_name.items(): 

74 module['_' + name.upper()] = enum_des 

75 module[name] = enum_type_wrapper.EnumTypeWrapper(enum_des) 

76 for enum_value in enum_des.values: 

77 module[enum_value.name] = enum_value.number 

78 

79 # top level extensions 

80 for name, extension_des in file_des.extensions_by_name.items(): 

81 module[name.upper() + '_FIELD_NUMBER'] = extension_des.number 

82 module[name] = extension_des 

83 

84 # services 

85 for name, service in file_des.services_by_name.items(): 

86 module['_' + name.upper()] = service 

87 

88 # Build messages. 

89 for name, msg_des in file_des.message_types_by_name.items(): 

90 module[name] = _BuildMessage(module_name, msg_des, '') 

91 

92 

93def AddHelpersToExtensions(file_des): 

94 """no-op to keep old generated code work with new runtime. 

95 

96 Args: 

97 file_des: FileDescriptor of the .proto file 

98 """ 

99 # TODO: Remove this on-op 

100 return 

101 

102 

103def BuildServices(file_des, module_name, module): 

104 """Builds services classes and services stub class. 

105 

106 Args: 

107 file_des: FileDescriptor of the .proto file 

108 module_name: str, the name of generated _pb2 module 

109 module: Generated _pb2 module 

110 """ 

111 # pylint: disable=g-import-not-at-top 

112 from google.protobuf import service_reflection 

113 # pylint: enable=g-import-not-at-top 

114 for name, service in file_des.services_by_name.items(): 

115 module[name] = service_reflection.GeneratedServiceType( 

116 name, (), dict(DESCRIPTOR=service, __module__=module_name) 

117 ) 

118 stub_name = name + '_Stub' 

119 module[stub_name] = service_reflection.GeneratedServiceStubType( 

120 stub_name, 

121 (module[name],), 

122 dict(DESCRIPTOR=service, __module__=module_name), 

123 )