U
|
£ý°dc: ã @ sT d Z dZG dd deZG dd deZG dd deZG dd d eZd
|
d Zd S ) z6Contains an abstract base class for protocol messages.z#robinson@google.com (Will Robinson)c @ s e Zd ZdZdS )ÚErrorz Base error type for this module.N©Ú__name__Ú
|
__module__Ú __qualname__Ú__doc__© r r úNd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\google/protobuf/message.pyr ' s r c @ s e Zd ZdZdS )Ú DecodeErrorz-Exception raised when deserializing messages.Nr r r r r r , s r c @ s e Zd ZdZdS )Ú EncodeErrorz+Exception raised when serializing messages.Nr r r r r r
|
1 s r
|
c @ s e Zd ZdZg ZdZd?ddZdd Zdd Zd d
|
Z d d Z
|
d d Z dd Z dd Z dd Zdd Zdd Zdd Zdd Zd d Zd d Zd!d" Zd#d$ Zd%d& Zd'd( Zd)d* Zd+d, Zd-d. Zd/d0 Z d1d2 Z e d3d4 Z e d5d6 Z!d7d8 Z"d9d: Z#d;d< Z$d=d> Z%dS )@ÚMessagezÒ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.
|
Nc C s t | }| | ¡ |S ©N)ÚtypeÚ MergeFrom)ÚselfÚmemoÚcloner r r Ú __deepcopy__P s
|
|
zMessage.__deepcopy__c C s t dS )z9Recursively compares two messages by value and structure.N©ÚNotImplementedError©r Z other_msgr r r Ú__eq__U s zMessage.__eq__c C s
|
| |k S r r r r r r Ú__ne__Y s zMessage.__ne__c C s t dd S )Nzunhashable object)Ú TypeError©r r r r Ú__hash__] s zMessage.__hash__c C s t dS ©z7Outputs a human-readable representation of the message.Nr r r r r Ú__str__` s zMessage.__str__c C s t dS r r r r r r Ú __unicode__d s zMessage.__unicode__c C s t 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): A message to merge into the current message.
|
Nr r r r r r h s zMessage.MergeFromc C s" | |kr dS | ¡ | |¡ 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): A message to copy into the current one.
|
N)ÚClearr r r r r ÚCopyFromu s zMessage.CopyFromc C s t dS )z,Clears all data that was set in the message.Nr r r r r r s z Message.Clearc C s t dS )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.
|
Nr r r r r Ú SetInParent s zMessage.SetInParentc C s t dS )z«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).
|
Nr r r r r Ú IsInitialized s zMessage.IsInitializedc C s t dS )aE 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.
|
Nr ©r Ú
|
serializedr r r ÚMergeFromString s zMessage.MergeFromStringc C s | ¡ | |¡S )zÊParse serialized protocol buffer data into this message.
|
|
Like :func:`MergeFromString()`, except we clear the object first.
|
|
Raises:
|
message.DecodeError if the input cannot be parsed.
|
)r r$ r" r r r ÚParseFromStringÁ s zMessage.ParseFromStringc K s t dS )aÓ 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`).
|
Nr ©r Úkwargsr r r ÚSerializeToStringÌ s zMessage.SerializeToStringc K s t 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.
|
|
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.
|
Nr r& r r r ÚSerializePartialToStringÜ s z Message.SerializePartialToStringc C s t dS )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.
|
Nr r r r r Ú
|
ListFieldsû s zMessage.ListFieldsc C s t dS )aÑ 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.
|
Nr ©r Ú
|
field_namer r r ÚHasField
|
s zMessage.HasFieldc C s t dS )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.
|
Nr r+ r r r Ú
|
ClearField s zMessage.ClearFieldc C s t dS )aE 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
|
Nr )r Z oneof_groupr r r Ú
|
WhichOneof* s zMessage.WhichOneofc C s t dS )aì 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.
|
Nr ©r Úextension_handler r r Ú HasExtension: s zMessage.HasExtensionc C s t dS )zxClears the contents of a given extension.
|
|
Args:
|
extension_handle: The handle for the extension to clear.
|
Nr r0 r r r ÚClearExtensionL s zMessage.ClearExtensionc C s t dS )zqReturns the UnknownFieldSet.
|
|
Returns:
|
UnknownFieldSet: The unknown fields stored in this message.
|
Nr r r r r Ú UnknownFieldsT s zMessage.UnknownFieldsc C s t dS )zlClears all fields in the :class:`UnknownFieldSet`.
|
|
This operation is recursive for nested message.
|
Nr r r r r ÚDiscardUnknownFields\ s z Message.DiscardUnknownFieldsc C s t dS )z¿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.
|
Nr r r r r ÚByteSizec s zMessage.ByteSizec C s t d S r r )ÚclsÚsr r r Ú
|
FromStringm s zMessage.FromStringc C s t d S r r )r1 r r r ÚRegisterExtensionq s zMessage.RegisterExtensionc C s t dS )a6 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.
|
Nr )r Zmessage_listenerr r r Ú _SetListeneru s zMessage._SetListenerc C s t | ¡ dS )ú Support the pickle protocol.)r# )Údictr) r r r r Ú __getstate__ s zMessage.__getstate__c C s2 | ¡ |d }t|ts$| d¡}| |¡ dS )r< r# Úlatin1N)Ú__init__Ú
|
isinstanceÚbytesÚencoder% )r Ústater# r r r Ú __setstate__ s
|
|
|
zMessage.__setstate__c C s8 | j }|jd kr"t| d| ¡ fS |}t|jf| ¡ fS )Nr )Ú
|
DESCRIPTORZcontaining_typer r> Ú_InternalConstructMessageÚ full_name)r Zmessage_descriptorÚ containerr r r Ú
|
__reduce__ s
|
ÿzMessage.__reduce__)N)&r r r r Ú __slots__rF r r r r r r r r r r r! r$ r% r( r) r* r- r. r/ r2 r3 r4 r5 r6 Ú classmethodr9 Ú staticmethodr: r; r> rE rJ r r r r r 6 sF
|
|
!
|
|
|
|
r c C s ddl m} | ¡ | ¡ S )z Constructs a nested message.é )Úsymbol_database)Zgoogle.protobufrO ZDefaultZ GetSymbol)rH rO r r r rG ¤ s rG N) r Ú
|
__author__Ú Exceptionr r r
|
Úobjectr rG r r r r Ú<module># s p
|
