protobuf 5.29.4__py3-none-any.whl → 6.33.3__py3-none-any.whl

google/protobuf/message.py

@@ -13,6 +13,9 @@
 
 __author__ = 'robinson@google.com (Will Robinson)'
 
+_INCONSISTENT_MESSAGE_ATTRIBUTES = ('Extensions',)
+
+
 class Error(Exception):
   """Base error type for this module."""
   pass
@@ -56,6 +59,29 @@ class Message(object):
     clone.MergeFrom(self)
     return clone
 
+  def __dir__(self):
+    """Provides the list of all accessible Message attributes."""
+    message_attributes = set(super().__dir__())
+
+    # TODO: Remove this once the UPB implementation is improved.
+    # The UPB proto implementation currently doesn't provide proto fields as
+    # attributes and they have to added.
+    if self.DESCRIPTOR is not None:
+      for field in self.DESCRIPTOR.fields:
+        message_attributes.add(field.name)
+
+    # The Fast C++ proto implementation provides inaccessible attributes that
+    # have to be removed.
+    for attribute in _INCONSISTENT_MESSAGE_ATTRIBUTES:
+      if attribute not in message_attributes:
+        continue
+      try:
+        getattr(self, attribute)
+      except AttributeError:
+        message_attributes.remove(attribute)
+
+    return sorted(message_attributes)
+
   def __eq__(self, other_msg):
     """Recursively compares two messages by value and structure."""
     raise NotImplementedError

google/protobuf/message_factory.py

@@ -56,6 +56,22 @@ def GetMessageClassesForFiles(files, pool):
   This will find and resolve dependencies, failing if the descriptor
   pool cannot satisfy them.
 
+  This will not return the classes for nested types within those classes, for
+  those, use GetMessageClass() on the nested types within their containing
+  messages.
+
+  For example, for the message:
+
+  message NestedTypeMessage {
+    message NestedType {
+      string data = 1;
+    }
+    NestedType nested = 1;
+  }
+
+  NestedTypeMessage will be in the result, but not
+  NestedTypeMessage.NestedType.
+
   Args:
     files: The file names to extract messages from.
     pool: The descriptor pool to find the files including the dependent files.
@@ -142,69 +158,6 @@ class MessageFactory(object):
     """Initializes a new factory."""
     self.pool = pool or descriptor_pool.DescriptorPool()
 
-  def GetPrototype(self, descriptor):
-    """Obtains a proto2 message class based on the passed in descriptor.
-
-    Passing a descriptor with a fully qualified name matching a previous
-    invocation will cause the same class to be returned.
-
-    Args:
-      descriptor: The descriptor to build from.
-
-    Returns:
-      A class describing the passed in descriptor.
-    """
-    warnings.warn(
-        'MessageFactory class is deprecated. Please use '
-        'GetMessageClass() instead of MessageFactory.GetPrototype. '
-        'MessageFactory class will be removed after 2024.',
-        stacklevel=2,
-    )
-    return GetMessageClass(descriptor)
-
-  def CreatePrototype(self, descriptor):
-    """Builds a proto2 message class based on the passed in descriptor.
-
-    Don't call this function directly, it always creates a new class. Call
-    GetMessageClass() instead.
-
-    Args:
-      descriptor: The descriptor to build from.
-
-    Returns:
-      A class describing the passed in descriptor.
-    """
-    warnings.warn(
-        'Directly call CreatePrototype is wrong. Please use '
-        'GetMessageClass() method instead. Directly use '
-        'CreatePrototype will raise error after July 2023.',
-        stacklevel=2,
-    )
-    return _InternalCreateMessageClass(descriptor)
-
-  def GetMessages(self, files):
-    """Gets all the messages from a specified file.
-
-    This will find and resolve dependencies, failing if the descriptor
-    pool cannot satisfy them.
-
-    Args:
-      files: The file names to extract messages from.
-
-    Returns:
-      A dictionary mapping proto names to the message classes. This will include
-      any dependent messages as well as any messages defined in the same file as
-      a specified message.
-    """
-    warnings.warn(
-        'MessageFactory class is deprecated. Please use '
-        'GetMessageClassesForFiles() instead of '
-        'MessageFactory.GetMessages(). MessageFactory class '
-        'will be removed after 2024.',
-        stacklevel=2,
-    )
-    return GetMessageClassesForFiles(files, self.pool)
-
 
 def GetMessages(file_protos, pool=None):
   """Builds a dictionary of all the messages available in a set of files.

google/protobuf/proto.py

@@ -8,7 +8,7 @@
 """Contains the Nextgen Pythonic protobuf APIs."""
 
 import io
-from typing import Type, TypeVar
+from typing import Text, Type, TypeVar
 
 from google.protobuf.internal import decoder
 from google.protobuf.internal import encoder
@@ -114,3 +114,40 @@ def parse_length_prefixed(
         '{2}.'.format(size, parsed_size, message.DESCRIPTOR.name)
     )
   return message
+
+
+def byte_size(message: Message) -> int:
+  """Returns the serialized size of this message.
+
+  Args:
+    message: A proto message.
+
+  Returns:
+    int: The number of bytes required to serialize this message.
+  """
+  return message.ByteSize()
+
+
+def clear_message(message: Message) -> None:
+  """Clears all data that was set in the message.
+
+  Args:
+    message: The proto message to be cleared.
+  """
+  message.Clear()
+
+
+def clear_field(message: Message, field_name: Text) -> None:
+  """Clears the contents of a given field.
+
+  Inside a oneof group, clears the field set. If the name neither refers to a
+  defined field or oneof group, :exc:`ValueError` is raised.
+
+  Args:
+    message: The proto message.
+    field_name (str): The name of the field to be cleared.
+
+  Raises:
+    ValueError: if the `field_name` is not a member of this message.
+  """
+  message.ClearField(field_name)

google/protobuf/proto_text.py

@@ -0,0 +1,129 @@
+# Protocol Buffers - Google's data interchange format
+# Copyright 2025 Google Inc.  All rights reserved.
+#
+# Use of this source code is governed by a BSD-style
+# license that can be found in the LICENSE file or at
+# https://developers.google.com/open-source/licenses/bsd
+
+"""Contains the Nextgen Pythonic Protobuf Text Format APIs."""
+from typing import AnyStr, Callable, Optional, Text, Type, Union
+
+from google.protobuf import text_format
+from google.protobuf.descriptor_pool import DescriptorPool
+from google.protobuf.message import Message
+
+_MsgFormatter = Callable[[Message, Union[int, bool], bool], Optional[Text]]
+
+
+def serialize(
+    message: Message,
+    as_utf8: bool = True,
+    as_one_line: bool = False,
+    use_short_repeated_primitives: bool = False,
+    pointy_brackets: bool = False,
+    use_index_order: bool = False,
+    float_format: Optional[str] = None,
+    double_format: Optional[str] = None,
+    use_field_number: bool = False,
+    descriptor_pool: Optional[DescriptorPool] = None,
+    indent: int = 0,
+    message_formatter: Optional[_MsgFormatter] = None,
+    print_unknown_fields: bool = False,
+    force_colon: bool = False,
+) -> str:
+  """Convert protobuf message to text format.
+
+  Double values can be formatted compactly with 15 digits of
+  precision (which is the most that IEEE 754 "double" can guarantee)
+  using double_format='.15g'. To ensure that converting to text and back to a
+  proto will result in an identical value, double_format='.17g' should be used.
+
+  Args:
+    message: The protocol buffers message.
+    as_utf8: Return unescaped Unicode for non-ASCII characters.
+    as_one_line: Don't introduce newlines between fields.
+    use_short_repeated_primitives: Use short repeated format for primitives.
+    pointy_brackets: If True, use angle brackets instead of curly braces for
+      nesting.
+    use_index_order: If True, fields of a proto message will be printed using
+      the order defined in source code instead of the field number, extensions
+      will be printed at the end of the message and their relative order is
+      determined by the extension number. By default, use the field number
+      order.
+    float_format (str): If set, use this to specify float field formatting (per
+      the "Format Specification Mini-Language"); otherwise, shortest float that
+      has same value in wire will be printed. Also affect double field if
+      double_format is not set but float_format is set.
+    double_format (str): If set, use this to specify double field formatting
+      (per the "Format Specification Mini-Language"); if it is not set but
+      float_format is set, use float_format. Otherwise, use ``str()``
+    use_field_number: If True, print field numbers instead of names.
+    descriptor_pool (DescriptorPool): Descriptor pool used to resolve Any types.
+    indent (int): The initial indent level, in terms of spaces, for pretty
+      print.
+    message_formatter (function(message, indent, as_one_line) -> unicode|None):
+      Custom formatter for selected sub-messages (usually based on message
+      type). Use to pretty print parts of the protobuf for easier diffing.
+    print_unknown_fields: If True, unknown fields will be printed.
+    force_colon: If set, a colon will be added after the field name even if the
+      field is a proto message.
+
+  Returns:
+    str: A string of the text formatted protocol buffer message.
+  """
+  return text_format.MessageToString(
+      message=message,
+      as_utf8=as_utf8,
+      as_one_line=as_one_line,
+      use_short_repeated_primitives=use_short_repeated_primitives,
+      pointy_brackets=pointy_brackets,
+      use_index_order=use_index_order,
+      float_format=float_format,
+      double_format=double_format,
+      use_field_number=use_field_number,
+      descriptor_pool=descriptor_pool,
+      indent=indent,
+      message_formatter=message_formatter,
+      print_unknown_fields=print_unknown_fields,
+      force_colon=force_colon,
+  )
+
+
+def parse(
+    message_class: Type[Message],
+    text: AnyStr,
+    allow_unknown_extension: bool = False,
+    allow_field_number: bool = False,
+    descriptor_pool: Optional[DescriptorPool] = None,
+    allow_unknown_field: bool = False,
+) -> Message:
+  """Parses a text representation of a protocol message into a message.
+
+  Args:
+    message_class: The message meta class.
+    text (str): Message text representation.
+    message (Message): A protocol buffer message to merge into.
+    allow_unknown_extension: if True, skip over missing extensions and keep
+      parsing
+    allow_field_number: if True, both field number and field name are allowed.
+    descriptor_pool (DescriptorPool): Descriptor pool used to resolve Any types.
+    allow_unknown_field: if True, skip over unknown field and keep parsing.
+      Avoid to use this option if possible. It may hide some errors (e.g.
+      spelling error on field name)
+
+  Returns:
+    Message: A new message passed from text.
+
+  Raises:
+    ParseError: On text parsing problems.
+  """
+  new_message = message_class()
+  text_format.Parse(
+      text=text,
+      message=new_message,
+      allow_unknown_extension=allow_unknown_extension,
+      allow_field_number=allow_field_number,
+      descriptor_pool=descriptor_pool,
+      allow_unknown_field=allow_unknown_field,
+  )
+  return new_message

google/protobuf/reflection.py

@@ -34,52 +34,3 @@ from google.protobuf import symbol_database
 GeneratedProtocolMessageType = message_factory._GENERATED_PROTOCOL_MESSAGE_TYPE
 
 MESSAGE_CLASS_CACHE = {}
-
-
-# Deprecated. Please NEVER use reflection.ParseMessage().
-def ParseMessage(descriptor, byte_str):
-  """Generate a new Message instance from this Descriptor and a byte string.
-
-  DEPRECATED: ParseMessage is deprecated because it is using MakeClass().
-  Please use MessageFactory.GetMessageClass() instead.
-
-  Args:
-    descriptor: Protobuf Descriptor object
-    byte_str: Serialized protocol buffer byte string
-
-  Returns:
-    Newly created protobuf Message object.
-  """
-  warnings.warn(
-      'reflection.ParseMessage() is deprecated. Please use '
-      'MessageFactory.GetMessageClass() and message.ParseFromString() instead. '
-      'reflection.ParseMessage() will be removed in Jan 2025.',
-      stacklevel=2,
-  )
-  result_class = MakeClass(descriptor)
-  new_msg = result_class()
-  new_msg.ParseFromString(byte_str)
-  return new_msg
-
-
-# Deprecated. Please NEVER use reflection.MakeClass().
-def MakeClass(descriptor):
-  """Construct a class object for a protobuf described by descriptor.
-
-  DEPRECATED: use MessageFactory.GetMessageClass() instead.
-
-  Args:
-    descriptor: A descriptor.Descriptor object describing the protobuf.
-  Returns:
-    The Message class object described by the descriptor.
-  """
-  warnings.warn(
-      'reflection.MakeClass() is deprecated. Please use '
-      'MessageFactory.GetMessageClass() instead. '
-      'reflection.MakeClass() will be removed in Jan 2025.',
-      stacklevel=2,
-  )
-  # Original implementation leads to duplicate message classes, which won't play
-  # well with extensions. Message factory info is also missing.
-  # Redirect to message_factory.
-  return message_factory.GetMessageClass(descriptor)

google/protobuf/runtime_version.py

@@ -27,9 +27,9 @@ class Domain(Enum):
 # the Protobuf release process. Do not edit them manually.
 # These OSS versions are not stripped to avoid merging conflicts.
 OSS_DOMAIN = Domain.PUBLIC
-OSS_MAJOR = 5
-OSS_MINOR = 29
-OSS_PATCH = 4
+OSS_MAJOR = 6
+OSS_MINOR = 33
+OSS_PATCH = 3
 OSS_SUFFIX = ''
 
 DOMAIN = OSS_DOMAIN
@@ -92,33 +92,13 @@ def ValidateProtobufRuntimeVersion(
         ' Cross-domain usage of Protobuf is not supported.'
     )
 
-  if gen_major != MAJOR:
-    if gen_major == MAJOR - 1:
-      if _warning_count < _MAX_WARNING_COUNT:
-        warnings.warn(
-            'Protobuf gencode version %s is exactly one major version older'
-            ' than the runtime version %s at %s. Please update the gencode to'
-            ' avoid compatibility violations in the next runtime release.'
-            % (gen_version, version, location)
-        )
-        _warning_count += 1
-    else:
-      _ReportVersionError(
-          'Detected mismatched Protobuf Gencode/Runtime major versions when'
-          f' loading {location}: gencode {gen_version} runtime {version}.'
-          f' Same major version is required. {error_prompt}'
-      )
-
-  if MINOR < gen_minor or (MINOR == gen_minor and PATCH < gen_patch):
+  if (
+      MAJOR < gen_major
+      or (MAJOR == gen_major and MINOR < gen_minor)
+      or (MAJOR == gen_major and MINOR == gen_minor and PATCH < gen_patch)
+  ):
     _ReportVersionError(
         'Detected incompatible Protobuf Gencode/Runtime versions when loading'
         f' {location}: gencode {gen_version} runtime {version}. Runtime version'
         f' cannot be older than the linked gencode version. {error_prompt}'
     )
-
-  if gen_suffix != SUFFIX:
-    _ReportVersionError(
-        'Detected mismatched Protobuf Gencode/Runtime version suffixes when'
-        f' loading {location}: gencode {gen_version} runtime {version}.'
-        f' Version suffixes must be the same. {error_prompt}'
-    )

google/protobuf/source_context_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: google/protobuf/source_context.proto
-# Protobuf Python Version: 5.29.4
+# Protobuf Python Version: 6.33.3
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -11,9 +11,9 @@ from google.protobuf import symbol_database as _symbol_database
 from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
-    5,
-    29,
-    4,
+    6,
+    33,
+    3,
     '',
     'google/protobuf/source_context.proto'
 )

google/protobuf/struct_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: google/protobuf/struct.proto
-# Protobuf Python Version: 5.29.4
+# Protobuf Python Version: 6.33.3
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -11,9 +11,9 @@ from google.protobuf import symbol_database as _symbol_database
 from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
-    5,
-    29,
-    4,
+    6,
+    33,
+    3,
     '',
     'google/protobuf/struct.proto'
 )

google/protobuf/symbol_database.py

@@ -51,24 +51,6 @@ class SymbolDatabase():
     """Initializes a new SymbolDatabase."""
     self.pool = pool or descriptor_pool.DescriptorPool()
 
-  def GetPrototype(self, descriptor):
-    warnings.warn('SymbolDatabase.GetPrototype() is deprecated. Please '
-                  'use message_factory.GetMessageClass() instead. '
-                  'SymbolDatabase.GetPrototype() will be removed soon.')
-    return message_factory.GetMessageClass(descriptor)
-
-  def CreatePrototype(self, descriptor):
-    warnings.warn('Directly call CreatePrototype() is wrong. Please use '
-                  'message_factory.GetMessageClass() instead. '
-                  'SymbolDatabase.CreatePrototype() will be removed soon.')
-    return message_factory._InternalCreateMessageClass(descriptor)
-
-  def GetMessages(self, files):
-    warnings.warn('SymbolDatabase.GetMessages() is deprecated. Please use '
-                  'message_factory.GetMessageClassedForFiles() instead. '
-                  'SymbolDatabase.GetMessages() will be removed soon.')
-    return message_factory.GetMessageClassedForFiles(files, self.pool)
-
   def RegisterMessage(self, message):
     """Registers the given message type in the local database.