o _cq\@s@ddlmZddlZddlZddlZddlmZmZmZm Z m Z ddl m Z m Z mZmZmZmZddlmZddlmZmZmZmZmZmZmZmZmZddlmZm Z dd l!m"Z"dd lm#Z#m$Z$m%Z%gd Z&e ee efZ' Gd d d ej(Z)e)j*Z*e)j+Z+Gdddej(Z,e,j-Z-e,j.Z.e,j/Z/e,j0Z0dZ1 GdddZ2dS)) annotationsN) GeneratorListOptionalTypeUnion)ConnectionClosedConnectionClosedErrorConnectionClosedOK InvalidState PayloadTooBig ProtocolError) Extension) OK_CLOSE_CODES OP_BINARYOP_CLOSEOP_CONTOP_PINGOP_PONGOP_TEXTCloseFrame)RequestResponse) StreamReader) LoggerLikeOrigin Subprotocol) ConnectionSideStateSEND_EOFc@seZdZdZed\ZZdS)r z6A WebSocket connection is either a server or a client.N)__name__ __module__ __qualname____doc__rangeSERVERCLIENTr+r+@/usr/local/lib/python3.10/dist-packages/websockets/connection.pyr ,sr c@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!6sr!c@seZdZdZeddfdLddZedMddZejdNddZedOddZ edPddZ edQddZ dRddZ dSdd Z dTd#d$ZdUdTd&d'ZdUdTd(d)ZdVdWd.d/ZdRd0d1ZdRd2d3ZdXdYd5d6ZdZd8d9Zd[d;d<Zd\d=d>Zd]d@dAZd]dBdCZd^dFdGZd^dHdIZdSdJdKZdS)_ra5 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` to disable 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. iNsider stater!max_size Optional[int]loggerOptional[LoggerLike]returnNonecCst|_ |durtd|j}||_ |tj |_ ||_ ||_ ||_ d|_d|_d|_g|_d|_d|_d|_d|_d|_ d|_t|_g|_g|_||_t|jd|_dS)Nz websockets.F) uuiduuid4idlogging getLoggernamelowerr7 isEnabledForDEBUGdebugr3r4r5cur_sizeexpect_continuation_frameorigin extensionsZ subprotocol close_rcvd close_sentclose_rcvd_then_sent handshake_exceof_sentrreadereventswritesparseparsernext parser_exc)selfr3r4r5r7r+r+r,__init__Vs6    zConnection.__init__cCs|jS)zm WebSocket connection state. Defined in 4.1, 4.2, 7.1.3, and 7.1.4 of :rfc:`6455`. )_staterUr+r+r,r4szConnection.statecCs |jr |jd|j||_dS)Nz= connection is %s)rDr7r@rW)rUr4r+r+r,r4s cC$|jturdS|jdurdS|jjS)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)r4r1rIcoderXr+r+r, close_code  zConnection.close_code Optional[str]cCrY)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)r4r1rIreasonrXr+r+r, close_reasonr]zConnection.close_reasonr cCsf|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.connection.State.CLOSING`; wait until it's :attr:`~websockets.connection.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) r4r1rIrJr[rr r rKrT __cause__)rUexc_typeexcr+r+r, close_excs$  zConnection.close_excdatabytescCs|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)rN feed_datarSrRrUrfr+r+r, receive_datas zConnection.receive_datacCs|jt|jdS)aw 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. - 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)rNfeed_eofrSrRrXr+r+r, receive_eofs zConnection.receive_eoffinboolcCs,|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)rFr send_framerrrUrfrmr+r+r,send_continuationszConnection.send_continuationTcC,|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)rFrrprrrqr+r+r, send_text,zConnection.send_textcCrs)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. rtN)rFrrprrrqr+r+r, send_binaryArvzConnection.send_binaryr_r[r`strcCsh|jrtd|dur|dkrtdtdd}d}n t||}|}|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 rtNr_z#cannot send a reason without a codeir2) rFrr serializerprrrJr0r4rUr[r`closerfr+r+r, send_closeVs   zConnection.send_closecC|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)rprrrir+r+r, send_pingv zConnection.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. N)rprrrir+r+r, send_pongrzConnection.send_pongintcCsp|jtur |dkr t||}|}|tt|||_t|_|j t ur,|j s,| | |_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. rZN)r4r/rryrprrrJr0r3r)rMsend_eofdiscardrRrSrzr+r+r,fails   zConnection.fail List[Event]cC|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. )rO)rUrOr+r+r,events_receiveds zConnection.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.connection.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. )rP)rUrPr+r+r, data_to_sendszConnection.data_to_sendcCs|jtup |jduS)a Tell if the TCP connection is expected to close soon. Call this method immediately after any of the ``receive_*()`` 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)r4r0rLrXr+r+r,close_expectedszConnection.close_expectedGenerator[None, None, None]c cszO |jEdHr|jr|jdtd|jdur d}n|jdur)|j}n|j|j}tj|jj |j t u||j dEdH}|jrK|jd|| |qtym}z|dt|||_WYd}~nd}~wty}z|dt|||_WYd}~ncd}~wty}z|d |jd |j||_WYd}~nBd}~wty}z|d t|||_WYd}~n&d}~wty}z|jjd dd |d||_WYd}~nd}~wwdVtd)z Parse incoming data into frames. :meth:`receive_data` and :meth:`receive_eof` run this generator coroutine until it needs more data or reaches EOF. TN< EOFzunexpected end of stream)maskr5rHz< %sirZiz at position iz parser failed)exc_infoiz"parse() shouldn't step after error)rNat_eofrDr7EOFErrorr5rErrQZ read_exactr3r)rH recv_framerrrxrTUnicodeDecodeErrorr`startr ExceptionerrorAssertionError)rUr5framerdr+r+r,rQs\        zConnection.parseccsx|jtu|jks J|jEdHs |j|jEdHr|jr)|jd|jtur2| 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) r3r)rMrNrrrDr7r*rr1r4rrXr+r+r,r=s   zConnection.discardrrcCsr|jtus |jtur!|jdurtd|jrd|_nt|j|_n|jturA|jdur/td|jr6d|_n{|jt|j7_np|jt urRt t |j}| |n_|jt urXnY|jt urt|j|_|jturs|jduspJd|_|jdur|td|jtur| t t |j|j|_d|_t|_|jtur|||_t|jn td|jd|j|dS) z- Process an incoming frame. NrtroFzincomplete fragmented messageTzunexpected opcode: 02x)opcoderrrErrmlenrfrrrrrprrrQrIr4r0rJrKr/r3r)rrrRrSrrOappend)rUrZ pong_framer+r+r,r[sF              zConnection.recv_framecCsT|jturtd|jjd|jr|jd||j|j|j t u|j ddS)Nz#cannot write to a WebSocket in the z statez> %s)rrH) r4r/r r@rDr7rPrryr3r*rH)rUrr+r+r,rps zConnection.send_framecCs2|jrJd|_|jr|jd|jtdS)NTz> EOF)rMrDr7rPrr"rXr+r+r,rs  zConnection.send_eof) r3r r4r!r5r6r7r8r9r:)r9r!)r4r!r9r:)r9r6)r9r^)r9r )rfrgr9r:)r9r:)rfrgrmrnr9r:)T)Nr_)r[r6r`rxr9r:)r_)r[rr`rxr9r:)r9r)r9r)r9rn)r9r)rrr9r:)r$r%r&r'r/rVpropertyr4setterr\rarerjrlrrrurwr|r~rrrrrrQrrrprr+r+r+r,rFsB C      %      +    D  R r)3 __future__renumr>r;typingrrrrr exceptionsr r r r r rrHrframesrrrrrrrrrZhttp11rrstreamsrrrr__all__EventIntEnumr r)r*r!r.r/r0r1r"rr+r+r+r,s2   ,