o "`^h3O@sdZddlmZddlmZddlmZdZdZdZ Gdd d e Z Gd d d e Z Gd d d e Z Gddde ZGddde ZGddde ZGdddZd#ddZGdddZGdddZGdddZGdddZGd d!d!Zd"S)$zBinary Event Stream Decoding)crc32)unpack)EventStreamError iic@seZdZdZdS) ParserErrorz,Base binary flow encoding parsing exception.N)__name__ __module__ __qualname____doc__r r R/home/air/shanriGPT/back/venv/lib/python3.10/site-packages/botocore/eventstream.pyrsrc eZdZdZfddZZS)DuplicateHeaderz$Duplicate header found in the event.csd|d}t|dS)NzDuplicate header present: ""super__init__)selfheadermessage __class__r r r#s zDuplicateHeader.__init__rrr r r __classcell__r r rr r rcr )InvalidHeadersLengthz*Headers length is longer than the maximum.c d|dt}t|dS)NzHeader length of  exceeded the maximum of )_MAX_HEADERS_LENGTHrrrlengthrrr r r+zInvalidHeadersLength.__init__rr r rr r(rrcr )InvalidPayloadLengthz*Payload length is longer than the maximum.cr)NzPayload length of r)_MAX_PAYLOAD_LENGTHrrrrr r r3r!zInvalidPayloadLength.__init__rr r rr r"0rr"cr )ChecksumMismatchz8Calculated checksum did not match the expected checksum.cs$d|dd|d}t|dS)NzChecksum mismatch: expected 0x08xz, calculated 0xr)rexpected calculatedrrr r r;szChecksumMismatch.__init__rr r rr r$8rr$cr )NoInitialResponseErrorzAn 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. csd}t|dS)Nz0First event was not of the initial-response typer)rrrr r rGszNoInitialResponseError.__init__rr r rr r(@sr(c@seZdZdZdZdZdZdZdZdZ dZ d Z eeed Z e d d Ze d dZe ddZe ddZe ddZe ddZe ddZe ddZe d%ddZe d%ddZe d d!Ze d"d#Zd$S)& DecodeUtilszUnpacking 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)cCdS)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) )Trr datar r r unpack_trued zDecodeUtils.unpack_truecCr-)aThis 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) )Frr r.r r r unpack_falseqr1zDecodeUtils.unpack_falsecC ttj|ddd}|dfS)zParse 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) Nr*r)rr)UINT8_BYTE_FORMATr/valuer r r unpack_uint8~ zDecodeUtils.unpack_uint8cCr3)zParse 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) Nr,r)rr)UINT32_BYTE_FORMATr5r r r unpack_uint32r8zDecodeUtils.unpack_uint32cCr3)zParse 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) Nr*r)rr)INT8_BYTE_FORMATr5r r r unpack_int8r8zDecodeUtils.unpack_int8cCr3)aParse 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) Nr+r)rr)INT16_BYTE_FORMATr5r r r unpack_int16 zDecodeUtils.unpack_int16cCr3)aParse 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) Nr,r)rr)INT32_BYTE_FORMATr5r r r unpack_int32r?zDecodeUtils.unpack_int32cCr3)aParse 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) Nr)rr)INT64_BYTE_FORMATr5r r r unpack_int64r?zDecodeUtils.unpack_int64r+cCs<tj|}t||d|d}||}|||}||fS)aParse 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)r)UINT_BYTE_FORMATr)r/length_byte_sizeuint_byte_formatr bytes_end array_bytesr r r unpack_byte_arrays  zDecodeUtils.unpack_byte_arraycCst||\}}|d|fS)aParse 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)r)rJdecode)r/rFrIconsumedr r r unpack_utf8_stringszDecodeUtils.unpack_utf8_stringcCs|dddfS)zParse 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). Nr r.r r r unpack_uuids zDecodeUtils.unpack_uuidcCsttj|tfS)aParse 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) )rr)PRELUDE_BYTE_FORMAT_PRELUDE_LENGTHr.r r r unpack_prelude s zDecodeUtils.unpack_preludeN)r+)rrr r r4UINT16_BYTE_FORMATr9r;r=r@rCrPrE staticmethodr0r2r7r:r<r>rArDrJrMrOrRr r r r r)LsL            r)cCs$t||d@}||krt||dS)Nl)rr$)r/checksumcrccomputed_checksumr r r _validate_checksums rXc@s<eZdZdZddZeddZeddZedd Zd S) MessagePreludez2Represents the prelude of an event stream message.cCs||_||_||_dSN) total_lengthheaders_lengthrV)rr[r\rVr r r r's zMessagePrelude.__init__cCs|j|jtdS)zCalculates the total payload length. The extra minus 4 bytes is for the message CRC. :rtype: int :returns: The total payload length. r,)r[r\rQrr r r payload_length,s zMessagePrelude.payload_lengthcCs |jdS)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. r,)r[r]r r r payload_end7s zMessagePrelude.payload_endcCs t|jS)zCalculates 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. )rQr\r]r r r headers_endCs zMessagePrelude.headers_endN) rrr r rpropertyr^r_r`r r r r rY$s   rYc@s"eZdZdZddZdddZdS) EventStreamMessagez#Represents an event stream message.cCs||_||_||_||_dSrZ)preludeheaderspayloadrV)rrcrdrerVr r r rQs zEventStreamMessage.__init__cCs0|jd}|dks|dkrd}||j|jdS)Nz :message-typeerror exceptioni) status_coderdbody)rdgetre)rri message_typer r r to_response_dictWs z#EventStreamMessage.to_response_dictN)rf)rrr r rrmr r r r rbNsrbc @s~eZdZdZejejejejej ej ej ej ej ej d ZddZddZddZd d Zd d Zd dZddZddZdS)EventStreamHeaderParseraParses 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. ) rr*r+r,rB cCs d|_dSrZ_datar]r r r rs z EventStreamHeaderParser.__init__cCs||_|S)aParses 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. )ru_parse_headersrr/r r r parses zEventStreamHeaderParser.parsecCs8i}|jr|\}}||vrt||||<|js|SrZ)ru _parse_headerr)rrdnamer6r r r rvs z&EventStreamHeaderParser._parse_headerscCs|}|}||fSrZ) _parse_name _parse_value)rrzr6r r r rysz%EventStreamHeaderParser._parse_headercCs t|jd\}}|||S)Nr*)r)rMru _advance_data)rrzrLr r r r{s z#EventStreamHeaderParser._parse_namecCst|j\}}|||SrZ)r)r7rur})rtyperLr r r _parse_types z#EventStreamHeaderParser._parse_typecCs.|}|j|}||j\}}|||SrZ)r_HEADER_TYPE_MAPrur})r header_typevalue_unpackerr6rLr r r r|s   z$EventStreamHeaderParser._parse_valuecCs|j|d|_dSrZrt)rrLr r r r}sz%EventStreamHeaderParser._advance_dataN)rrr r r)r0r2r<r>rArDrJrMrOrrrxrvryr{rr|r}r r r r rnbs*    rnc@seZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZddZddZddZdS)EventStreamBufferzStreaming 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. cCsd|_d|_t|_dS)N)ru_preludern_header_parserr]r r r rs zEventStreamBuffer.__init__cCs|j|7_dS)zAdd data to the buffer. :type data: bytes :param data: The bytes to add to the buffer to be used when parsing Nrtrwr r r add_dataszEventStreamBuffer.add_datacCs,|jtkr t|j|jtkrt|jdSrZ)r\rrr^r#r")rrcr r r _validate_preludes    z#EventStreamBuffer._validate_preludecCsJ|jdt}t|\}}t|}t|dtd|j|||SNr,)rurQr)rRrYrXrVr)r prelude_bytes raw_prelude_rcr r r _parse_preludes  z EventStreamBuffer._parse_preludecCs|jt|jj}|j|SrZ)rurQrr`rrx)r header_bytesr r r rvs z EventStreamBuffer._parse_headerscCs|j}|j|j|j}|SrZ)rrur`r_)rrc payload_bytesr r r _parse_payloadsz EventStreamBuffer._parse_payloadcCs*|j}|j|j|j}t|\}}|SrZ)rrur_r[r)r:)rrc crc_bytes message_crcrr r r _parse_message_crcsz$EventStreamBuffer._parse_message_crccCs|jtd|jj}|Sr)rurQrr_)r message_bytesr r r _parse_message_bytessz&EventStreamBuffer._parse_message_bytescCs&|}|}t|||jjd|S)N)rV)rrrXrrV)rrrr r r _validate_message_crcsz'EventStreamBuffer._validate_message_crccCs4|}|}|}t|j|||}||SrZ)rrvrrbr_prepare_for_next_message)rrVrdrerr r r _parse_messages z EventStreamBuffer._parse_messagecCs|j|jjd|_d|_dSrZ)rurr[r]r r r rs z+EventStreamBuffer._prepare_for_next_messagecCsHt|jtkr t|jdur||_t|j|jjkr t|S)zProvides the next available message parsed from the stream :rtype: EventStreamMessage :returns: The next event stream message N)lenrurQ StopIterationrrr[rr]r r r nexts  zEventStreamBuffer.nextcCs|SrZ)rr]r r r __next__szEventStreamBuffer.__next__cCs|SrZr r]r r r __iter__szEventStreamBuffer.__iter__N)rrr r rrrrrvrrrrrrrrrr r r r rs   rc@s@eZdZdZddZddZddZdd Zd d Zd d Z dS) EventStreamaWrapper 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.") cCs&||_||_||_||_||_dSrZ) _raw_stream _output_shape_operation_name_parser_create_raw_event_generator_event_generator)r raw_stream output_shapeparseroperation_namer r r rGs zEventStream.__init__ccs&|jD] }||}|r|VqdSrZ)r _parse_event)revent parsed_eventr r r rNs  zEventStream.__iter__ccs0t}|jD] }|||EdHq dSrZ)rrstreamr)revent_stream_bufferchunkr r r rTs   z'EventStream._create_raw_event_generatorcCs4|}|j||j}|ddkr|St||j)Nrirf)rmrrxrrr)rr response_dictparsed_responser r r rZs   zEventStream._parse_eventcCsDzt|j}|jd}|dkr|WSWtty!Ytw)Nz :event-typezinitial-response)rrrdrkrr()r initial_event event_typer r r get_initial_responsebs   z EventStream.get_initial_responsecCs|jdS)z%Closes the underlying streaming body.N)rcloser]r r r rlszEventStream.closeN) rrr r rrrrrrr r r r rs+ rN)r)r binasciirstructrbotocore.exceptionsrrQrr# Exceptionrrrr"r$r(r)rXrYrbrnrrr r r r s*     Q*Te