3 SÉLj¾,ã@sLdZdZGdd„deƒZGdd„deƒZGdd„deƒZGdd „d eƒZd S)z6Contains an abstract base class for protocol messages.z#robinson@google.com (Will Robinson)c@seZdZdS)ÚErrorN)Ú__name__Ú __module__Ú__qualname__©rrú/usr/lib/python3.6/message.pyr'src@seZdZdS)ÚDecodeErrorN)rrrrrrrr(src@seZdZdS)ÚEncodeErrorN)rrrrrrrr)src@sêeZdZdZgZdZd7dd„Zdd„Zdd„Zd d „Z dd„Z d d„Zdd„Zdd„Z dd„Zdd„Zdd„Zdd„Zdd„Zdd„Zdd „Zd!d"„Zd#d$„Zd%d&„Zd'd(„Zd)d*„Zd+d,„Zd-d.„Zd/d0„Zd1d2„Zd3d4„Zd5d6„ZdS)8ÚMessageaUAbstract 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. NcCst|ƒƒ}|j|ƒ|S)N)ÚtypeÚ MergeFrom)ÚselfÚmemoZclonerrrÚ__deepcopy__Es zMessage.__deepcopy__cCst‚dS)z9Recursively compares two messages by value and structure.N)ÚNotImplementedError)rÚ other_msgrrrÚ__eq__JszMessage.__eq__cCs ||kS)Nr)rrrrrÚ__ne__NszMessage.__ne__cCstdƒ‚dS)Nzunhashable object)Ú TypeError)rrrrÚ__hash__RszMessage.__hash__cCst‚dS)z7Outputs a human-readable representation of the message.N)r)rrrrÚ__str__UszMessage.__str__cCst‚dS)z7Outputs a human-readable representation of the message.N)r)rrrrÚ__unicode__YszMessage.__unicode__cCst‚dS)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)r)rrrrrr]szMessage.MergeFromcCs"||krdS|jƒ|j|ƒdS)zò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)ÚClearr)rrrrrÚCopyFromjs zMessage.CopyFromcCst‚dS)z,Clears all data that was set in the message.N)r)rrrrrxsz Message.ClearcCst‚dS)aMark 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)r)rrrrÚSetInParent|szMessage.SetInParentcCst‚dS)z¥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)r)rrrrÚ IsInitialized…szMessage.IsInitializedcCst‚dS)aZMerges 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)r)rÚ serializedrrrÚMergeFromString”szMessage.MergeFromStringcCs|jƒ|j|ƒdS)z¹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. N)rr)rrrrrÚParseFromString²szMessage.ParseFromStringcKst‚dS)aSerializes 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. N)r)rÚkwargsrrrÚSerializeToString»szMessage.SerializeToStringcKst‚dS)aà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. N)r)rrrrrÚSerializePartialToStringÍsz Message.SerializePartialToStringcCst‚dS)a‘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 numberN)r)rrrrÚ ListFieldsîszMessage.ListFieldscCst‚dS)zÈ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.N)r)rÚ field_namerrrÚHasField÷szMessage.HasFieldcCst‚dS)z©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.N)r)rr"rrrÚ ClearFieldýszMessage.ClearFieldcCst‚dS)z§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.N)r)rZoneof_grouprrrÚ WhichOneofszMessage.WhichOneofcCst‚dS)N)r)rÚextension_handlerrrÚHasExtension szMessage.HasExtensioncCst‚dS)N)r)rr&rrrÚClearExtensionszMessage.ClearExtensioncCst‚dS)N)r)rrrrÚDiscardUnknownFieldsszMessage.DiscardUnknownFieldscCst‚dS)zmReturns the serialized size of this message. Recursively calls ByteSize() on all contained messages. N)r)rrrrÚByteSizeszMessage.ByteSizecCst‚dS)a6Internal 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)r)rZmessage_listenerrrrÚ_SetListenerszMessage._SetListenercCst|jƒdS)zSupport the pickle protocol.)r)Údictr )rrrrÚ__getstate__-szMessage.__getstate__cCs|jƒ|j|dƒdS)zSupport the pickle protocol.rN)Ú__init__r)rÚstaterrrÚ__setstate__1szMessage.__setstate__)N) rrrÚ__doc__Ú __slots__Z DESCRIPTORrrrrrrrrrrrrrrr r!r#r$r%r'r(r)r*r+r-r0rrrrr ,s: ! r N)r1Ú __author__Ú ExceptionrrrÚobjectr rrrrÚ#s