B ]bq\@s@ddlmZddlZddlZddlZddlmZmZmZm Z m Z ddl m Z m Z mZmZmZmZddlmZddlmZmZmZmZmZmZmZmZmZddlmZm Z dd l!m"Z"dd lm#Z#m$Z$m%Z%d d d dgZ&e ee efZ'Gdd d ej(Z)e)j*Z*e)j+Z+Gdd d ej(Z,e,j-Z-e,j.Z.e,j/Z/e,j0Z0dZ1Gdd d Z2dS)) 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+4lib/python3.7/site-packages/websockets/connection.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!6sc@seZdZdZeddfdddddd d d Zedd d dZejdddddZedd ddZ edd ddZ edd ddZ dddddZ dd ddZ dddd d!d"ZdIdddd d$d%ZdJdddd d&d'ZdKdd)dd*d+d,Zdddd-d.Zdddd/d0ZdLd1d)dd*d2d3Zd4d d5d6Zd7d d8d9Zdd d:d;ZdZd` for details. iNr r!z Optional[int]zOptional[LoggerLike]None)sidestatemax_sizeloggerreturncCst|_|dkr(td|j}||_|tj |_ ||_ ||_ ||_ d|_d|_d|_g|_d|_d|_d|_d|_d|_d|_t|_g|_g|_||_t|jd|_dS)Nz websockets.F) uuidZuuid4idloggingZ getLoggernamelowerr7Z isEnabledForDEBUGdebugr4r5r6cur_sizeexpect_continuation_frameorigin extensionsZ subprotocol close_rcvd close_sentclose_rcvd_then_sent handshake_exceof_sentrreadereventswritesparseparsernext parser_exc)selfr4r5r6r7r+r+r,__init__Vs0    zConnection.__init__)r8cCs|jS)zm WebSocket connection state. Defined in 4.1, 4.2, 7.1.3, and 7.1.4 of :rfc:`6455`. )_state)rPr+r+r,r5szConnection.state)r5r8cCs |jr|jd|j||_dS)Nz= connection is %s)r?r7r<rR)rPr5r+r+r,r5scCs(|jtk rdS|jdkrdS|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. Ni)r5r1rDcode)rPr+r+r, close_codes  zConnection.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)r5r1rDreason)rPr+r+r, close_reasons  zConnection.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.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) r5r1AssertionErrorrDrErSrr r rFrO __cause__)rPexc_typeexcr+r+r, close_excs    zConnection.close_excbytes)datar8cCs|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_datarNrM)rPr^r+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)rIZfeed_eofrNrM)rPr+r+r, receive_eofs zConnection.receive_eofbool)r^finr8cCs,|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. zunexpected continuation frameN)rAr send_framerr)rPr^rbr+r+r,send_continuationszConnection.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. zexpected a continuation frameN)rArrcrr)rPr^rbr+r+r, send_text,szConnection.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. zexpected a continuation frameN)rArrcrr)rPr^rbr+r+r, send_binaryAszConnection.send_binaryrUstr)rSrVr8cCsh|jrtd|dkr6|dkr&tdtdd}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 zexpected a continuation frameNrUz#cannot send a reason without a codeir2) rArr serializercrrrEr0r5)rPrSrVcloser^r+r+r, send_closeVs  zConnection.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)rcrr)rPr^r+r+r, send_pingvs zConnection.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)rcrr)rPr^r+r+r, send_pongs zConnection.send_pongintcCsp|jtkr@|dkr@t||}|}|tt|||_t|_|j t krX|j sX| | |_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. iN)r5r/rrhrcrrrEr0r4r)rHsend_eofdiscardrMrN)rPrSrVrir^r+r+r,fails   zConnection.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. )rJ)rPrJr+r+r,events_receiveds zConnection.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.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. )rK)rPrKr+r+r, data_to_sendszConnection.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_*()`` 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)r5r0rG)rPr+r+r,close_expectedszConnection.close_expectedzGenerator[(None, None, None)]c csyx|jEdHr.|jr&|jdtd|jdkr>d}n|jdkrP|j}n |j|j}tj|jj |j t k||j dEdH}|jr|jd|| |qWWn,tk r}z|dt|||_Wdd}~XYntk r}z|dt|||_Wdd}~XYntk rX}z$|d|jd |j||_Wdd}~XYn|tk r}z|d t|||_Wdd}~XYnDtk r}z$|jjd d d |d||_Wdd}~XYnXdVtddS)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. Nz< EOFzunexpected end of stream)maskr6rCz< %siiiz at position iz parser failedT)exc_infoiz"parse() shouldn't step after error)rIat_eofr?r7EOFErrorr6r@rrLZ read_exactr4r)rC recv_framerrprgrOUnicodeDecodeErrorrVstartr ExceptionerrorrX)rPr6framer[r+r+r,rLsJ     zConnection.parseccsp|jtk|jkstx|jEdHs2|jqW|jrF|jd|jt krX| t |_ dVtddS)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). Nz< EOFz"discard() shouldn't step after EOF) r4r)rHrXrIrvror?r7r*rnr1r5)rPr+r+r,ro=s  zConnection.discardr)r}r8cCsz|jtks|jtkrD|jdk r&td|jr4d|_n t|j|_n&|jtkr|jdkr`td|jrnd|_n|jt|j7_n|jt krt t |j}| |n|jt krn|jt krXt|j|_|jtkr|jdk std|_|jdk rtd|jtkr.| t t |j|j|_d|_t|_|jtkrB|||_t|jntd|jd|j|dS) z- Process an incoming frame. Nzexpected a continuation framezunexpected continuation frameFzincomplete fragmented messageTzunexpected opcode: Z02x)Zopcoderrr@rrblenr^rrrrrcrrrLrDr5r0rErXrFr/r4r)rnrorMrNrJappend)rPr}Z pong_framer+r+r,rx[sF              zConnection.recv_framecCsT|jtk rtd|jjd|jr2|jd||j|j|j t k|j ddS)Nz#cannot write to a WebSocket in the z statez> %s)rtrC) r5r/r r<r?r7rKrrhr4r*rC)rPr}r+r+r,rcs zConnection.send_framecCs2|jr td|_|jr"|jd|jtdS)NTz> EOF)rHrXr?r7rKrr")rPr+r+r,rns   zConnection.send_eof)T)T)NrU)rU)r$r%r&r'r/rQpropertyr5setterrTrWr\r_r`rdrerfrjrkrlrprqrrrsrLrorxrcrnr+r+r+r,rFs4> &   +DR )3Z __future__renumr;r9typingrrrrr exceptionsr r r r r rrCrZframesrrrrrrrrrZhttp11rrZstreamsrrrr__all__ZEventIntEnumr r)r*r!r.r/r0r1r"rr+r+r+r,s2   ,