google.protobuf.message.Message Class Reference

Inheritance diagram for google.protobuf.message.Message:

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

Static Public Attributes
	DESCRIPTOR = None

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.

Member Function Documentation

__deepcopy__()

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

__eq__()

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

Recursively compares two messages by value and structure.

__getstate__()

def google.protobuf.message.Message.__getstate__

(

self

)

Support the pickle protocol.

__hash__()

def google.protobuf.message.Message.__hash__

(

self

)

__ne__()

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

__setstate__()

def google.protobuf.message.Message.__setstate__	(		self,
			state
	)

Support the pickle protocol.

__str__()

def google.protobuf.message.Message.__str__

(

self

)

Outputs a human-readable representation of the message.

__unicode__()

def google.protobuf.message.Message.__unicode__

(

self

)

Outputs a human-readable representation of the message.

ByteSize()

def google.protobuf.message.Message.ByteSize

(

self

)

Returns the serialized size of this message.
Recursively calls ByteSize() on all contained messages.

Clear()

def google.protobuf.message.Message.Clear

(

self

)

Clears all data that was set in the message.

ClearExtension()

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

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.

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.

DiscardUnknownFields()

def google.protobuf.message.Message.DiscardUnknownFields

(

self

)

HasExtension()

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

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.

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).

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 singular field is non-empty
if HasField() would return true, and a repeated field is non-empty if
it contains at least one element.  The fields are ordered by field
number

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.

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.

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 and
do not return the value that MergeFromString returns.

SerializePartialToString()

def google.protobuf.message.Message.SerializePartialToString

(

self

)

Serializes the protocol message to a binary string.

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

Returns:
  A string representation of the partial message.

SerializeToString()

def google.protobuf.message.Message.SerializeToString

(

self

)

Serializes the protocol message to a binary string.

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.

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.

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.

Member Data Documentation

DESCRIPTOR

google.protobuf.message.Message.DESCRIPTOR = None

static

---

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

• Source/ThirdParty/libwebrtc/Source/third_party/protobuf/python/google/protobuf/message.py