a
i9, @ sD d Z ddlZddlmZ G dd dejZG dd dZdd ZdS )
a A class supporting chat-style (command/response) protocols.
This class adds support for 'chat' style protocols - where one side
sends a 'command', and the other sends a response (examples would be
the common internet protocols - smtp, nntp, ftp, etc..).
The handle_read() method looks at the input stream for the current
'terminator' (usually '\r\n' for single-line responses, '\r\n.\r\n'
for multi-line output), calling self.found_terminator() on its
receipt.
for example:
Say you build an async nntp client using this class. At the start
of the connection, you'll have self.terminator set to '\r\n', in
order to process the single-line greeting. Just before issuing a
'LIST' command you'll set it to '\r\n.\r\n'. The output of the LIST
command will be accumulated (using your own 'collect_incoming_data'
method) up to the terminator, and then control will be returned to
you - by calling your self.found_terminator() method.
N)dequec @ s e Zd ZdZdZdZdZdZd(ddZdd Z d
d Z
d d
Z dd Z dd Z
dd Zdd Zdd Zdd Zdd Zd d Zd d Zd d! Zd"d# Zd$d% Zd&d' ZdS ))
async_chatzThis is an abstract class. You must derive from this class, and add
the two methods collect_incoming_data() and found_terminator()i r zlatin-1Nc C s( d| _ g | _t | _tj| || d S N ) ac_in_bufferincomingr
producer_fifoasyncore
dispatcher__init__)selfsockmap r /usr/lib64/python3.9/asynchat.pyr C s zasync_chat.__init__c C s t dd S Nz must be implemented in subclassNotImplementedErrorr datar r r collect_incoming_dataQ s z async_chat.collect_incoming_datac C s | j | d S N)r appendr r r r _collect_incoming_dataT s z!async_chat._collect_incoming_datac C s d | j}| jd d = |S r )joinr )r dr r r _get_dataW s zasync_chat._get_datac C s t dd S r r r r r r found_terminator\ s zasync_chat.found_terminatorc C sB t |tr | jr t|| j}nt |tr8|dk r8td|| _dS )zdSet the input delimiter.
Can be a fixed string of any length, an integer, or None.
r z-the number of received bytes must be positiveN)
isinstancestr use_encodingbytesencodingint
ValueError
terminator)r Ztermr r r set_terminator_ s
zasync_chat.set_terminatorc C s | j S r )r& r r r r get_terminatorj s zasync_chat.get_terminatorc C s z| | j}W n. ty$ Y d S ty> | Y d S 0 t|tr\| jr\tt| j }| j
| | _
| j
rt | j
}| }|s|
| j
d| _
qht|tr|}||k r|
| j
d| _
| j| | _n2|
| j
d | | j
|d | _
d| _| qht |}| j
|}|dkr`|dkrB|
| j
d | | j
|| d | _
| qht| j
|}|r||kr|
| j
d | | j
| d | _
qqh|
| j
d| _
qhd S )Nr r )recvac_in_buffer_sizeBlockingIOErrorOSError handle_errorr r r! r" r# r lenr( r r$ r& r findfind_prefix_at_end)r r Zlbr& nZterminator_lenindexr r r handle_readr sR
zasync_chat.handle_readc C s | d S r )
initiate_sendr r r r handle_write s zasync_chat.handle_writec C s | d S r )closer r r r handle_close s zasync_chat.handle_closec C sx t |tttfs tdt|| j}t||kr`tdt||D ] }| j
|||| q@n | j
| | d S )Nz#data argument must be byte-ish (%r)r ) r r" bytearray
memoryview TypeErrortypeac_out_buffer_sizer/ ranger r r5 )r r Zsabsir r r push s zasync_chat.pushc C s | j | | d S r )r r r5 )r Zproducerr r r push_with_producer s z async_chat.push_with_producerc C s dS )z4predicate for inclusion in the readable for select() r r r r r readable s zasync_chat.readablec C s | j p | j S )z4predicate for inclusion in the writable for select())r connectedr r r r writable s zasync_chat.writablec C s | j d dS )zAautomatically close this channel once the outgoing queue is emptyN)r r r r r r close_when_done s zasync_chat.close_when_donec C s | j r| jr| j d }|s:| j d= |d u r:| d S | j}z|d | }W n8 ty | }|rx| j | n| j d= Y q Y n0 t|tr| j rt
|| j }z| |}W n t
y | Y d S 0 |r|t|k s|t|k r||d | j d< n| j d= d S d S )Nr )r rD r8 r= r; more
appendleftr r r! r" r# sendr- r. r/ )r firstZobsr Znum_sentr r r r5 s8
zasync_chat.initiate_sendc C s d| _ | jd d = | j d S r )r r r clearr r r r discard_buffers s zasync_chat.discard_buffers)NN)__name__
__module__ __qualname____doc__r+ r= r! r# r r r r r r' r( r4 r6 r8 r@ rA rC rE rF r5 rL r r r r r 4 s,
H (r c @ s e Zd ZdddZdd ZdS )simple_producer c C s || _ || _d S r )r buffer_size)r r rS r r r r s zsimple_producer.__init__c C sJ t | j| jkr6| jd | j }| j| jd | _|S | j}d| _|S d S r )r/ r rS )r resultr r r rG s zsimple_producer.moreN)rR )rM rN rO r rG r r r r rQ s
rQ c C s0 t |d }|r,| |d | s,|d8 }q |S )NrB )r/ endswith)ZhaystackZneedlelr r r r1 / s
r1 )rP r collectionsr r
r rQ r1 r r r r