python (3.12.0)
̑eTR & d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
Z
ddlZddlZd Zd Zd#dZ G d dej& ZdZd Z G d
d e
j. Zi Z ej4 d Z ej4 d Z G d d
Z G d d Z d Z G d d Z G d de
jB e Z" G d de Z# G d d Z$d Z%d Z& G d d Z'd Z(e)d k( rdd l*m+Z+ e+d d!" yy)$a RPC Implementation, originally written for the Python Idle IDE
For security reasons, GvR requested that Idle's Python execution server process
connect to the Idle process, which listens for the connection. Since Idle has
only one client per server, this was not a limitation.
+---------------------------------+ +-------------+
| socketserver.BaseRequestHandler | | SocketIO |
+---------------------------------+ +-------------+
^ | register() |
| | unregister()|
| +-------------+
| ^ ^
| | |
| + -------------------+ |
| | |
+-------------------------+ +-----------------+
| RPCHandler | | RPCClient |
| [attribute of RPCServer]| | |
+-------------------------+ +-----------------+
The RPCServer handler class is expected to provide register/unregister methods.
RPCHandler inherits the mix-in class SocketIO, which provides these methods.
See the Idle run.main() docstring for further information on how this was
accomplished in Idle.
Nc h t j | }t |t j sJ |S )z*Return code object from marshal string ms.)marshalloads
isinstancetypesCodeType)mscos ?/BuggyBox/python/3.12.0/bootstrap/lib/python3.12/idlelib/rpc.py
unpickle_coder - s& r B b%.. ))
I c v t | t j sJ t j | }t
|ffS )zBReturn unpickle function and tuple with marshalled co code object.)r r r r dumpsr )r
r s r pickle_coder 3 s. b%.. )) r B 2% r
c t j }t || }|j | |j S )z.Return pickled (or marshalled) string for obj.)ioBytesIO CodePicklerdumpgetvalue)objprotocolfps r r r 9 s2
AAx AFF3K ::<r
c @ e Zd Zej eiej Zy)r N)__name__
__module__ __qualname__r r r copyregdispatch_table r
r r r B s nnkLW5K5KLNr
r i z 127.0.0.1c , e Zd ZddZd Zd Zd Zd Zy) RPCServerNc V |t }t j j | || y N)
RPCHandler socketserver TCPServer__init__)selfaddr handlerclasss r r) zRPCServer.__init__K s% %L ''dLAr
c y)z@Override TCPServer method, no bind() phase for connecting entityNr! r* s r server_bindzRPCServer.server_bindP r
c N | j j | j y)zOverride TCPServer method, connect() instead of listen()
Due to the reversed connection, self.server_address is actually the
address of the Idle Client to which we are connecting.
N)socketconnectserver_addressr. s r server_activatezRPCServer.server_activateT s
D / /0r
c 2 | j | j fS )z:Override TCPServer method, return already connected socket)r2 r4 r. s r get_requestzRPCServer.get_request] s {{D / ///r
c # t $ r t j }t d| t d| t dt j
j z | t d|| t dt | | t j | t d| t d| t j d Y y
xY w) zOverride TCPServer method
Error message goes to __stderr__. No error message if exiting
normally or socket raised EOF. Other exceptions not handled in
server code will cause os._exit.
z)
----------------------------------------filezUnhandled server exception!z
Thread: %szClient Address: z Request: z#
*** Unrecoverable, server exiting!z(----------------------------------------r N)
SystemExitsys
__stderr__print threadingcurrent_threadnamerepr traceback print_excos_exit)r* requestclient_addresserfs r handle_errorzRPCServer.handle_errora s
..C -c * /c : ,!9!9!;!@!@@s K $n3 ? +tG}3 7 S ) 8s C &s # HHQKs
C Cr% )r r r r) r/ r5 r7 rJ r! r
r r# r# I s B
10r
r# c e Zd ZdZd dZd Zd Zd Zd Zd Z d Z
d
Z d Z d Z
d
Zd Zd Zd Zd Zd Zd Zd Zd Zd ZdZdZdZd Zd Z d Z d Z d Z d Z d Z!y)!SocketIOr Nc t j | _ ||| _ || _ |t
}|| _ i | _ i | _ y r% ) r? r@
sockthread debuggingsock objecttableobjtable responsescvars)r* rP rR rO s r r) zSocketIO.__init__ sF #224 &DN "H
r
c P | j }d | _ ||j y y r% )rP close)r* rP s r rV zSocketIO.close s& yy JJL r
c . t j d y)z!override for specific exit actionr N)rE rF r. s r exithookzSocketIO.exithook s
r
c | j sy | j dz t t j j
z }|D ] }|dz t | z } t
|t j y )N r9 ) rO locationstrr? r@ rA r> r< r= )r* argssas r debugzSocketIO.debug sb ~~ MMC #i&>&>&@&E&E"F F !AC#a& A !
acnn%r
c " || j |< y r% )rR )r* oidobjects r registerzSocketIO.register s #
cr
c > | j |= y # t $ r Y y w xY wr% )rR KeyErrorr* rb s r
unregisterzSocketIO.unregister s%
c" s
c | j d| |\ }\ }}}}|| j vrdd|fS | j | }|dk( ri } t || d| fS |dk( ri }
t ||
d|
fS t || sdd|fS t
|| } |d k( r' | |i |} t | t r t | } d| fS |d
k( rt j || ||ff y dd |z fS # t $ r Y yw xY w# t $ r t $ r t $ r t $ r}
d
|
fcY d }
~
S d }
~
w d}t! ||| |fz t" j$ t' j( t" j$ Y yxY w)Nz
localcall:)ERRORzBad request formatrj zUnknown object id: __methods__OK__attributes__zUnsupported method name: CALLQUEUE)QUEUEDNz Unsupported message type: %sCALLEXCzU*** Internal Error: rpc.py:SocketIO.localcall()
Object: %s
Method: %s
Args: %s
r9 ) EXCEPTIONN)r` TypeErrorrR _getmethods_getattributeshasattrgetattrr RemoteObject remoteref
request_queueputr; KeyboardInterruptOSError Exceptionr> r< r= rC rD )r* seqrG howrb
methodnamer] kwargsr methods
attributesmethodretexmsgs r localcallzSocketIO.localcall s
<) 33: 0C0#z4 dmm # 23' :; ;mmC &G W %'? " ) )J 3
+*% %sJ' 8 GH Hj) 'f} d-f- c<0#C.C c{" !!3v(>"?@& !?#!EFF5 32 36 # r? " '<C #fd++#.. A S^^ 4&s<
C# +C2 < C2 C2 # C/.C/2$E-D E- A E-c r | j d|| | j |||| }| j | S )Nzremotecall:asynccall: )r` asynccall asyncreturnr* rb r r] r r s r
remotecallzSocketIO.remotecall s8
+S*=nnS*dF; $$r
c r | j d|| | j |||| }| j | S )Nzremotequeue:asyncqueue: )r`
asyncqueuer r s r remotequeuezSocketIO.remotequeue s8
-sJ?ooc:tV< $$r
c d||||ff}| j }t j | j k7 r#t j }|| j
|< | j
d|z |||| | j ||f |S )Nrn z
asynccall:%d:newseqr? r@ rN ConditionrT r`
putmessager* rb r r] r rG r cvars r r zSocketIO.asynccall s~ CT6:;kkm # # % 8 &&(D "DJJsO
Oc)CT6J g'
r
c d||||ff}| j }t j | j k7 r#t j }|| j
|< | j
d|z |||| | j ||f |S )Nro zasyncqueue:%d:r r s r r zSocketIO.asyncqueue s S*dF ;<kkm # # % 8 &&(D "DJJsO
$s*S*dFK g'
r
c | j d|z | j |d }| j d|z | | j | S )Nz#asyncreturn:%d:call getresponse(): 皙?)waitzasyncreturn:%d:response: )r` getresponsedecoderesponse)r* r responses r r zSocketIO.asyncreturn sN
83>?##Cd#3
/#5A""8,,r
c 0 |\ }}|dk( r|S |dk( ry |dk( r| j d y |dk( r"| j d | j y |dk( r | j d| t | |d k( r| j d
| |t || ) Nrl rp rr zdecoderesponse: EXCEPTIONEOFzdecoderesponse: EOFrj z decoderesponse: Internal ERROR:rq z decoderesponse: Call Exception:)r` decode_interrupthook RuntimeError SystemError)r* r r whats r r zSocketIO.decoderesponse s T $;K (? + JJ2 3 %< JJ, - % % ' '> JJ8$ ? t$ $ ) JJ8$ ?J#t$$r
c t ) )EOFErrorr. s r r z SocketIO.decode_interrupthook s r
c l | j dd y# t $ r | j d Y yw xY w)zListen on socket until I/O not ready or EOF
pollresponse() will loop looking for seq number None, which
never comes, and exit on EOFError.
Nr )myseqr zmainloop:return)r r r` r. s r mainloopzSocketIO.mainloop s9 4d 3 JJ( ) s 33c h | j || }| |\ }}|dk( r|| j | f}|S )Nrl ) _getresponse_proxify)r* r r r r r s r r zSocketIO.getresponse" sB $$UD1 ICd{
d 33r
c t |t rt | |j S t |t r t t | j | S |S r% )r RemoteProxyRPCProxyrb listmapr )r* r s r r zSocketIO._proxify* sB c; 'D#''* * c4 DMM3/0 0
r
c | j d| t j | j u r | j || }||S | j
| }|j
|| j vr |j || j vr | j | }| j d|d| | j |= | j
|= |j |S )Nz_getresponse:myseq:z
_getresponse:z : thread woke up: response: )
r` r? r@ rN pollresponserT acquirerS r release)r* r r r r s r r zSocketIO._getresponse2 s
(%0 # # % 8 ,,UD9'#O ::e$D LLNt~~- t~~-~~e,H JJ x)
*u%
5! LLNOr
c 2 | j dz x| _ }|S )N )nextseq)r* r s r r zSocketIO.newseqH s !\\A -- s
r
c | j d|d z t | }t j dt | |z }t | dkD r^ t j g | j gg \ }}}| j j |d t }||d }t | dkD r]y y # t j $ r' t dt | t j w xY w# t t f$ r t# d w xY w)Nzputmessage:%d:r zCannot pickle:r9 <izsocket no longer exists)r` r pickle
PicklingErrorr> rB r< r= structpacklenselectrP sendBUFSIZEAttributeErrorrs r} )r* messager^ rwxns r r zSocketIO.putmessageL s
#gaj01 gA
KKc!f % )!fqj
9 --TYYK<1aIINN1Xg;/ !"A
!fqj ## "DM G #I.
9 788
9s B3 AC0 3:C-0D r
c | j t | j | j k rt j | j
j
gg g | \ }}}t | dk( ry | j
j t }t | dk( rt | xj |z
c_ | j | j S # t $ r t w xY w)Nr ) _stage0r buffbufneedr rP filenorecvr r} r _stage1)r* r r r r r^ s r
pollpacketzSocketIO.pollpacket` s tyy>DLL ( mmTYY%5%5%7$8"b$GGAq!1v{
IINN7+ 1v{ IINI LLN||~
s 8 C C0c | j dk( rbt | j dk\ rI| j d d }| j dd | _ t j d| d | _ d| _ y y y )Nr r r )bufstater r r unpackr )r* r^ s r r zSocketIO._stage0p sc ==A #dii.A"5 "1
A !"
DI!==q1!4DL DM #6 r
c | j dk( rjt | j | j k\ rG| j d | j }| j | j d | _ d| _ d| _ |S y y )Nr r r )r r r r )r* packets r r zSocketIO._stage1w sg ==A #dii.DLL"@YY} -F $,,-0DI DL DMM #A r
c | j | }|y t j | }|S # t j $ r t dt
j t dt | t
j t j t
j t dt
j w xY w)Nz-----------------------r9 zcannot unpickle packet:)
r r r UnpicklingErrorr> r< r= rB rC print_stack)r* r r r s r pollmessagezSocketIO.pollmessage s & > ll6*G
%% +#.. A +T&\ O ! !s~~ 6 +#.. A s
- BCc t j d }|\ }}|d|ff}| j | | j | }|y |\ }}|d }| j d||fz |dv r\| j d|z | j || }| j d||fz |dk( r| j ||f n|d k( r ||k( r|S | j j |d } | ?| j || j |< | j | j /# t j $ r Y w xY w# t $ r | j Y yt $ r Y yw xY w)
aR Handle messages received on the socket.
Some messages received may be asynchronous 'call' or 'queue' requests,
and some may be responses for other threads.
'call' requests are passed to self.localcall() with the expectation of
immediate execution, during which time the socket is not serviced.
'queue' requests are used for tasks (which may block or hang) to be
processed in a different thread. These requests are fed into
request_queue by self.localcall(). Responses to queued requests are
taken from response_queue and sent across the link with the associated
sequence numbers. Messages in the queues are (sequence_number,
request/response) tuples and code using this module removing messages
from the request_queue is responsible for returning the correct
sequence number in the response_queue.
pollresponse() will loop until a response message with the myseq
sequence number is received, and will save other responses in
self.responses and notify the owning thread.
r rl Nzpollresponse:%d:myseq:%s)rn ro z pollresponse:%d:localcall:call:z%pollresponse:%d:localcall:response:%srn ro )response_queuegetr queueEmptyr r
handle_EOFr r` r rT r rS notifyr )
r* r r qmsgr r r resqr cvs
r r zSocketIO.pollresponse s .
)%))!, !%
X x 01(
**40? # ICq'C JJ1S%L@ A''
<sBC >>#t4
B !8_ - .&=OOS(O4G^ ZZ^^C. >JJL*.DNN3'IIKJJLY ;;
!!
s( D0 E
0EE
E0%E0/E0c $ | j | j d | j D ]P }| j | }|j d| j |< |j |j
R | j y)z+action taken upon link being closed by peerr )r NN)EOFhookr` rT r rS r r rX )r* keyr s r r zSocketIO.handle_EOF sk
< :: CC B JJL"/DNN3 IIK JJL
r
c y)zBClasses using rpc client/server can override to augment EOF actionNr! r. s r r zSocketIO.EOFhook r0 r
)NN)"r r r r r) rV rX r` rd rh r r r r r r r r r r r r r r r r r r r r r r r r r! r
r rL rL s G &$ ,'\%
%
- %* , DGH GR
r
rL c e Zd Zy)rx N)r r r r! r
r rx rx s r
rx c @ t | }| t |< t | S r% )idrQ r )r rb s r ry ry s
S'CK s r
c e Zd Zd Zy)r c || _ y r% )rb rg s r r) zRemoteProxy.__init__ s r
N)r r r r) r! r
r r r s r
r c & e Zd ZdZdZd Zd Zd Zy)r& Fz#Sc | |_ t j | | t j j | ||| y r% )current_handlerrL r) r' BaseRequestHandler)r* rP r+ svrs r r) zRPCHandler.__init__ s4 "$%''00tT3Gr
c $ | j y)z(handle() method required by socketserverN)r r. s r handlezRPCHandler.handle s
r
c t | | S r% r rg s r get_remote_proxyzRPCHandler.get_remote_proxy c""r
N)r r r rO r[ r) r r r! r
r r& r& s IHH
#r
r& c X e Zd ZdZdZdZej ej fdZ d Z
d Z y) RPCClientFz#Cr c t j || | _ | j j | | j j d y Nr )r2 listening_sockbindlisten)r* addressfamilytypes r r) zRPCClient.__init__ s= $mmFD 9 ) ""1%r
c | j j \ }}| j r t d|t j
|d t k( rt j | | y t d|t j
t )Nz ****** Connection request from r9 r z** Invalid host: )
r acceptrO r> r< r= LOCALHOSTrL r) r} )r* working_sockr s r r zRPCClient.accept se $ 3 3 : : < g >> 3W3>> R 1: " dL 1 %wS^^ DMr
c t | | S r% r rg s r r zRPCClient.get_remote_proxy" r r
N) r r r rO r[ r r2 AF_INET SOCK_STREAMr) r r r! r
r r r s/ IHG'-~~F<N<N &
#r
r c , e Zd ZdZdZd Zd Zd Zd Zy)r Nc || _ || _ y r% )sockiorb )r* r rb s r r) zRPCProxy.__init__+ s r
c r | j | j | j j | r!t | j | j
| S | j | j || j v r+| j j | j
d|fi }|S t | )N__getattribute__)
_RPCProxy__methods_RPCProxy__getmethodsr MethodProxyr rb _RPCProxy__attributes_RPCProxy__getattributesr r )r* rA values r __getattr__zRPCProxy.__getattr__/ s >> ! >> d # t{{DHHd; ; $ " 4$$ $KK**4885G,07B8EL & &r
c ^ | j j | j ddi | _ y )Nrm r! )r r rb r r. s r __getattributeszRPCProxy.__getattributes= s' KK 2 24880@"b Jr
c ^ | j j | j ddi | _ y )Nrk r! )r r rb r r. s r __getmethodszRPCProxy.__getmethodsA s& //0=r2Gr
) r r r r r r) r r r r! r
r r r & s" IL ' JGr
r c t | D ] }t | | }t | sd||< ! t | t r | j
D ] }t
|| y y r )dirrw callabler r __bases__rt )r r rA attrsupers r rt rt E sa C sD! D> GDM #t ]] (E w ' ( r
c ^ t | D ] }t | | }t | rd||< ! y r )r rw r )r r rA r! s r ru ru P s2 C !sD!~ Jt !r
c e Zd Zd Zd Zy)r c . || _ || _ || _ y r% )r rb rA )r* r rb rA s r r) zMethodProxy.__init__Y s r
c j | j j | j | j || }|S r% )r r rb rA )r* r] r r s r __call__zMethodProxy.__call__^ s) &&txxD&I r
N)r r r r) r' r! r
r r r W s
r
r c r | ydt _ t | } t j j | t j j d | t _ y# t $ rH d}|j |d }|j |d }t j j | Y {w xY w)z9Override standard display hook to use non-locale encodingNasciibackslashreplacestrict
) builtins_rB r< stdoutwriteUnicodeEncodeErrorencodedecode)r textencodingbytess r displayhookr7 f s }HJ ;D
JJTHJ H&89||Hh/
s A% %AB65B6__main__)mainzidlelib.idle_test.test_rpcr ) verbosityr% ),__doc__r- r r r rE r r r r2 r' r r< r? rC r r r r Picklerr r r r( r# rQ Queuerz r rL rx ry r r r& r r rt ru r r7 r unittestr9 r! r
r <module>r? s& 8
M&.. M . && .d A
Q e
e
R
# 00( #$# #4 G G> (! & z %4 r
Browse
Usage
Versions