U Xzf_7@sTdZdZGdddeZGdddeZGdddeZGdd d eZd d Zd S) z6Contains an abstract base class for protocol messages.z#robinson@google.com (Will Robinson)c@seZdZdZdS)Errorz Base error type for this module.N__name__ __module__ __qualname____doc__rro/private/var/folders/n9/53xbvtmd7sjg1q1l55xmpg58n4mgng/T/pip-unpacked-wheel-3cr5c46n/google/protobuf/message.pyr'src@seZdZdZdS) DecodeErrorz-Exception raised when deserializing messages.Nrrrrrr ,sr c@seZdZdZdS) EncodeErrorz+Exception raised when serializing messages.Nrrrrrr 1sr c@seZdZdZgZdZd;ddZddZddZd d Z d d Z d dZ ddZ ddZ ddZddZddZddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zd)d*Zd+d,Zd-d.Zd/d0Zd1d2Zd3d4Zd5d6Zd7d8Z d9d:Z!dS)<MessagezAbstract 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. NcCst|}|||SN)type MergeFrom)selfmemoclonerrr __deepcopy__Ps  zMessage.__deepcopy__cCstdS)z9Recursively compares two messages by value and structure.NNotImplementedErrorrZ other_msgrrr__eq__UszMessage.__eq__cCs ||k Sr rrrrr__ne__YszMessage.__ne__cCs tddS)Nzunhashable object) TypeErrorrrrr__hash__]szMessage.__hash__cCstdSz7Outputs a human-readable representation of the message.Nrrrrr__str__`szMessage.__str__cCstdSrrrrrr __unicode__dszMessage.__unicode__cCstdS)aMerges 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. Nrrrrrrhs zMessage.MergeFromcCs"||kr dS|||dS)zCopies 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. N)ClearrrrrrCopyFromus zMessage.CopyFromcCstdS)z,Clears all data that was set in the message.Nrrrrrrsz Message.ClearcCstdS)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. Nrrrrr SetInParentszMessage.SetInParentcCstdS)zChecks 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). Nrrrrr IsInitializedszMessage.IsInitializedcCstdS)aEMerges 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. Nrr serializedrrrMergeFromStringszMessage.MergeFromStringcCs|||S)zParse serialized protocol buffer data into this message. Like :func:`MergeFromString()`, except we clear the object first. )rr$r"rrrParseFromStringszMessage.ParseFromStringcKstdS)aSerializes 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`). NrrkwargsrrrSerializeToStringszMessage.SerializeToStringcKstdS)aSerializes 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. Nrr&rrrSerializePartialToStrings z Message.SerializePartialToStringcCstdS)a'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. Nrrrrr ListFieldss zMessage.ListFieldscCstdS)aChecks 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. Nrr field_namerrrHasFieldszMessage.HasFieldcCstdS)a^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. Nrr+rrr ClearFields zMessage.ClearFieldcCstdS)aEReturns 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 Nr)rZ oneof_grouprrr WhichOneof'szMessage.WhichOneofcCstdS)aChecks 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. NrrZextension_handlerrr HasExtension7szMessage.HasExtensioncCstdS)zxClears the contents of a given extension. Args: extension_handle: The handle for the extension to clear. Nrr0rrrClearExtensionIszMessage.ClearExtensioncCstdS)zqReturns the UnknownFieldSet. Returns: UnknownFieldSet: The unknown fields stored in this message. Nrrrrr UnknownFieldsQszMessage.UnknownFieldscCstdS)zlClears all fields in the :class:`UnknownFieldSet`. This operation is recursive for nested message. NrrrrrDiscardUnknownFieldsYszMessage.DiscardUnknownFieldscCstdS)zReturns the serialized size of this message. Recursively calls ByteSize() on all contained messages. Returns: int: The number of bytes required to serialize this message. NrrrrrByteSize`szMessage.ByteSizecCstdS)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. Nr)rZmessage_listenerrrr _SetListenerjszMessage._SetListenercCst|dS)Support the pickle protocol.)r#)dictr)rrrr __getstate__szMessage.__getstate__cCs2||d}t|ts$|d}||dS)r7r#latin1N)__init__ isinstancebytesencoder%)rstater#rrr __setstate__s   zMessage.__setstate__cCs8|j}|jdkr"t|d|fS|}t|jf|fS)Nr) DESCRIPTORZcontaining_typer r9_InternalConstructMessage full_name)rZmessage_descriptor containerrrr __reduce__s zMessage.__reduce__)N)"rrrr __slots__rArrrrrrrrrr r!r$r%r(r)r*r-r.r/r1r2r3r4r5r6r9r@rErrrrr 6s>   !  r cCsddlm}||S)zConstructs a nested message.)symbol_database)Zgoogle.protobufrHZDefaultZ GetSymbol)rCrHrrrrBs rBN) r __author__ Exceptionrr r objectr rBrrrr#se