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

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 

8"""Builds descriptors, message classes and services for generated _pb2.py. 

9 

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

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

12in generated code. 

13""" 

14 

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

16 

17from google.protobuf.internal import enum_type_wrapper 

18from google.protobuf.internal import python_message 

19from google.protobuf import message as _message 

20from google.protobuf import reflection as _reflection 

21from google.protobuf import symbol_database as _symbol_database 

22 

23_sym_db = _symbol_database.Default() 

24 

25 

26def _BuildNestedDescriptors(module, msg_des, prefix): 

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

28 module_name = prefix + name.upper() 

29 module[module_name] = nested_msg 

30 _BuildNestedDescriptors(module, nested_msg, module_name + '_') 

31 for enum_des in msg_des.enum_types: 

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

33 

34 

35def BuildMessageAndEnumDescriptors(file_des, module): 

36 """Builds message and enum descriptors. 

37 

38 Args: 

39 file_des: FileDescriptor of the .proto file 

40 module: Generated _pb2 module 

41 """ 

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

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

44 module[module_name] = msg_des 

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

46 

47 

48def _BuildMessage(module_name, msg_des, prefix): 

49 create_dict = {} 

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

51 create_dict[name] = _BuildMessage( 

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

53 ) 

54 create_dict['DESCRIPTOR'] = msg_des 

55 create_dict['__module__'] = module_name 

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

57 message_class = _reflection.GeneratedProtocolMessageType( 

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

59 ) 

60 _sym_db.RegisterMessage(message_class) 

61 return message_class 

62 

63 

64def BuildTopDescriptorsAndMessages(file_des, module_name, module): 

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

66 

67 Args: 

68 file_des: FileDescriptor of the .proto file 

69 module_name: str, the name of generated _pb2 module 

70 module: Generated _pb2 module 

71 """ 

72 

73 # top level enums 

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

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

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

77 for enum_value in enum_des.values: 

78 module[enum_value.name] = enum_value.number 

79 

80 # top level extensions 

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

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

83 module[name] = extension_des 

84 

85 # services 

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

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

88 

89 # Build messages. 

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

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

92 

93 

94def AddHelpersToExtensions(file_des): 

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

96 

97 Args: 

98 file_des: FileDescriptor of the .proto file 

99 """ 

100 # TODO: Remove this on-op 

101 return 

102 

103 

104def BuildServices(file_des, module_name, module): 

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

106 

107 Args: 

108 file_des: FileDescriptor of the .proto file 

109 module_name: str, the name of generated _pb2 module 

110 module: Generated _pb2 module 

111 """ 

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

113 from google.protobuf import service_reflection 

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

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

116 module[name] = service_reflection.GeneratedServiceType( 

117 name, (), 

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

119 stub_name = name + '_Stub' 

120 module[stub_name] = service_reflection.GeneratedServiceStubType( 

121 stub_name, (module[name],), 

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