U Mf]@sDddlmZddlZddlZddlZddlmZmZmZm Z m Z ddl m Z m Z mZmZmZmZddlmZddlmZmZmZmZmZmZmZmZmZmZddlm Z m!Z!dd l"m#Z#dd lm$Z$m%Z%m&Z&d d d dgZ'e e e!efZ(Gdd d ej)Z*e*j+Z+e*j,Z,Gdd d ej)Z-e-j.Z.e-j/Z/e-j0Z0e-j1Z1dZ2Gdd d Z3dS)) annotationsN) GeneratorListOptionalTypeUnion)ConnectionClosedConnectionClosedErrorConnectionClosedOK InvalidState PayloadTooBig ProtocolError) Extension) OK_CLOSE_CODES OP_BINARYOP_CLOSEOP_CONTOP_PINGOP_PONGOP_TEXTClose CloseCodeFrame)RequestResponse) StreamReader) LoggerLikeOrigin SubprotocolProtocolSideStateSEND_EOFc@seZdZdZed\ZZdS)r!z6A WebSocket connection is either a server or a client.N)__name__ __module__ __qualname____doc__rangeSERVERCLIENTr,r,7/tmp/pip-unpacked-wheel-yzabpfcc/websockets/protocol.pyr!-sc@s eZdZdZed\ZZZZdS)r"z6A WebSocket connection is in one of these four states.N) r%r&r'r(r) CONNECTINGOPENCLOSINGCLOSEDr,r,r,r-r"7sc@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)Nr a6 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_sizeloggerr!r"z Optional[int]zOptional[LoggerLike]None)sider4r5r6returncCst|_|dkr(td|j}||_|tj |_ ||_ ||_ ||_ d|_d|_d|_g|_d|_d|_d|_d|_d|_d|_t|_g|_g|_||_t|jd|_dS)Nz websockets.F) uuidZuuid4idlogging getLoggernamelowerr6 isEnabledForDEBUGdebugr8r4r5cur_sizeexpect_continuation_frameorigin extensionsZ subprotocol close_rcvd close_sentclose_rcvd_then_sent handshake_exceof_sentrreadereventswritesparseparsernext parser_exc)selfr8r4r5r6r,r,r-__init__Ws0    zProtocol.__init__)r9cCs|jS)zm WebSocket connection state. Defined in 4.1, 4.2, 7.1.3, and 7.1.4 of :rfc:`6455`. )_staterSr,r,r-r4szProtocol.state)r4r9cCs |jr|jd|j||_dS)Nz= connection is %s)rBr6r>rU)rSr4r,r,r-r4scCs*|jtk rdS|jdkrtjS|jjSdS)z `WebSocket close code`_. .. _WebSocket close code: https://www.rfc-editor.org/rfc/rfc6455.html#section-7.1.5 :obj:`None` if the connection isn't closed yet. N)r4r2rGrABNORMAL_CLOSUREcoderVr,r,r- close_codes  zProtocol.close_codez Optional[str]cCs(|jtk rdS|jdkrdS|jjSdS)z `WebSocket close reason`_. .. _WebSocket close reason: https://www.rfc-editor.org/rfc/rfc6455.html#section-7.1.6 :obj:`None` if the connection isn't closed yet. N)r4r2rGreasonrVr,r,r- close_reasons  zProtocol.close_reasonr cCsf|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) r4r2AssertionErrorrGrHrXrr r rIrR __cause__)rSexc_typeexcr,r,r- close_excs$  zProtocol.close_excbytes)datar9cCs|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)rLZ feed_datarQrPrSrcr,r,r- receive_datas zProtocol.receive_datacCs|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. Raises: EOFError: if :meth:`receive_eof` was called earlier. N)rLZfeed_eofrQrPrVr,r,r- receive_eofs zProtocol.receive_eofbool)rcfinr9cCs,|jstd| |_|tt||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 frameN)rDr send_framerrrSrcrhr,r,r-send_continuationszProtocol.send_continuationTcCs,|jrtd| |_|tt||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 frameN)rDrrjrrrkr,r,r- send_text/szProtocol.send_textcCs,|jrtd| |_|tt||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. rmN)rDrrjrrrkr,r,r- send_binaryDszProtocol.send_binaryrZstr)rXr[r9cCsj|jrtd|dkr8|dkr&tdttjd}d}nt||}|}|tt|||_ 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 a fragmented message is being sent, if the code isn't valid, or if a reason is provided without a code rmNrZz#cannot send a reason without a coder3) rDrrrZNO_STATUS_RCVD serializerjrrrHr1r4rSrXr[closercr,r,r- send_closeYs  zProtocol.send_closecCs|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. N)rjrrrdr,r,r- send_pingys zProtocol.send_pingcCs|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. N)rjrrrdr,r,r- send_pongs zProtocol.send_pongintcCsr|jtkrB|tjkrBt||}|}|tt|||_ t |_|j t krZ|j sZ|||_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. N)r4r0rrWrrqrjrrrHr1r8r*rKsend_eofdiscardrPrQrrr,r,r-fails    z Protocol.failz List[Event]cCs|jg}|_|S)a7 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: List[Event]: Events read from the connection. )rM)rSrMr,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: List[bytes]: Data to write to the connection. )rN)rSrNr,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: bool: Whether the TCP connection is expected to close soon. N)r4r1rJrVr,r,r-close_expectedszProtocol.close_expectedzGenerator[(None, None, None)]c csz|jEdHr,|jr$|jdtd|jdkr %s)rrF) r4r0r r>rBr6rNrrqr8r+rF)rSrr,r,r-rjs zProtocol.send_framecCs2|jr td|_|jr"|jd|jtdS)NTz> EOF)rKr]rBr6rNrr#rVr,r,r-rxs   zProtocol.send_eof)T)T)NrZ)rZ)r%r&r'r(r0rTpropertyr4setterrYr\rarerfrlrnrortrurvrzr{r|r}rOryrrjrxr,r,r,r-r Gs@D %   +GR )4 __future__renumr<r:typingrrrrr exceptionsr r r r r rrFrframesrrrrrrrrrrZhttp11rrZstreamsrrrr__all__EventIntEnumr!r*r+r"r/r0r1r2r#r r,r,r,r-s4   0