U gc@s8ddlmZddlZddlZddlZddlmZmZddlm Z m Z m Z m Z m Z mZddlmZddlmZmZmZmZmZmZmZmZmZmZddlmZmZdd lm Z dd lm!Z!m"Z"m#Z#d d d dgZ$eeeefZ%Gdd d ej&Z'e'j(Z(e'j)Z)Gdd d ej&Z*e*j+Z+e*j,Z,e*j-Z-e*j.Z.dZ/Gdd d Z0dS)) annotationsN) GeneratorUnion)ConnectionClosedConnectionClosedErrorConnectionClosedOK InvalidState PayloadTooBig ProtocolError) Extension) OK_CLOSE_CODES OP_BINARYOP_CLOSEOP_CONTOP_PINGOP_PONGOP_TEXTClose CloseCodeFrame)RequestResponse) StreamReader) LoggerLikeOrigin SubprotocolProtocolSideStateSEND_EOFc@seZdZdZed\ZZdS)rz6A WebSocket connection is either a server or a client.N)__name__ __module__ __qualname____doc__rangeSERVERCLIENTr)r)7/tmp/pip-unpacked-wheel-dx_q7dq3/websockets/protocol.pyr.sc@s eZdZdZed\ZZZZdS)rz6A WebSocket connection is in one of these four states.N) r"r#r$r%r& CONNECTINGOPENCLOSINGCLOSEDr)r)r)r*r8sc@seZdZdZedddddddd d d d Zedd ddZejdd dddZedd ddZ edd ddZ edd ddZ dd dddZ d d ddZ dd d d!d"d#ZdJdd d d!d%d&ZdKdd d d!d'd(ZdLdd*d d+d,d-Zdd dd.d/Zdd dd0d1ZdMd2d*d d+d3d4Zd5d d6d7Zd8d d9d:Zd d d;d<Zd=d d>d?Zd=d d@dAZdBd dCdDdEZdBd dCdFdGZd d dHdIZdS)Nra6 Sans-I/O implementation of a WebSocket connection. Args: side: :attr:`~Side.CLIENT` or :attr:`~Side.SERVER`. state: Initial state of the WebSocket connection. max_size: Maximum size of incoming messages in bytes; :obj:`None` disables the limit. logger: Logger for this connection; depending on ``side``, defaults to ``logging.getLogger("websockets.client")`` or ``logging.getLogger("websockets.server")``; see the :doc:`logging guide <../../topics/logging>` for details. iN)statemax_sizeloggerrrz int | NonezLoggerLike | NoneNone)sider1r2r3returncCst|_|dkr(td|j}||_|tj |_ ||_ ||_ ||_ d|_d|_d|_g|_d|_d|_d|_d|_d|_d|_t|_g|_g|_||_t|jd|_dS)Nz websockets.F) uuidZuuid4idlogging getLoggernamelowerr3 isEnabledForDEBUGdebugr5r1r2cur_sizeexpect_continuation_frameorigin extensionsZ subprotocol close_rcvd close_sentclose_rcvd_then_sent handshake_exceof_sentrreadereventswritesparseparsernext parser_exc)selfr5r1r2r3r)r)r*__init__Xs0    zProtocol.__init__)r6cCs|jS)zt State of the WebSocket connection. Defined in 4.1, 4.2, 7.1.3, and 7.1.4 of :rfc:`6455`. )_staterPr)r)r*r1szProtocol.state)r1r6cCs |jr|jd|j||_dS)Nz= connection is %s)r?r3r;rR)rPr1r)r)r*r1scCs*|jtk rdS|jdkrtjS|jjSdS)z `WebSocket close code`_. .. _WebSocket close code: https://datatracker.ietf.org/doc/html/rfc6455#section-7.1.5 :obj:`None` if the connection isn't closed yet. N)r1r/rDrABNORMAL_CLOSUREcoderSr)r)r* close_codes  zProtocol.close_codez str | NonecCs(|jtk rdS|jdkrdS|jjSdS)z `WebSocket close reason`_. .. _WebSocket close reason: https://datatracker.ietf.org/doc/html/rfc6455#section-7.1.6 :obj:`None` if the connection isn't closed yet. N)r1r/rDreasonrSr)r)r* close_reasons  zProtocol.close_reasonrcCsf|jtkstd|jdk rD|jdk rD|jjtkrD|jjtkrDt}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/AssertionErrorrDrErUr rrrFrO __cause__)rPexc_typeexcr)r)r* close_excs$  zProtocol.close_excbytes)datar6cCs|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)rIZ feed_datarNrMrPr`r)r)r* receive_datas zProtocol.receive_datacCs$|jjr dS|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)rIeofZfeed_eofrNrMrSr)r)r* receive_eofs zProtocol.receive_eofbool)r`finr6cCsL|jstd|jtk r.td|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) rAr rRr-r r1r;r< send_framerrrPr`rfr)r)r*send_continuations  zProtocol.send_continuationTcCsL|jrtd|jtk r.td|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 framerhN) rAr rRr-r r1r;r<rirrrjr)r)r* send_text3s  zProtocol.send_textcCsL|jrtd|jtk r.td|jj| |_|t t ||dS)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. rlrhN) rAr rRr-r r1r;r<rirrrjr)r)r* send_binaryJs  zProtocol.send_binaryrWstr)rUrXr6cCs|jtk r td|jj|dkrJ|dkr8tdttj d}d}nt||}| }| t t ||jdkszt||_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. rhNrWz#cannot send a reason without a coder0)rRr-r r1r;r<r rrZNO_STATUS_RCVD serializerirrrDrZrEr.rPrUrXcloser`r)r)r* send_closeas   zProtocol.send_closecCs>|jtk r*|jtk r*td|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. rhN) rRr-r.r r1r;r<rirrrar)r)r* send_pings zProtocol.send_pingcCs>|jtk r*|jtk r*td|jj|tt |dS)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. rhN) rRr-r.r r1r;r<rirrrar)r)r* send_pongs zProtocol.send_pongintcCs|jtkrR|tjkrRt||}|}|tt|||_ |j dk rLd|_ t |_|j tkrj|jsj|||_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-rrTrrprirrrErDrFr.r5r'rHsend_eofdiscardrMrNrqr)r)r*fails     z Protocol.failz list[Event]cCs|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. )rJ)rPrJr)r)r*events_receiveds zProtocol.events_receivedz list[bytes]cCs|jg}|_|S)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. )rK)rPrKr)r)r* data_to_sendszProtocol.data_to_sendcCs|jtkp|jdk S)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. N)r1r.rGrSr)r)r*close_expectedszProtocol.close_expectedzGenerator[(None, None, None)]c csz|jEdHr,|jr$|jdtd|jdkr %s)r~rC)r?r3rKrrpr5r(rC)rPrr)r)r*riszProtocol.send_framecCs2|jr td|_|jr"|jd|jtdS)NTz> EOF)rHrZr?r3rKrr rSr)r)r*rws   zProtocol.send_eof)T)T)NrW)rW)r"r#r$r%r-rQpropertyr1setterrVrYr^rbrdrkrmrnrsrtruryrzr{r|rLrxrrirwr)r)r)r*rHs@D %$1GT )1 __future__renumr9r7typingrr exceptionsrrrr r r rCr framesr rrrrrrrrrZhttp11rrZstreamsrrrr__all__EventIntEnumrr'r(rr,r-r.r/r rr)r)r)r*s4   0