Public Member Functions | Static Public Attributes | Private Member Functions | Static Private Attributes | List of all members
google.protobuf.message.Message Class Reference
Inheritance diagram for google.protobuf.message.Message:
Inheritance graph
[legend]

Public Member Functions

def __deepcopy__ (self, memo=None)
 
def __eq__ (self, other_msg)
 
def __getstate__ (self)
 
def __hash__ (self)
 
def __ne__ (self, other_msg)
 
def __setstate__ (self, state)
 
def __str__ (self)
 
def __unicode__ (self)
 
def ByteSize (self)
 
def Clear (self)
 
def ClearExtension (self, extension_handle)
 
def ClearField (self, field_name)
 
def CopyFrom (self, other_msg)
 
def DiscardUnknownFields (self)
 
def HasExtension (self, extension_handle)
 
def HasField (self, field_name)
 
def IsInitialized (self)
 
def ListFields (self)
 
def MergeFrom (self, other_msg)
 
def MergeFromString (self, serialized)
 
def ParseFromString (self, serialized)
 
def SerializePartialToString (self, **kwargs)
 
def SerializeToString (self, **kwargs)
 
def SetInParent (self)
 
def UnknownFields (self)
 
def WhichOneof (self, oneof_group)
 

Static Public Attributes

 DESCRIPTOR = None
 

Private Member Functions

def _SetListener (self, message_listener)
 

Static Private Attributes

list __slots__ = []
 

Detailed Description

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol
compiler.  These generated types subclass Message and implement the methods
shown below.

TODO(robinson): Link to an HTML document here.

TODO(robinson): Document that instances of this class will also
have an Extensions attribute with __getitem__ and __setitem__.
Again, not sure how to best convey this.

TODO(robinson): Document that the class must also have a static
  RegisterExtension(extension_field) method.
  Not sure how to best express at this point.

Definition at line 44 of file message.py.

Member Function Documentation

◆ __deepcopy__()

def google.protobuf.message.Message.__deepcopy__ (   self,
  memo = None 
)

Definition at line 69 of file message.py.

◆ __eq__()

def google.protobuf.message.Message.__eq__ (   self,
  other_msg 
) 
Recursively compares two messages by value and structure.

Definition at line 74 of file message.py.

◆ __getstate__()

def google.protobuf.message.Message.__getstate__ (   self) 
Support the pickle protocol.

Definition at line 307 of file message.py.

◆ __hash__()

def google.protobuf.message.Message.__hash__ (   self)

Definition at line 82 of file message.py.

◆ __ne__()

def google.protobuf.message.Message.__ne__ (   self,
  other_msg 
)

Definition at line 78 of file message.py.

◆ __setstate__()

def google.protobuf.message.Message.__setstate__ (   self,
  state 
) 
Support the pickle protocol.

Definition at line 311 of file message.py.

◆ __str__()

def google.protobuf.message.Message.__str__ (   self) 
Outputs a human-readable representation of the message.

Definition at line 85 of file message.py.

◆ __unicode__()

def google.protobuf.message.Message.__unicode__ (   self) 
Outputs a human-readable representation of the message.

Definition at line 89 of file message.py.

◆ _SetListener()

def google.protobuf.message.Message._SetListener (   self,
  message_listener 
)
private 
Internal method used by the protocol message implementation.
Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to
parents at runtime, for the purpose of setting "has" bits and
byte-size-dirty bits in the parent and ancestor objects whenever a child or
descendant object is modified.

If the client wants to disconnect this Message from the object tree, she
explicitly sets callback to None.

If message_listener is None, unregisters any existing listener.  Otherwise,
message_listener must implement the MessageListener interface in
internal/message_listener.py, and we discard any listener registered
via a previous _SetListener() call.

Definition at line 286 of file message.py.

◆ ByteSize()

def google.protobuf.message.Message.ByteSize (   self) 
Returns the serialized size of this message.
Recursively calls ByteSize() on all contained messages.

Definition at line 280 of file message.py.

◆ Clear()

def google.protobuf.message.Message.Clear (   self) 
Clears all data that was set in the message.

Definition at line 120 of file message.py.

◆ ClearExtension()

def google.protobuf.message.Message.ClearExtension (   self,
  extension_handle 
)

Definition at line 270 of file message.py.

◆ ClearField()

def google.protobuf.message.Message.ClearField (   self,
  field_name 
) 
Clears the contents of a given field, or the field set inside a oneof
group.  If the name neither refers to a defined field or oneof group,
ValueError is raised.

Definition at line 255 of file message.py.

◆ CopyFrom()

def google.protobuf.message.Message.CopyFrom (   self,
  other_msg 
) 
Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified
message using MergeFrom.

Args:
  other_msg: Message to copy into the current one.

Definition at line 106 of file message.py.

◆ DiscardUnknownFields()

def google.protobuf.message.Message.DiscardUnknownFields (   self)

Definition at line 277 of file message.py.

◆ HasExtension()

def google.protobuf.message.Message.HasExtension (   self,
  extension_handle 
)

Definition at line 267 of file message.py.

◆ HasField()

def google.protobuf.message.Message.HasField (   self,
  field_name 
) 
Checks if a certain field is set for the message, or if any field inside
a oneof group is set.  Note that if the field_name is not defined in the
message descriptor, ValueError will be raised.

Definition at line 249 of file message.py.

◆ IsInitialized()

def google.protobuf.message.Message.IsInitialized (   self) 
Checks if the message is initialized.

Returns:
  The method returns True if the message is initialized (i.e. all of its
  required fields are set).

Definition at line 133 of file message.py.

◆ ListFields()

def google.protobuf.message.Message.ListFields (   self) 
Returns a list of (FieldDescriptor, value) tuples for all
fields in the message which are not empty.  A message field is
non-empty if HasField() would return true. A singular primitive field
is non-empty if HasField() would return true in proto2 or it is non zero
in proto3. A repeated field is non-empty if it contains at least one
element.  The fields are ordered by field number

Definition at line 240 of file message.py.

◆ MergeFrom()

def google.protobuf.message.Message.MergeFrom (   self,
  other_msg 
) 
Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current
message. Singular fields that are set in the specified message overwrite
the corresponding fields in the current message. Repeated fields are
appended. Singular sub-messages and groups are recursively merged.

Args:
  other_msg: Message to merge into the current message.

Definition at line 93 of file message.py.

◆ MergeFromString()

def google.protobuf.message.Message.MergeFromString (   self,
  serialized 
) 
Merges serialized protocol buffer data into this message.

When we find a field in |serialized| that is already present
in this message:
  - If it's a "repeated" field, we append to the end of our list.
  - Else, if it's a scalar, we overwrite our field.
  - Else, (it's a nonrepeated composite), we recursively merge
into the existing composite.

TODO(robinson): Document handling of unknown fields.

Args:
  serialized: Any object that allows us to call buffer(serialized)
to access a string of bytes using the buffer interface.

TODO(robinson): When we switch to a helper, this will return None.

Returns:
  The number of bytes read from |serialized|.
  For non-group messages, this will always be len(serialized),
  but for messages which are actually groups, this will
  generally be less than len(serialized), since we must
  stop when we reach an END_GROUP tag.  Note that if
  we *do* stop because of an END_GROUP tag, the number
  of bytes returned does not include the bytes
  for the END_GROUP tag information.

Raises:
  message.DecodeError if the input cannot be parsed.

Definition at line 148 of file message.py.

◆ ParseFromString()

def google.protobuf.message.Message.ParseFromString (   self,
  serialized 
) 
Parse serialized protocol buffer data into this message.

Like MergeFromString(), except we clear the object first.

Definition at line 181 of file message.py.

◆ SerializePartialToString()

def google.protobuf.message.Message.SerializePartialToString (   self,
**  kwargs 
) 
Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the
message is initialized.

Arguments:
  **kwargs: Keyword arguments to the serialize method, accepts
the following keyword args:
deterministic: If true, requests deterministic serialization of the
  protobuf, with predictable ordering of map keys.

Returns:
  A string representation of the partial message.

Definition at line 207 of file message.py.

◆ SerializeToString()

def google.protobuf.message.Message.SerializeToString (   self,
**  kwargs 
) 
Serializes the protocol message to a binary string.

Arguments:
  **kwargs: Keyword arguments to the serialize method, accepts
the following keyword args:
deterministic: If true, requests deterministic serialization of the
  protobuf, with predictable ordering of map keys.

Returns:
  A binary string representation of the message if all of the required
  fields in the message are set (i.e. the message is initialized).

Raises:
  message.EncodeError if the message isn't initialized.

Definition at line 189 of file message.py.

◆ SetInParent()

def google.protobuf.message.Message.SetInParent (   self) 
Mark this as present in the parent.

This normally happens automatically when you assign a field of a
sub-message, but sometimes you want to make the sub-message
present while keeping it empty.  If you find yourself using this,
you may want to reconsider your design.

Definition at line 124 of file message.py.

◆ UnknownFields()

def google.protobuf.message.Message.UnknownFields (   self) 
Returns the UnknownFieldSet.

Definition at line 273 of file message.py.

◆ WhichOneof()

def google.protobuf.message.Message.WhichOneof (   self,
  oneof_group 
) 
Returns the name of the field that is set inside a oneof group, or
None if no field is set.  If no group with the given name exists, ValueError
will be raised.

Definition at line 261 of file message.py.

Member Data Documentation

◆ __slots__

list google.protobuf.message.Message.__slots__ = []
staticprivate

Definition at line 65 of file message.py.

◆ DESCRIPTOR

google.protobuf.message.Message.DESCRIPTOR = None
static

Definition at line 67 of file message.py.

The documentation for this class was generated from the following file:

libaditof
Author(s):
autogenerated on Wed May 21 2025 02:07:10