Module Expr Str ClassDef bases NameLoad body Pass decorator_list ClassDef bases NameLoad body Pass decorator_list ClassDef bases NameLoad body Pass decorator_list ClassDef bases NameLoad body Expr Str Assign NameStore ListLoad Assign NameStore NameLoad FunctionDef arguments args NameParam NameParam defaults NameLoad body Assign NameStore Call Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Raise NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Return UnaryOpNot CompareEq NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Raise Call NameLoad Str decorator_list FunctionDef arguments args NameParam defaults body Raise NameLoad decorator_list FunctionDef arguments args NameParam defaults body Raise NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str If CompareIs NameLoad NameLoad body Return Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Raise NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Raise NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Raise NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return Call NameLoad keyword Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str decorator_list decorator_list
N/A N/A Contains an abstract base class for protocol messages. Error N/A Exception N/A N/A N/A DecodeError N/A Error N/A N/A N/A EncodeError N/A Error N/A N/A N/A Message N/A object N/A N/A 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.
   N/A __slots__ N/A N/A DESCRIPTOR None __deepcopy__ N/A N/A self memo N/A None N/A N/A clone N/A N/A type self N/A N/A N/A clone MergeFrom self N/A clone N/A __eq__ N/A N/A self other_msg N/A N/A N/A NotImplementedError N/A __ne__ N/A N/A self other_msg N/A N/A N/A N/A N/A self other_msg N/A __hash__ N/A N/A self N/A N/A N/A N/A TypeError unhashable object N/A __str__ N/A N/A self N/A N/A N/A NotImplementedError N/A __unicode__ N/A N/A self N/A N/A N/A NotImplementedError N/A MergeFrom N/A N/A self other_msg N/A N/A N/A 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.
     N/A NotImplementedError N/A CopyFrom N/A N/A self other_msg N/A N/A N/A 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.
     N/A N/A self other_msg N/A N/A N/A N/A N/A self Clear N/A N/A N/A self MergeFrom other_msg N/A Clear N/A N/A self N/A N/A N/A Clears all data that was set in the message. N/A NotImplementedError N/A SetInParent N/A N/A self N/A N/A N/A 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. N/A NotImplementedError N/A IsInitialized N/A N/A self N/A N/A N/A 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).
     N/A NotImplementedError N/A MergeFromString N/A N/A self serialized N/A N/A N/A 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.
     N/A NotImplementedError N/A ParseFromString N/A N/A self serialized N/A N/A N/A Like MergeFromString(), except we clear the object first. N/A N/A N/A self Clear N/A N/A N/A self MergeFromString serialized N/A SerializeToString N/A N/A self N/A N/A N/A 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.
     N/A NotImplementedError N/A SerializePartialToString N/A N/A self N/A N/A N/A 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.
     N/A NotImplementedError N/A ListFields N/A N/A self N/A N/A N/A 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 N/A NotImplementedError N/A HasField N/A N/A self field_name N/A N/A N/A Checks if a certain field is set for the message. Note if the
    field_name is not defined in the message descriptor, ValueError will be
    raised. N/A NotImplementedError N/A ClearField N/A N/A self field_name N/A N/A N/A NotImplementedError N/A HasExtension N/A N/A self extension_handle N/A N/A N/A NotImplementedError N/A ClearExtension N/A N/A self extension_handle N/A N/A N/A NotImplementedError N/A ByteSize N/A N/A self N/A N/A N/A Returns the serialized size of this message.
    Recursively calls ByteSize() on all contained messages.
     N/A NotImplementedError N/A _SetListener N/A N/A self message_listener N/A N/A N/A 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.
     N/A NotImplementedError N/A __getstate__ N/A N/A self N/A N/A N/A Support the pickle protocol. N/A N/A dict serialized N/A N/A self SerializePartialToString N/A __setstate__ N/A N/A self state N/A N/A N/A Support the pickle protocol. N/A N/A N/A self __init__ N/A N/A N/A self ParseFromString N/A state N/A serialized N/A N/A