o _ioj@s6ddlmZddlZddlZddlZddlmZddlmZm Z m Z m Z m Z m Z ddlmZddlmZmZmZmZmZmZmZmZmZmZddlmZmZdd lmZdd l m!Z!m"Z"m#Z#m$Z$gd Z%eeBeBZ& Gd d d ej'Z(e(j)Z)e(j*Z*Gdddej'Z+e+j,Z,e+j-Z-e+j.Z.e+j/Z/dZ0 GdddZ1dS)) annotationsN) Generator)ConnectionClosedConnectionClosedErrorConnectionClosedOK InvalidState PayloadTooBig ProtocolError) Extension) OK_CLOSE_CODES OP_BINARYOP_CLOSEOP_CONTOP_PINGOP_PONGOP_TEXTClose CloseCodeFrame)RequestResponse) StreamReader) BytesLike LoggerLikeOrigin Subprotocol)ProtocolSideStateSEND_EOFc@seZdZdZed\ZZdS)rz6A WebSocket connection is either a server or a client.N)__name__ __module__ __qualname____doc__rangeSERVERCLIENTr)r)U/sda-disk/www/egybert/egybert_env/lib/python3.10/site-packages/websockets/protocol.pyr-src@s eZdZdZed\ZZZZdS)rz6A WebSocket connection is in one of these four states.N) r"r#r$r%r& CONNECTINGOPENCLOSINGCLOSEDr)r)r)r*r7src@seZdZdZeddddPddZedQddZejdRddZedSddZ edTddZ edUddZ dVdd Z dWd!d"Z dXd&d'ZdYdXd)d*ZdYdXd+d,ZdZd[d2d3Zd\d4d5Zd\d6d7Zd]d^d9d:Zd_d` for details. iN)statemax_sizeloggersiderr1rr2*tuple[int | None, int | None] | int | Noner3LoggerLike | NonereturnNonecCst|_ |durtd|j}||_ |tj |_ ||_ ||_ t |ts/|dur7|d|_|_n|\|_|_d|_d|_d|_g|_d|_d|_d|_d|_d|_ d|_t|_g|_g|_||_ t!|j d|_"dS)Nz websockets.F)#uuiduuid4idlogging getLoggernamelowerr3 isEnabledForDEBUGdebugr4r1 isinstanceintmax_message_sizemax_fragment_size current_sizeexpect_continuation_frameorigin extensions subprotocol close_rcvd close_sentclose_rcvd_then_sent handshake_exceof_sentrreadereventswritesparseparsernext parser_exc)selfr4r1r2r3r)r)r*__init__Ys:     zProtocol.__init__cCs|jS)a State of the WebSocket connection. Defined in 4.1_, 4.2_, 7.1.3_, and 7.1.4_ of :rfc:`6455`. .. _4.1: https://datatracker.ietf.org/doc/html/rfc6455#section-4.1 .. _4.2: https://datatracker.ietf.org/doc/html/rfc6455#section-4.2 .. _7.1.3: https://datatracker.ietf.org/doc/html/rfc6455#section-7.1.3 .. _7.1.4: https://datatracker.ietf.org/doc/html/rfc6455#section-7.1.4 )_staterXr)r)r*r1s zProtocol.statecCs |jr |jd|j||_dS)Nz= connection is %s)rBr3r>rZ)rXr1r)r)r*r1s  int | NonecCs&|jturdS|jdurtjS|jjS)z WebSocket close code received from the remote endpoint. Defined in 7.1.5_ of :rfc:`6455`. .. _7.1.5: https://datatracker.ietf.org/doc/html/rfc6455#section-7.1.5 :obj:`None` if the connection isn't closed yet. N)r1r/rLrABNORMAL_CLOSUREcoder[r)r)r* close_codes  zProtocol.close_code str | NonecCs$|jturdS|jdurdS|jjS)a WebSocket close reason received from the remote endpoint. Defined in 7.1.6_ of :rfc:`6455`. .. _7.1.6: https://datatracker.ietf.org/doc/html/rfc6455#section-7.1.6 :obj:`None` if the connection isn't closed yet. N)r1r/rLreasonr[r)r)r* close_reasons  zProtocol.close_reasonrcCsf|jtus Jd|jdur"|jdur"|jjtvr"|jjtvr"t}nt}||j|j|j}|j |_ |S)a Exception to raise when trying to interact with a closed connection. Don't raise this exception while the connection :attr:`state` is :attr:`~websockets.protocol.State.CLOSING`; wait until it's :attr:`~websockets.protocol.State.CLOSED`. Indeed, the exception includes the close code and reason, which are known only once the connection is closed. Raises: AssertionError: If the connection isn't closed yet. zconnection isn't closed yetN) r1r/rLrMr^r rrrNrW __cause__)rXexc_typeexcr)r)r* close_excs    zProtocol.close_excdatabytes | bytearraycCs|j|t|jdS)aH Receive data from the network. After calling this method: - You must call :meth:`data_to_send` and send this data to the network. - You should call :meth:`events_received` and process resulting events. Raises: EOFError: If :meth:`receive_eof` was called earlier. N)rQ feed_datarVrUrXrhr)r)r* receive_datas zProtocol.receive_datacCs$|jjrdS|jt|jdS)a Receive the end of the data stream from the network. After calling this method: - You must call :meth:`data_to_send` and send this data to the network; it will return ``[b""]``, signaling the end of the stream, or ``[]``. - You aren't expected to call :meth:`events_received`; it won't return any new events. :meth:`receive_eof` is idempotent. N)rQeoffeed_eofrVrUr[r)r)r* receive_eofs zProtocol.receive_eofrfinboolcCsL|jstd|jturtd|jj| |_|t t ||dS)a Send a `Continuation frame`_. .. _Continuation frame: https://datatracker.ietf.org/doc/html/rfc6455#section-5.6 Parameters: data: payload containing the same kind of data as the initial frame. fin: FIN bit; set it to :obj:`True` if this is the last frame of a fragmented message and to :obj:`False` otherwise. Raises: ProtocolError: If a fragmented message isn't in progress. unexpected continuation frameconnection is N) rHr rZr-rr1r>r? send_framerrrXrhrpr)r)r*send_continuation&s  zProtocol.send_continuationTcCL|jrtd|jturtd|jj| |_|t t ||dS)a Send a `Text frame`_. .. _Text frame: https://datatracker.ietf.org/doc/html/rfc6455#section-5.6 Parameters: data: payload containing text encoded with UTF-8. fin: FIN bit; set it to :obj:`False` if this is the first frame of a fragmented message. Raises: ProtocolError: If a fragmented message is in progress. expected a continuation framersN) rHr rZr-rr1r>r?rtrrrur)r)r* send_text>  zProtocol.send_textcCrw)a Send a `Binary frame`_. .. _Binary frame: https://datatracker.ietf.org/doc/html/rfc6455#section-5.6 Parameters: data: payload containing arbitrary binary data. fin: FIN bit; set it to :obj:`False` if this is the first frame of a fragmented message. Raises: ProtocolError: If a fragmented message is in progress. rxrsN) rHr rZr-rr1r>r?rtrr rur)r)r* send_binaryUrzzProtocol.send_binaryrar^CloseCode | int | NonerbstrcCs|jturtd|jj|dur%|dkrtdttj d}d}n t||}| }| t t ||jdus=J||_t|_dS)a_ Send a `Close frame`_. .. _Close frame: https://datatracker.ietf.org/doc/html/rfc6455#section-5.5.1 Parameters: code: close code. reason: close reason. Raises: ProtocolError: If the code isn't valid or if a reason is provided without a code. rsNraz#cannot send a reason without a coder0)rZr-rr1r>r?r rrNO_STATUS_RCVD serializertrrrLrMr.rXr^rbcloserhr)r)r* send_closels    zProtocol.send_closecC>|jtur|jturtd|jj|tt |dS)z Send a `Ping frame`_. .. _Ping frame: https://datatracker.ietf.org/doc/html/rfc6455#section-5.5.2 Parameters: data: payload containing arbitrary binary data. rsN) rZr-r.rr1r>r?rtrrrkr)r)r* send_ping zProtocol.send_pingcCr)z Send a `Pong frame`_. .. _Pong frame: https://datatracker.ietf.org/doc/html/rfc6455#section-5.5.3 Parameters: data: payload containing arbitrary binary data. rsN) rZr-r.rr1r>r?rtrrrkr)r)r* send_pongrzProtocol.send_pongCloseCode | intcCs|jtur)|tjkr)t||}|}|tt|||_ |j dur&d|_ t |_|j tur5|js5|||_t|jdS)a? `Fail the WebSocket connection`_. .. _Fail the WebSocket connection: https://datatracker.ietf.org/doc/html/rfc6455#section-7.1.7 Parameters: code: close code reason: close reason Raises: ProtocolError: If the code isn't valid. NT)r1r-rr]rrrtrrrMrLrNr.r4r'rPsend_eofdiscardrUrVrr)r)r*fails     z Protocol.fail list[Event]cC|jg}|_|S)a* Fetch events generated from data received from the network. Call this method immediately after any of the ``receive_*()`` methods. Process resulting events, likely by passing them to the application. Returns: Events read from the connection. )rR)rXrRr)r)r*events_receiveds zProtocol.events_received list[bytes]cCr)a Obtain data to send to the network. Call this method immediately after any of the ``receive_*()``, ``send_*()``, or :meth:`fail` methods. Write resulting data to the connection. The empty bytestring :data:`~websockets.protocol.SEND_EOF` signals the end of the data stream. When you receive it, half-close the TCP connection. Returns: Data to write to the connection. )rS)rXrSr)r)r* data_to_sendszProtocol.data_to_sendcCs>|jturdS|jturdS|jturdS|jtusJ|jS)a Tell if the TCP connection is expected to close soon. Call this method immediately after any of the ``receive_*()``, ``send_close()``, or :meth:`fail` methods. If it returns :obj:`True`, schedule closing the TCP connection after a short timeout if the other side hasn't already closed it. Returns: Whether the TCP connection is expected to close soon. FT)r1r-r.r/r,rPr[r)r)r*close_expecteds "  zProtocol.close_expectedGenerator[None]c csza |jEdHr|jr|jdtdd}|jdur.|jdur(|j}n|j|j}|jdurA|dur;|j}nt||j}t j |jj |j t u||jdEdH}|jr]|jd|||qty}z|tjt|||_WYd}~nd}~wty}z|tjt|||_WYd}~nmd}~wty}z|tj|jd|j||_WYd}~nKd}~wty}z||j|tjt|||_WYd}~n(d}~wty}z|jjddd |tj ||_WYd}~nd}~wwdVt!d ) a- Parse incoming data into frames. :meth:`receive_data` and :meth:`receive_eof` run this generator coroutine until it needs more data or reaches EOF. :meth:`parse` never raises an exception. Instead, it sets the :attr:`parser_exc` and yields control. TN< EOFzunexpected end of stream)maskr2rJz< %sz at position z parser failed)exc_infoz"parse() shouldn't step after error)"rQat_eofrBr3EOFErrorrErGrFminrrT read_exactr4r'rJ recv_framer rrPROTOCOL_ERRORr}rWr]UnicodeDecodeError INVALID_DATArbstartr set_current_sizeMESSAGE_TOO_BIG ExceptionerrorINTERNAL_ERRORAssertionError)rXr2framerfr)r)r*rT2sf         '  zProtocol.parseccs|jtup |jtu|jksJ|jEdHs%|j|jEdHr|jr.|j d|jt ur<|jtur<| t |_dVt d)z Discard incoming data. This coroutine replaces :meth:`parse`: - after receiving a close frame, during a normal closure (1.4); - after sending a close frame, during an abnormal closure (7.1.7). Nrz"discard() shouldn't step after EOF)r4r'r1r,rPrQrrrBr3r(rr/rr[r)r)r*rs  zProtocol.discardrrcCsj|jtus |jtur|jdurtd|jst|j|_n|jtur=|jdur+td|jr2d|_n{|jt|j7_np|jt urNt t |j}| |n_|jt urTnY|jt urt|j|_|jturo|jduslJd|_|jdurxtd|jtur| t t |j|j|_d|_t|_|jtur|||_t|jn td|jd|j|dS) z- Process an incoming frame. NrxrrFzincomplete fragmented messageTzunexpected opcode: 02x)opcoderr rGr rplenrhrrrrrtrrrTrLr1r.rMrNr-r4r'rrrUrVrrRappend)rXr pong_framer)r)r*rsF               zProtocol.recv_framecCs6|jr |jd||j|j|jtu|jddS)Nz> %s)rrJ)rBr3rSrrr4r(rJ)rXrr)r)r*rtszProtocol.send_framecCs2|jrJd|_|jr|jd|jtdS)NTz> EOF)rPrBr3rSrr r[r)r)r*rs  zProtocol.send_eof) r4rr1rr2r5r3r6r7r8)r7r)r1rr7r8)r7r\)r7r`)r7r)rhrir7r8)r7r8)rhrrprqr7r8)T)Nra)r^r|rbr}r7r8)rhrr7r8)ra)r^rrbr}r7r8)r7r)r7r)r7rq)r7r)rrr7r8)r"r#r$r%r-rYpropertyr1setterr_rcrgrlrorvryr{rrrrrrrrTrrrtrr)r)r)r*rGsBG      %      $   1   - O  R r)2 __future__renumr<r9collections.abcr exceptionsrrrrr r rJr framesr r rrrrrrrrhttp11rrstreamsrtypingrrrr__all__EventIntEnumrr'r(rr,r-r.r/r rr)r)r)r*s2    0