Static Public Member Functions | |
| def | RegisterExtension (extension_handle) |
Static Public Attributes | |
| DESCRIPTOR = None | |
Private Member Functions | |
| def | _SetListener (self, message_listener) |
| 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.
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.
Definition at line 44 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
Member Function Documentation
◆ __deepcopy__() [1/2]
| def google.protobuf.message.Message.__deepcopy__ | ( | self, | |
memo = None |
|||
| ) |
Definition at line 69 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ __deepcopy__() [2/2]
| def google.protobuf.message.Message.__deepcopy__ | ( | self, | |
memo = None |
|||
| ) |
Definition at line 80 of file protobuf/python/google/protobuf/message.py.
◆ __eq__() [1/2]
| def google.protobuf.message.Message.__eq__ | ( | self, | |
| other_msg | |||
| ) |
Recursively compares two messages by value and structure.
Definition at line 74 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ __eq__() [2/2]
| def google.protobuf.message.Message.__eq__ | ( | self, | |
| other_msg | |||
| ) |
Recursively compares two messages by value and structure.
Definition at line 85 of file protobuf/python/google/protobuf/message.py.
◆ __getstate__() [1/2]
| def google.protobuf.message.Message.__getstate__ | ( | self | ) |
Support the pickle protocol.
Definition at line 307 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ __getstate__() [2/2]
| def google.protobuf.message.Message.__getstate__ | ( | self | ) |
Support the pickle protocol.
Definition at line 391 of file protobuf/python/google/protobuf/message.py.
◆ __hash__() [1/2]
| def google.protobuf.message.Message.__hash__ | ( | self | ) |
Definition at line 82 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ __hash__() [2/2]
| def google.protobuf.message.Message.__hash__ | ( | self | ) |
Definition at line 93 of file protobuf/python/google/protobuf/message.py.
◆ __ne__() [1/2]
| def google.protobuf.message.Message.__ne__ | ( | self, | |
| other_msg | |||
| ) |
Definition at line 78 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ __ne__() [2/2]
| def google.protobuf.message.Message.__ne__ | ( | self, | |
| other_msg | |||
| ) |
Definition at line 89 of file protobuf/python/google/protobuf/message.py.
◆ __reduce__()
| def google.protobuf.message.Message.__reduce__ | ( | self | ) |
Definition at line 405 of file protobuf/python/google/protobuf/message.py.
◆ __setstate__() [1/2]
| def google.protobuf.message.Message.__setstate__ | ( | self, | |
| state | |||
| ) |
Support the pickle protocol.
Definition at line 311 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ __setstate__() [2/2]
| def google.protobuf.message.Message.__setstate__ | ( | self, | |
| state | |||
| ) |
Support the pickle protocol.
Definition at line 395 of file protobuf/python/google/protobuf/message.py.
◆ __str__() [1/2]
| def google.protobuf.message.Message.__str__ | ( | self | ) |
Outputs a human-readable representation of the message.
Definition at line 85 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ __str__() [2/2]
| def google.protobuf.message.Message.__str__ | ( | self | ) |
Outputs a human-readable representation of the message.
Definition at line 96 of file protobuf/python/google/protobuf/message.py.
◆ __unicode__() [1/2]
| def google.protobuf.message.Message.__unicode__ | ( | self | ) |
Outputs a human-readable representation of the message.
Definition at line 89 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ __unicode__() [2/2]
| def google.protobuf.message.Message.__unicode__ | ( | self | ) |
Outputs a human-readable representation of the message.
Definition at line 100 of file protobuf/python/google/protobuf/message.py.
◆ _SetListener() [1/2]
|
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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ _SetListener() [2/2]
|
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 370 of file protobuf/python/google/protobuf/message.py.
◆ ByteSize() [1/2]
| 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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ ByteSize() [2/2]
| def google.protobuf.message.Message.ByteSize | ( | self | ) |
Returns the serialized size of this message. Recursively calls ByteSize() on all contained messages. Returns: int: The number of bytes required to serialize this message.
Definition at line 352 of file protobuf/python/google/protobuf/message.py.
◆ Clear() [1/2]
| def google.protobuf.message.Message.Clear | ( | self | ) |
Clears all data that was set in the message.
Definition at line 120 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ Clear() [2/2]
| def google.protobuf.message.Message.Clear | ( | self | ) |
Clears all data that was set in the message.
Definition at line 131 of file protobuf/python/google/protobuf/message.py.
◆ ClearExtension() [1/2]
| def google.protobuf.message.Message.ClearExtension | ( | self, | |
| extension_handle | |||
| ) |
Definition at line 270 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ ClearExtension() [2/2]
| def google.protobuf.message.Message.ClearExtension | ( | self, | |
| extension_handle | |||
| ) |
Clears the contents of a given extension. Args: extension_handle: The handle for the extension to clear.
Definition at line 329 of file protobuf/python/google/protobuf/message.py.
◆ ClearField() [1/2]
| 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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ ClearField() [2/2]
| def google.protobuf.message.Message.ClearField | ( | self, | |
| field_name | |||
| ) |
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: field_name (str): The name of the field to check for presence. Raises: ValueError: if the `field_name` is not a member of this message.
Definition at line 281 of file protobuf/python/google/protobuf/message.py.
◆ CopyFrom() [1/2]
| 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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ CopyFrom() [2/2]
| 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): A message to copy into the current one.
Definition at line 117 of file protobuf/python/google/protobuf/message.py.
◆ DiscardUnknownFields() [1/2]
| def google.protobuf.message.Message.DiscardUnknownFields | ( | self | ) |
Definition at line 277 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ DiscardUnknownFields() [2/2]
| def google.protobuf.message.Message.DiscardUnknownFields | ( | self | ) |
Clears all fields in the :class:`UnknownFieldSet`. This operation is recursive for nested message.
Definition at line 345 of file protobuf/python/google/protobuf/message.py.
◆ FromString()
| def google.protobuf.message.Message.FromString | ( | cls, | |
| s | |||
| ) |
Definition at line 363 of file protobuf/python/google/protobuf/message.py.
◆ HasExtension() [1/2]
| def google.protobuf.message.Message.HasExtension | ( | self, | |
| extension_handle | |||
| ) |
Definition at line 267 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ HasExtension() [2/2]
| def google.protobuf.message.Message.HasExtension | ( | self, | |
| extension_handle | |||
| ) |
Checks if a certain extension is present for this message. Extensions are retrieved using the :attr:`Extensions` mapping (if present). Args: extension_handle: The handle for the extension to check. Returns: bool: Whether the extension is present for this message. Raises: KeyError: if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a "not present" repeated extension is an empty list.
Definition at line 311 of file protobuf/python/google/protobuf/message.py.
◆ HasField() [1/2]
| 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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ HasField() [2/2]
| def google.protobuf.message.Message.HasField | ( | self, | |
| field_name | |||
| ) |
Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. Args: field_name (str): The name of the field to check for presence. Returns: bool: Whether a value has been set for the named field. Raises: ValueError: if the `field_name` is not a member of this message.
Definition at line 263 of file protobuf/python/google/protobuf/message.py.
◆ IsInitialized() [1/2]
| 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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ IsInitialized() [2/2]
| def google.protobuf.message.Message.IsInitialized | ( | self | ) |
Checks if the message is initialized. Returns: bool: The method returns True if the message is initialized (i.e. all of its required fields are set).
Definition at line 145 of file protobuf/python/google/protobuf/message.py.
◆ ListFields() [1/2]
| 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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ ListFields() [2/2]
| def google.protobuf.message.Message.ListFields | ( | self | ) |
Returns a list of (FieldDescriptor, value) tuples for present fields. 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. Returns: list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.
Definition at line 248 of file protobuf/python/google/protobuf/message.py.
◆ MergeFrom() [1/2]
| 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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ MergeFrom() [2/2]
| 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): A message to merge into the current message.
Definition at line 104 of file protobuf/python/google/protobuf/message.py.
◆ MergeFromString() [1/2]
| 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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ MergeFromString() [2/2]
| 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. Args: serialized (bytes): Any object that allows us to call ``memoryview(serialized)`` to access a string of bytes using the buffer interface. Returns: int: 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: DecodeError: if the input cannot be parsed.
Definition at line 160 of file protobuf/python/google/protobuf/message.py.
◆ ParseFromString() [1/2]
| 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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ ParseFromString() [2/2]
| def google.protobuf.message.Message.ParseFromString | ( | self, | |
| serialized | |||
| ) |
Parse serialized protocol buffer data into this message. Like :func:`MergeFromString()`, except we clear the object first.
Definition at line 193 of file protobuf/python/google/protobuf/message.py.
◆ RegisterExtension()
|
static |
Definition at line 367 of file protobuf/python/google/protobuf/message.py.
◆ SerializePartialToString() [1/2]
| 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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ SerializePartialToString() [2/2]
| 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. Keyword Args: deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys. Returns: bytes: A serialized representation of the partial message.
Definition at line 217 of file protobuf/python/google/protobuf/message.py.
◆ SerializeToString() [1/2]
| 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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ SerializeToString() [2/2]
| def google.protobuf.message.Message.SerializeToString | ( | self, | |
| ** | kwargs | ||
| ) |
Serializes the protocol message to a binary string. Keyword Args: deterministic (bool): 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: EncodeError: if the message isn't initialized (see :func:`IsInitialized`).
Definition at line 201 of file protobuf/python/google/protobuf/message.py.
◆ SetInParent() [1/2]
| 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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ SetInParent() [2/2]
| 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 135 of file protobuf/python/google/protobuf/message.py.
◆ UnknownFields() [1/2]
| def google.protobuf.message.Message.UnknownFields | ( | self | ) |
Returns the UnknownFieldSet.
Definition at line 273 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ UnknownFields() [2/2]
| def google.protobuf.message.Message.UnknownFields | ( | self | ) |
Returns the UnknownFieldSet. Returns: UnknownFieldSet: The unknown fields stored in this message.
Definition at line 337 of file protobuf/python/google/protobuf/message.py.
◆ WhichOneof() [1/2]
| 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 bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ WhichOneof() [2/2]
| def google.protobuf.message.Message.WhichOneof | ( | self, | |
| oneof_group | |||
| ) |
Returns the name of the field that is set inside a oneof group. If no field is set, returns None. Args: oneof_group (str): the name of the oneof group to check. Returns: str or None: The name of the group that is set, or None. Raises: ValueError: no group with the given name exists
Definition at line 295 of file protobuf/python/google/protobuf/message.py.
Member Data Documentation
◆ __slots__
|
staticprivate |
Definition at line 65 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
◆ DESCRIPTOR
|
static |
Definition at line 67 of file bloaty/third_party/protobuf/python/google/protobuf/message.py.
The documentation for this class was generated from the following file: