File: D:/Python311/Lib/site-packages/google/protobuf/__pycache__/message.cpython-311.pyc
�
�nc�8 � � � d Z dZ G d� de� � Z G d� de� � Z G d� de� � Z G d� d e� � Zd
� Zd S ) z6Contains an abstract base class for protocol messages.z#robinson@google.com (Will Robinson)c � � e Zd ZdZdS )�Errorz Base error type for this module.N��__name__�
__module__� __qualname__�__doc__� � �9D:\Python311\Lib\site-packages\google/protobuf/message.pyr r ' s � � � � � �(�(��$r
r c � � e Zd ZdZdS )� DecodeErrorz-Exception raised when deserializing messages.Nr r r
r r
r
, s � � � � � �5�5��$r
r
c � � e Zd ZdZdS )� EncodeErrorz+Exception raised when serializing messages.Nr r r
r r r 1 s � � � � � �3�3��$r
r c �� � e Zd ZdZg ZdZd!d�Zd� Zd� Zd� Z d� Z
d� Z d � Z d
� Z
d � Zd � Zd
� Zd� Zd� Zd� Zd� Zd� Zd� Zd� Zd� Zd� Zd� Zd� Zd� Z d� Z e d� � � Z e d � � � Z!d � Z"d � Z#d � Z$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 �^ � t | � � � � }|� | � � |S �N)�type� MergeFrom)�self�memo�clones r � __deepcopy__zMessage.__deepcopy__P s* � � �D��J�J�L�L�E� �O�O�D���� �Lr
c � � t �)z9Recursively compares two messages by value and structure.��NotImplementedError�r � other_msgs r �__eq__zMessage.__eq__U � � �
� r
c � � | |k S r r r s r �__ne__zMessage.__ne__Y s � ��y� � � r
c � � t d� � �)Nzunhashable object)� TypeError�r s r �__hash__zMessage.__hash__] s � �
�'�
(�
(�(r
c � � t ��z7Outputs a human-readable representation of the message.r r% s r �__str__zMessage.__str__` r r
c � � t �r( r r% s r � __unicode__zMessage.__unicode__d r r
c � � t �)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.
r r s r r zMessage.MergeFromh s
� � � r
c �d � | |u rdS | � � � | � |� � 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 s r �CopyFromzMessage.CopyFromu s; � � �y��
� �f��J�J�L�L�L��N�N�9� � � � � r
c � � t �)z,Clears all data that was set in the message.r r% s r r. z
Message.Clear� r r
c � � t �)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.
r r% s r � SetInParentzMessage.SetInParent� �
� � � r
c � � t �)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).
r r% s r �
IsInitializedzMessage.IsInitialized� s
� � � r
c � � t �)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.
r �r �
serializeds r �MergeFromStringzMessage.MergeFromString� s
� �> � r
c �T � | � � � | � |� � 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. r9 r7 s r �ParseFromStringzMessage.ParseFromString� s% � � �J�J�L�L�L� � � �
� +� +�+r
c � � t �)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`).
r �r �kwargss r �SerializeToStringzMessage.SerializeToString� �
� � � r
c � � t �)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.
r r= s r �SerializePartialToStringz Message.SerializePartialToString� �
� � � r
c � � t �)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.
r r% s r �
ListFieldszMessage.ListFields� rC r
c � � t �)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.
r �r �
field_names r �HasFieldzMessage.HasField
�
� � � r
c � � t �)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.
r rG s r �
ClearFieldzMessage.ClearField s
� � � r
c � � t �)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
r )r � oneof_groups r �
WhichOneofzMessage.WhichOneof* r@ r
c � � t �)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.
r �r �extension_handles r � HasExtensionzMessage.HasExtension: rJ r
c � � t �)zxClears the contents of a given extension.
Args:
extension_handle: The handle for the extension to clear.
r rQ s r �ClearExtensionzMessage.ClearExtensionL �
� � � r
c � � t �)zqReturns the UnknownFieldSet.
Returns:
UnknownFieldSet: The unknown fields stored in this message.
r r% s r �
UnknownFieldszMessage.UnknownFieldsT rV r
c � � t �)zlClears all fields in the :class:`UnknownFieldSet`.
This operation is recursive for nested message.
r r% s r �DiscardUnknownFieldsz Message.DiscardUnknownFields\ s
� �
� r
c � � t �)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.
r r% s r �ByteSizezMessage.ByteSizec r3 r
c � � t �r r )�cls�ss r �
FromStringzMessage.FromStringm r r
c � � t �r r )rR s r �RegisterExtensionzMessage.RegisterExtensionq r r
c � � t �)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.
r )r �message_listeners r � _SetListenerzMessage._SetListeneru s
� �& � r
c �F � t | � � � �� � S )� Support the pickle protocol.)r8 )�dictrB r% s r � __getstate__zMessage.__getstate__� s � � �4�8�8�:�:� ;� ;� ;�;r
c � � | � � � |d }t |t � � s|� d� � }| � |� � dS )rg r8 �latin1N)�__init__�
isinstance�bytes�encoder; )r �stater8 s r � __setstate__zMessage.__setstate__� sZ � ��M�M�O�O�O��|�$�J� �j�%� (� (� /� �$�$�X�.�.�j�����$�$�$�$�$r
c � � | j }|j �$t | � � d| � � � fS |}t |j f| � � � fS )Nr )�
DESCRIPTOR�containing_typer ri �_InternalConstructMessage� full_name)r �message_descriptor� containers r �
__reduce__zMessage.__reduce__� s_ � � � ���)� 1�
�$�Z�Z��T� .� .� 0� 0�
0�0� #�I� %� �(;�'=� � � � � � !� !r
r )&r r r r � __slots__rs r r r" r& r) r+ r r/ r. r2 r5 r9 r; r? rB rE rI rL rO rS rU rX rZ r\ � classmethodr` � staticmethodrb re ri rq ry r r
r r r 6 s � � � � � �� �& �)� �*�� � � �
� � �!� !� !�)� )� )� � � � � � � � � � � � � � � � � � � � � � � � �B ,� ,� ,� � � �
�
�
�>
�
�
� � � �$ � � � � � � � � �$ � � � � � � � � � � � � � � � �;� � � � � �<� � � � �*<� <� <�%� %� %� !� !� !� !� !r
r c �l � ddl m} |� � � � | � � � � S )z Constructs a nested message.� )�symbol_database)�google.protobufr �Default� GetSymbol)rv r s r ru ru � s< � �-�-�-�-�-�-� 7� � � � "� "� ,� ,�Y� 7� 7� 9� 9�9r
N) r �
__author__� Exceptionr r
r �objectr ru r r
r �<module>r� s� ��F =� <�
2�
�� � � � �I� � � �
� � � � �%� � � �
� � � � �%� � � �
k!� k!� k!� k!� k!�f� k!� k!� k!�\ :� :� :� :� :r