|
Server : nginx/1.24.0 System : Linux ip-172-31-33-48 6.14.0-1011-aws #11~24.04.1-Ubuntu SMP Fri Aug 1 02:07:25 UTC 2025 x86_64 User : www-data ( 33) PHP Version : 8.3.6 Disable Function : NONE Directory : /lib/python3/dist-packages/botocore/__pycache__/ |
Upload File : |
�
P��e�O � �< � d Z ddlmZ ddlmZ ddlmZ dZdZdZ G d� d e
� Z G d
� d e � Z G d � d
e � Z
G d� de � Z G d� de � Z G d� de � Z G d� d� Zd"d�Z G d� d� Z G d� d� Z G d� d � Z G d � d � Z G d � d � Zy!)#z Binary Event Stream Decoding � )�crc32)�unpack)�EventStreamError� i i c � � e Zd ZdZy)� ParserErrorz,Base binary flow encoding parsing exception.N)�__name__�
__module__� __qualname__�__doc__� � �6/usr/lib/python3/dist-packages/botocore/eventstream.pyr r s � �6�r r c �" � � e Zd ZdZ� fd�Z� xZS )�DuplicateHeaderz$Duplicate header found in the event.c �. �� d|z }t �| � |� y )Nz Duplicate header present: "%s"��super�__init__)�self�header�message� __class__s �r r zDuplicateHeader.__init__# s �� �2�V�;��
����!r �r r
r r r �
__classcell__�r s @r r r s �� �.�"� "r r c �" � � e Zd ZdZ� fd�Z� xZS )�InvalidHeadersLengthz*Headers length is longer than the maximum.c �P �� dj |t � }t �| �
|� y )Nz.Header length of {} exceeded the maximum of {})�format�_MAX_HEADERS_LENGTHr r �r �lengthr r s �r r z InvalidHeadersLength.__init__+ s( �� �B�I�I� � �
�� ����!r r r s @r r r ( � �� �4�"� "r r c �" � � e Zd ZdZ� fd�Z� xZS )�InvalidPayloadLengthz*Payload length is longer than the maximum.c �P �� dj |t � }t �| �
|� y )Nz/Payload length of {} exceeded the maximum of {})r �_MAX_PAYLOAD_LENGTHr r r" s �r r z InvalidPayloadLength.__init__6 s( �� �C�J�J� � �
�� ����!r r r s @r r& r& 3 r$ r r& c �" � � e Zd ZdZ� fd�Z� xZS )�ChecksumMismatchz8Calculated checksum did not match the expected checksum.c �H �� dj ||� }t �| � |� y )Nz9Checksum mismatch: expected 0x{:08x}, calculated 0x{:08x})r r r )r �expected�
calculatedr r s �r r zChecksumMismatch.__init__A s+ �� � G� N� N���
� � ����!r r r s @r r* r* > s �� �B�"� "r r* c �" � � e Zd ZdZ� fd�Z� xZS )�NoInitialResponseErrorz�An event of type initial-response was not received.
This exception is raised when the event stream produced no events or
the first event in the stream was not of the initial-response type.
c �( �� d}t �| � |� y )Nz0First event was not of the initial-response typer )r r r s �r r z NoInitialResponseError.__init__R s �� �D��
����!r r r s @r r/ r/ K s �� �� "� "r r/ c � � e Zd ZdZdZdZdZdZdZdZ dZ
d Z eeed
�Z e
d � � Ze
d � � Ze
d
� � Ze
d� � Ze
d� � Ze
d� � Ze
d� � Ze
d� � Ze
dd�� Ze
dd�� Ze
d� � Ze
d� � Zy)� DecodeUtilsz�Unpacking utility functions used in the decoder.
All methods on this class take raw bytes and return a tuple containing
the value parsed from the bytes and the number of bytes consumed to parse
that value.
z!Bz!Hz!Iz!bz!hz!iz!qz!III)� � � c � � y)a This method consumes none of the provided bytes and returns True.
:type data: bytes
:param data: The bytes to parse from. This is ignored in this method.
:rtype: tuple
:rtype: (bool, int)
:returns: The tuple (True, 0)
)Tr r
��datas r � unpack_truezDecodeUtils.unpack_trueo s � � r c � � y)a This method consumes none of the provided bytes and returns False.
:type data: bytes
:param data: The bytes to parse from. This is ignored in this method.
:rtype: tuple
:rtype: (bool, int)
:returns: The tuple (False, 0)
)Fr r
r7 s r � unpack_falsezDecodeUtils.unpack_false| s � � r c �J � t t j | dd � d }|dfS )z�Parse an unsigned 8-bit integer from the bytes.
:type data: bytes
:param data: The bytes to parse from.
:rtype: (int, int)
:returns: A tuple containing the (parsed integer value, bytes consumed)
Nr3 r )r r2 �UINT8_BYTE_FORMAT�r8 �values r � unpack_uint8zDecodeUtils.unpack_uint8� s* � � �{�4�4�d�2�A�h�?��B���a�x�r c �J � t t j | dd � d }|dfS )z�Parse an unsigned 32-bit integer from the bytes.
:type data: bytes
:param data: The bytes to parse from.
:rtype: (int, int)
:returns: A tuple containing the (parsed integer value, bytes consumed)
Nr5 r )r r2 �UINT32_BYTE_FORMATr> s r �
unpack_uint32zDecodeUtils.unpack_uint32� s* � � �{�5�5�t�B�Q�x�@��C���a�x�r c �J � t t j | dd � d }|dfS )z�Parse a signed 8-bit integer from the bytes.
:type data: bytes
:param data: The bytes to parse from.
:rtype: (int, int)
:returns: A tuple containing the (parsed integer value, bytes consumed)
Nr3 r )r r2 �INT8_BYTE_FORMATr> s r � unpack_int8zDecodeUtils.unpack_int8� s* � � �{�3�3�T�"�1�X�>�q�A���a�x�r c �J � t t j | dd � d }|dfS )a Parse a signed 16-bit integer from the bytes.
:type data: bytes
:param data: The bytes to parse from.
:rtype: tuple
:rtype: (int, int)
:returns: A tuple containing the (parsed integer value, bytes consumed)
Nr4 r )r r2 �INT16_BYTE_FORMATr> s r � unpack_int16zDecodeUtils.unpack_int16� �* � � �{�4�4�d�2�A�h�?��B���a�x�r c �J � t t j | dd � d }|dfS )a Parse a signed 32-bit integer from the bytes.
:type data: bytes
:param data: The bytes to parse from.
:rtype: tuple
:rtype: (int, int)
:returns: A tuple containing the (parsed integer value, bytes consumed)
Nr5 r )r r2 �INT32_BYTE_FORMATr> s r � unpack_int32zDecodeUtils.unpack_int32� rJ r c �J � t t j | dd � d }|dfS )a Parse a signed 64-bit integer from the bytes.
:type data: bytes
:param data: The bytes to parse from.
:rtype: tuple
:rtype: (int, int)
:returns: A tuple containing the (parsed integer value, bytes consumed)
N� r )r r2 �INT64_BYTE_FORMATr> s r � unpack_int64zDecodeUtils.unpack_int64� rJ r c �h � t j | }t || d| � d }||z }| || }||fS )a� Parse a variable length byte array from the bytes.
The bytes are expected to be in the following format:
[ length ][0 ... length bytes]
where length is an unsigned integer represented in the smallest number
of bytes to hold the maximum length of the array.
:type data: bytes
:param data: The bytes to parse from.
:type length_byte_size: int
:param length_byte_size: The byte size of the preceding integer that
represents the length of the array. Supported values are 1, 2, and 4.
:rtype: (bytes, int)
:returns: A tuple containing the (parsed byte array, bytes consumed).
Nr )r2 �UINT_BYTE_FORMATr )r8 �length_byte_size�uint_byte_formatr# � bytes_end� array_bytess r �unpack_byte_arrayz DecodeUtils.unpack_byte_array� sT � �& '�7�7�8H�I���(�$�/@�0@�*A�B�1�E��� -�-� ��+�I�6� ��I�%�%r c �Z � t j | |� \ }}|j d� |fS )a� Parse a variable length utf-8 string from the bytes.
The bytes are expected to be in the following format:
[ length ][0 ... length bytes]
where length is an unsigned integer represented in the smallest number
of bytes to hold the maximum length of the array and the following
bytes are a valid utf-8 string.
:type data: bytes
:param bytes: The bytes to parse from.
:type length_byte_size: int
:param length_byte_size: The byte size of the preceding integer that
represents the length of the array. Supported values are 1, 2, and 4.
:rtype: (str, int)
:returns: A tuple containing the (utf-8 string, bytes consumed).
zutf-8)r2 rX �decode)r8 rT rW �consumeds r �unpack_utf8_stringz DecodeUtils.unpack_utf8_string� s7 � �( !,� =� =� �"�!
� � �X� �!�!�'�*�H�4�4r c � � | dd dfS )z�Parse a 16-byte uuid from the bytes.
:type data: bytes
:param data: The bytes to parse from.
:rtype: (bytes, int)
:returns: A tuple containing the (uuid bytes, bytes consumed).
N� r
r7 s r � unpack_uuidzDecodeUtils.unpack_uuid s � � �C�R�y�"�}� r c �B � t t j | � t fS )a� Parse the prelude for an event stream message from the bytes.
The prelude for an event stream message has the following format:
[total_length][header_length][prelude_crc]
where each field is an unsigned 32-bit integer.
:rtype: ((int, int, int), int)
:returns: A tuple of ((total_length, headers_length, prelude_crc),
consumed)
)r r2 �PRELUDE_BYTE_FORMAT�_PRELUDE_LENGTHr7 s r �unpack_preludezDecodeUtils.unpack_prelude s � � �{�6�6��=��O�Or N)r4 )r r
r r r= �UINT16_BYTE_FORMATrB rE rH rL rP ra rS � staticmethodr9 r; r@ rC rF rI rM rQ rX r\ r_ rc r
r r r2 r2 W s> � �� �� �� ���� �� �� �� �� � � ��� �
� �
� �
� �
� �
� �
� �
� �
� �
� �
� � � � � � � � � � � � � �&� �&�0 �5� �5�0 � � � � � P� � Pr r2 c �D � t | |� dz }||k7 r t ||� �y )Nl �� )r r* )r8 �checksum�crc�computed_checksums r �_validate_checksumrj ' s2 � � �d�C�(�:�5���$�$� �x�):�;�;� %r c �F � e Zd ZdZd� Zed� � Zed� � Zed� � Zy)�MessagePreludez2Represents the prelude of an event stream message.c �. � || _ || _ || _ y �N)� total_length�headers_lengthrh )r ro rp rh s r r zMessagePrelude.__init__2 s � � (��� ,�����r c �H � | j | j z
t z
dz
S )z�Calculates the total payload length.
The extra minus 4 bytes is for the message CRC.
:rtype: int
:returns: The total payload length.
r5 )ro rp rb �r s r �payload_lengthz MessagePrelude.payload_length7 s% � � � � �4�#6�#6�6� �H�1�L�Lr c � � | j dz
S )a Calculates the byte offset for the end of the message payload.
The extra minus 4 bytes is for the message CRC.
:rtype: int
:returns: The byte offset from the beginning of the event stream
message to the end of the payload.
r5 )ro rr s r � payload_endzMessagePrelude.payload_endB s � � � � �1�$�$r c �( � t | j z S )z�Calculates the byte offset for the end of the message headers.
:rtype: int
:returns: The byte offset from the beginning of the event stream
message to the end of the headers.
)rb rp rr s r � headers_endzMessagePrelude.headers_endN s � � ��!4�!4�4�4r N) r r
r r r �propertyrs ru rw r
r r rl rl / sH � �<��
�M� �M� � %� � %� �5� �5r rl c � � e Zd ZdZd� Zdd�Zy)�EventStreamMessagez#Represents an event stream message.c �< � || _ || _ || _ || _ y rn )�prelude�headers�payloadrh )r r| r} r~ rh s r r zEventStreamMessage.__init__\ s � � �� � �� � �� ���r c � � | j j d� }|dk( s|dk( rd}|| j | j d�S )Nz
:message-type�error� exceptioni� )� status_coder} �body)r} �getr~ )r r� � message_types r �to_response_dictz#EventStreamMessage.to_response_dictb sE � ��|�|�'�'��8� � �7� "�l�k�&A� �K�&��|�|��L�L�
�
r N)�� )r r
r r r r� r
r r rz rz Y s � �-��
r rz c �" � e Zd ZdZej
ej ej ej ej ej ej ej ej ej d�
Zd� Zd� Zd� Zd� Zd� Zd� Zd � Zd
� Zy ) �EventStreamHeaderParsera Parses the event headers from an event stream message.
Expects all of the header data upfront and creates a dictionary of headers
to return. This object can be reused multiple times to parse the headers
from multiple event stream messages.
)
r r3 r4 � r5 � � � rO � c � � d | _ y rn ��_datarr s r r z EventStreamHeaderParser.__init__� s � ���
r c �0 � || _ | j � S )a Parses the event stream headers from an event stream message.
:type data: bytes
:param data: The bytes that correspond to the headers section of an
event stream message.
:rtype: dict
:returns: A dictionary of header key, value pairs.
)r� �_parse_headers�r r8 s r �parsez EventStreamHeaderParser.parse� s � � ��
��"�"�$�$r c � � i }| j r4| j � \ }}||v r t |� �|||< | j r�4|S rn )r� �
_parse_headerr )r r} �namer? s r r� z&EventStreamHeaderParser._parse_headers� sK � ����j�j� �,�,�.�K�D�%��w��%�d�+�+� !�G�D�M� �j�j�
�r c �J � | j � }| j � }||fS rn )� _parse_name� _parse_value)r r� r? s r r� z%EventStreamHeaderParser._parse_header� s( � �� � �!���!�!�#���U�{�r c �n � t j | j d� \ }}| j |� |S )Nr3 )r2 r\ r� �
_advance_data)r r� r[ s r r� z#EventStreamHeaderParser._parse_name� s/ � �$�7�7��
�
�A�F���h� ���8�$�� r c �l � t j | j � \ }}| j |� |S rn )r2 r@ r� r� )r �typer[ s r � _parse_typez#EventStreamHeaderParser._parse_type� s- � �$�1�1�$�*�*�=���h� ���8�$�� r c � � | j � }| j | } || j � \ }}| j |� |S rn )r� �_HEADER_TYPE_MAPr� r� )r � header_type�value_unpackerr? r[ s r r� z$EventStreamHeaderParser._parse_value� sE � ��&�&�(� � �.�.�{�;��(����4���x� ���8�$�� r c �, � | j |d | _ y rn r� )r r[ s r r� z%EventStreamHeaderParser._advance_data� s � ��Z�Z�� �*��
r N)r r
r r r2 r9 r; rF rI rM rQ rX r\ r_ r� r r� r� r� r� r� r� r� r
r r r� r� m s� � �� � "� "� � #� #� � "� "� � #� #� � #� #� � #� #� � (� (� � )� )� � #� #� � "� "�)��.� %���
�
�
�+r r� c �d � e Zd ZdZd� Zd� Zd� Zd� Zd� Zd� Z d� Z
d � Z d
� Z d � Z
d � Zd
� Zd� Zd� Zy)�EventStreamBufferz�Streaming based event stream buffer
A buffer class that wraps bytes from an event stream providing parsed
messages as they become available via an iterable interface.
c �> � d| _ d | _ t � | _ y )Nr )r� �_preluder� �_header_parserrr s r r zEventStreamBuffer.__init__� s � ���
� ��
� 5� 7��r c �. � | xj |z
c_ y)z�Add data to the buffer.
:type data: bytes
:param data: The bytes to add to the buffer to be used when parsing
Nr� r� s r �add_datazEventStreamBuffer.add_data� s � �
�
�
�d��
r c � � |j t kD rt |j � �|j t kD rt |j � �y rn )rp r! r rs r( r& )r r| s r �_validate_preludez#EventStreamBuffer._validate_prelude� sG � � � !� !�$7� 7�&�w�'=�'=�>� >� � !� !�$7� 7�&�w�'=�'=�>� >� 8r c �� � | j d t }t j |� \ }}t |� }| j |� t
|d t dz
|j � |S �Nr5 )r� rb r2 rc rl r� rj rh )r �
prelude_bytes� raw_prelude�_r| s r �_parse_preludez EventStreamBuffer._parse_prelude� s_ � � �
�
�#3�O�4�
�$�3�3�M�B�� �Q� �+�.�� � � �w�'��=�)>�?�Q�+>�?����M��r c � � | j t | j j }| j j |� S rn )r� rb r� rw r� r� )r � header_bytess r r� z EventStreamBuffer._parse_headers� s3 � ��z�z�/�D�M�M�4M�4M�N� ��"�"�(�(� �6�6r c �d � | j }| j |j |j }|S rn )r� r� rw ru )r r| �
payload_bytess r �_parse_payloadz EventStreamBuffer._parse_payload� s- � ��-�-�� �
�
�7�#6�#6��9L�9L�M�
� � r c � � | j }| j |j |j }t j |� \ }}|S rn )r� r� ru ro r2 rC )r r| � crc_bytes� message_crcr� s r �_parse_message_crcz$EventStreamBuffer._parse_message_crc� sA � ��-�-���J�J�w� 2� 2�W�5I�5I�J� �$�2�2�9�=�� �Q��r c �Z � | j t dz
| j j }|S r� )r� rb r� ru )r �
message_bytess r �_parse_message_bytesz&EventStreamBuffer._parse_message_bytes� s, � � �
�
� �a� �$�-�-�";�";�
�
� � r c � � | j � }| j � }t ||| j j �� |S )N)rh )r� r� rj r� rh )r r� r� s r �_validate_message_crcz'EventStreamBuffer._validate_message_crc� s: � ��-�-�/� � �1�1�3�
��=�+�4�=�=�;L�;L�M��r c � � | j � }| j � }| j � }t | j |||� }| j � |S rn )r� r� r� rz r� �_prepare_for_next_message)r rh r} r~ r s r �_parse_messagez EventStreamBuffer._parse_message sQ � ��(�(�*���%�%�'���%�%�'��$�T�]�]�G�W�c�J�� �&�&�(��r c �b � | j | j j d | _ d | _ y rn )r� r� ro rr s r r� z+EventStreamBuffer._prepare_for_next_message s& � ��Z�Z��
�
� :� :� <�=��
� ��
r c � � t | j � t k r
t � �| j �| j � | _ t | j � | j j k r
t � �| j � S )z�Provides the next available message parsed from the stream
:rtype: EventStreamMessage
:returns: The next event stream message
)�lenr� rb �
StopIterationr� r� ro r� rr s r �nextzEventStreamBuffer.next sg � � �t�z�z�?�_� ,� �/� !� �=�=� � � /� /� 1�D�M� �t�z�z�?�T�]�]� 7� 7� 7� �/� !��"�"�$�$r c �" � | j � S rn )r� rr s r �__next__zEventStreamBuffer.__next__ s � ��y�y�{�r c � � | S rn r
rr s r �__iter__zEventStreamBuffer.__iter__" s � �� r N)r r
r r r r� r� r� r� r� r� r� r� r� r� r� r� r� r
r r r� r� � sM � �� 8�
�?��7� �
� �� � �
%�"�r r� c �4 � e Zd ZdZd� Zd� Zd� Zd� Zd� Zd� Z y) � EventStreama� Wrapper class for an event stream body.
This wraps the underlying streaming body, parsing it for individual events
and yielding them as they come available through the iterator interface.
The following example uses the S3 select API to get structured data out of
an object stored in S3 using an event stream.
**Example:**
::
from botocore.session import Session
s3 = Session().create_client('s3')
response = s3.select_object_content(
Bucket='bucketname',
Key='keyname',
ExpressionType='SQL',
RequestProgress={'Enabled': True},
Expression="SELECT * FROM S3Object s",
InputSerialization={'CSV': {}},
OutputSerialization={'CSV': {}},
)
# This is the event stream in the response
event_stream = response['Payload']
end_event_received = False
with open('output', 'wb') as f:
# Iterate over events in the event stream as they come
for event in event_stream:
# If we received a records event, write the data to a file
if 'Records' in event:
data = event['Records']['Payload']
f.write(data)
# If we received a progress event, print the details
elif 'Progress' in event:
print(event['Progress']['Details'])
# End event indicates that the request finished successfully
elif 'End' in event:
print('Result is complete')
end_event_received = True
if not end_event_received:
raise Exception("End event not received, request incomplete.")
c �f � || _ || _ || _ || _ | j � | _ y rn )� _raw_stream�
_output_shape�_operation_name�_parser�_create_raw_event_generator�_event_generator)r �
raw_stream� output_shape�parser�operation_names r r zEventStream.__init__R s2 � �%��� )��� -�� � �� � $� @� @� B�� r c # �^ K � | j D ] }| j |� }|s�|�� � y �wrn )r� � _parse_event)r �event� parsed_events r r� zEventStream.__iter__Y s4 � �� ��*�*� #�E� �,�,�U�3�L��"�"� #�s �#-�-c # � K � t � }| j j � D ] }|j |� |E d { ��� � y 7 ��wrn )r� r� �streamr� )r �event_stream_buffer�chunks r r� z'EventStream._create_raw_event_generator_ sG � �� � /� 1���%�%�,�,�.� +�E� � (� (�� /�*� *� *� +� *�s �>A
� A�A
c � � |j � }| j j || j � }|d dk( r|S t || j
� �)Nr� r� )r� r� r� r� r r� )r r� �
response_dict�parsed_responses r r� zEventStream._parse_evente sR � � �.�.�0�
� �,�,�,�,�]�D�<N�<N�O�� � � '�3� .�"� "�"�?�D�4H�4H�I� Ir c � � t | j � }|j j d� }|dk( r|S t � �# t $ r Y t � �w xY w)Nz :event-typezinitial-response)r� r� r} r� r� r/ )r �
initial_event�
event_types r �get_initial_responsez EventStream.get_initial_responsem si � � � ��!6�!6� 7�M�&�.�.�2�2�=�A�J�� /�/�$�$� 0� %�&�&�� � � �$�&�&� �s �6A � A�Ac �8 � | j j � y)z%Closes the underlying streaming body.N)r� �closerr s r r� zEventStream.closew s � � ��� � � r N)
r r
r r r r� r� r� r� r� r
r r r� r� & s( � �)�VC�#� +� J�'�!r r� N)r )r �binasciir �structr �botocore.exceptionsr rb r! r( � Exceptionr r r r& r* r/ r2 rj rl rz r� r� r� r
r r �<module>r� s� �� $� � � 0� �� � �"� � �)� � "�k� "�"�;� "�"�;� "�
"�{�
"� "�[� "�MP� MP�`<�'5� '5�T
�
�(Q+� Q+�hb� b�JS!� S!r