dEH(dZddlmZddlZddlZddlZddlZddlZddlZddl m Z m Z ej e ZdZdZGddeZGd d ZejZd Zee_Gd d eZGddeZGddZdS)a Class that handles communications between Spyder kernel and frontend. Comms transmit data in a list of buffers, and in a json-able dictionnary. Here, we only support a buffer list with a single element. The messages exchanged have the following msg_dict: ``` msg_dict = { 'spyder_msg_type': spyder_msg_type, 'content': content, } ``` The buffer is generated by cloudpickle using `PICKLE_PROTOCOL = 2`. To simplify the usage of messaging, we use a higher level function calling mechanism: - The `remote_call` method returns a RemoteCallHandler object - By calling an attribute of this object, the call is sent to the other side of the comm. - If the `_wait_reply` is implemented, remote_call can be called with `blocking=True`, which will wait for a reply sent by the other side. The messages exchanged are: - Function call (spyder_msg_type = 'remote_call'): - The content is a dictionnary { 'call_name': The name of the function to be called, 'call_id': uuid to match the request to a potential reply, 'settings': A dictionnary of settings, } - The buffer encodes a dictionnary { 'call_args': The function args, 'call_kwargs': The function kwargs, } - If the 'settings' has `'blocking' = True`, a reply is sent. (spyder_msg_type = 'remote_call_reply'): - The buffer contains the return value of the function. - The 'content' is a dict with: { 'is_error': a boolean indicating if the return value is an exception to be raised. 'call_id': The uuid from above, 'call_name': The function name (mostly for debugging) } )print_functionN)PY2PY3ceZdZdS) CommErrorN)__name__ __module__ __qualname__=lib/python3.11/site-packages/spyder_kernels/comms/commbase.pyr r JsDrr c4eZdZdZdZdZddZdZdZdS) CommsErrorWrapperc||_||_tj\|_|_}t j||_dSN) call_namecall_idsysexc_infoetypeerror traceback extract_tbtb)selfrrrs r__init__zCommsErrorWrapper.__init__Os<" %(\^^" DJ&r**rc,||)zL Raise the error while adding informations on the callback. )rrs r raise_errorzCommsErrorWrapper.raise_errorUs jjrcd|jgtj|jztj|j|jz}|S)zf Format the error received from the other side and returns a list of strings. zException in comms call {}: )formatrr format_listrformat_exception_onlyrr)rliness r format_errorzCommsErrorWrapper.format_error\sR 288HHI(11224:tzJJK rNcr| tj}|D]}t||dS)zK Print the error to file or to sys.stderr if file is None. N)file)rstderrr'print)rr)lines r print_errorzCommsErrorWrapper.print_errorfsK <:D%%'' # #D $T " " " " " # #rc*t|jS)zGet string representation.)strrr s r__str__zCommsErrorWrapper.__str__os4:rc*t|jS)z Get repr.)reprrr s r__repr__zCommsErrorWrapper.__repr__ssDJrr) r r r rr!r'r-r0r3r rrrrNss+++ ####     rrct|jdkrUt|jdtr5t j||jddSt|||dS)Nr)lenargs isinstancerrprint_tbr-sys_excepthook)typevaluers rcomm_excepthookr=|sq 5:! 5:a=:K L L2 1 !!###4#####rceZdZdZfdZddZddZddZddZdZ dd Z dd Z d Z e d Zd ZdZdZdZdZdZd dZddZdZdZdZdZdZdZdZxZS)!CommBasez Class with the necessary attributes and methods to handle communications between a kernel and a frontend. Subclasses must open a comm and register it with `self._register_comm`. cLtt|d|_i|_i|_i|_i|_i|_| d|j | d|j | d|j dS)N remote_callremote_call_reply_set_pickle_protocol)superr?rcalling_comm_id_comms_message_handlers_remote_call_handlers _reply_inbox_reply_waitlist_register_message_handler_handle_remote_call_handle_remote_call_replyregister_call_handlerrC)r __class__s rrzCommBase.__init__s h&&(((# !#%'"! && 43 5 5 5 && !? A A A ""#9#'#< > > > > >rNc^|'t|j}n|g}|S)zGet a list of comms id.)listrFkeysrcomm_idid_lists rget_comm_id_listzCommBase.get_comm_id_lists0 ?4;++--..GGiGrc||}|D]@} |j|d|j|=1#t$rY=wxYwdS)z)Close the comm and notify the other side.commN)rVrFcloseKeyErrorrSs rrYzCommBase.closes~''00  G  G$V,22444K((       s-A  AAcH|t|jdkS||jvS)z!Check to see if the comm is open.Nr)r6rF)rrTs ris_openzCommBase.is_opens) ?t{##a' '$+%%rc|}t|dkrdStfd|DS)z Check to see if the other side replied. The check is made with _set_pickle_protocol as this is the first call made. If comm_id is not specified, check all comms. rFc>g|]}j|ddkS)statusreadyrF).0cidrs r z%CommBase.is_ready..s*MMMcDK$X.'9MMMr)rVr6allrSs` ris_readyzCommBase.is_readysQ''00 w<<1  5MMMMWMMMNNNrcX|s|j|ddS||j|<dS)a Register a remote call handler. Parameters ---------- call_name : str The name of the called function. handler : callback A function to handle the request, or `None` to unregister `call_name`. N)rHpop)rrhandlers rrNzCommBase.register_call_handlers=   & * *9d ; ; ; F07"9---rc t|||fi|S)zGet a handler for remote calls.)RemoteCallFactory)rrTcallbacksettingss rrAzCommBase.remote_calls wEEHEEErcf||std||}|D]t}|||j|dtjd}t j||j|dg}|j|d||udS)a Publish custom messages to the other side. Parameters ---------- spyder_msg_type: str The spyder message type content: dict The (JSONable) content of the message data: any Any object that is serializable by cloudpickle (should be most things). Will arrive as cloudpickled bytes in `.buffers[0]`. comm_id: int the comm to send to. If None sends to all comms. The comm is not connected.pickle_protocol)spyder_msg_typecontentrppython_version)protocolrX)buffersN) r\r rVrFrversion cloudpickledumpssend)rrqrrdatarTrUmsg_dictrus r _send_messagezCommBase._send_messages"||G$$ :899 9''00 I IG#2"#';w#78I#J"%+ H #(t{734EFHHHIG K  ( - -h - H H H H I Irct|tj}||j|jd<d|j|jd<dS)z*Set the pickle protocol used to send data.rpr`r_N)minpickleHIGHEST_PROTOCOLrFrE)rrts rrCzCommBase._set_pickle_protocolsCx!899?G D()*;<6= D()(333rcdS)z= Get the name used for the underlying comms. spyder_apir r s r _comm_namezCommBase._comm_names |rcX||j|ddS||j|<dS)a Register a message handler. Parameters ---------- message_id : str The identifier for the message handler : callback A function to handle the message. This is called with 3 arguments: - msg_dict: A dictionary with message information. - buffer: The data transmitted in the buffer Pass None to unregister the message_id N)rGrh)r message_idris rrKz"CommBase._register_message_handlers: ?  " & &z4 8 8 8 F-4z***rc||j||j|tdd|j|j<dS)z0 Open a new comm to the kernel. opening)rXrpr_N)on_msg _comm_messageon_close _comm_closeDEFAULT_PICKLE_PROTOCOLrFrT)rrXs r_register_commzCommBase._register_commsR D&''' d&'''6%% DL!!!rc2|dd}|j|=dS)z Close comm.rrrTNra)rmsgrTs rrzCommBase._comm_close(s i.+ K rcV|dd|_|dd} tr#tj|ddd}n tj|dd}nt#t$rg}t dt|zt|dd |dd }d |dd <Yd }~nd }~wwxYw|d}||j vr|j |||d St d|zd S)z2 Handle internal spyder messages. rrrTrzrurzlatin-1)encodingz#Exception in cloudpickle.loads : %srrTis_errorNrqzNo such spyder message type: %s) rErrwloads Exceptionloggerdebugr/rrG)rrr{buffererqs rrzCommBase._comm_message-sl #9~i8y>&) 3 > %*3y>!+<4=???%*3y>!+<== 3 3 3 LL5A> @ @ @&#K0#I.00F/3HY  + + + + + + 3##45 d4 4 4 3D "? 3& " " " " " LL:_L M M M M MsA A.. C8ACCcJ|d}|| ||d|d|d}|||dS#t$r8t |d|d}|||dYdSwxYw) zHandle a remote call.rrr call_args call_kwargsrT)rN)on_incoming_call_remote_callback_set_call_return_valuerr)rrrr{ return_value exc_infoss rrLzCommBase._handle_remote_callRsy> h''' L00[);'=)++L  ' ', ? ? ? ? ? L L L)%x ':<B"!B"c^||jvr|j||i|Std|z)z/Call the callback function for the remote call.zNo such spyder call type: %s)rHr )rrrrs rrzCommBase._remote_callbackasM 2 2 284-i8+)++ +6BCCCrFc|d}d|vo|d}|r|r|d|vo|d}|sdS||d|dd}|d|||j dS) zq A remote call has just been processed. This will reply if settings['blocking'] == True rm display_error send_replyNrr)rrrrBrrrzrT)r-r|rE)r call_dictrzrrmrrrrs rrzCommBase._set_call_return_valueis Z((H43!/2           !X-H(<2H   F  +";/   .d#'#7  9 9 9 9 9rcb|d}d|vo|d}|d}|s|||f|j|<dSdS)zI Register the call so the reply can be properly treated. rmblockingrN)rJ)rrrlrmrrs r_register_callzCommBase._register_callsYZ()Bhz.BI&  ?x+,4h,>D  ) ) ),+rc$tj|d<|S)zA message is about to be sentpickle_highest_protocol)rrrrs ron_outgoing_callzCommBase.on_outgoing_calls/5/F +,rcHd|vr||ddSdS)zA call was receivedrN)rCrs rrzCommBase.on_incoming_calls5 $ 1 1  % %i0I&J K K K K K 2 1rc||}|d||||d}d|vo|d}|sdS|d}|d}d|vr|d |d}nt}|||||j|} | d r|| d S| d S) z Send a remote call and return the reply. If settings['blocking'] == True, this will wait for a reply and return the replied value. rArrmrNrrtimeoutrr<)rr|TIMEOUT _wait_replyrIrh _sync_error) rr call_datarTrmrrrrreplys r_get_call_return_valuezCommBase._get_call_return_values)))44   99    Z()Bhz.B  FI&k*   Xi%8%Dy)GGG )W555!%%g..   4##E'N33 3W~rct)z0 Wait for the other side reply. NotImplementedError)rrrrs rrzCommBase._wait_replys "!rc|d}|d}|d}|d}||jvrG|r||Std||dS|j|\}}|r|s||S| |s |||r|||d|j|<dSdS)z3 A blocking call received a reply. rrrrrz!Got an unexpected reply {}, id:{}N)rr<rr)rJ _async_errorrrr#rhrI) rr{rrrrrrrrls rrMz"CommBase._handle_remote_call_replys9%)$K( :& $. . . )((000 @GGw(())) F!155g>>(  -H -$$V,, ,    HV      (#&**D g & & &  rc.|dS)zR Handle an error that was raised on the other side asyncronously. N)r-r error_wrappers rrzCommBase._async_error !!#####rc.|dS)zQ Handle an error that was raised on the other side syncronously. N)r!rs rrzCommBase._sync_errorrrr)NN)NNN)F)r r r __doc__rrVrYr\rfrNrAr|rCpropertyrrKrrrrLrrrrrrrrMrr __classcell__rOs@rr?r?s >>>>>$    &&&& O O O O888$FFFF AE"IIII>>>> X 555(   !!! #N#N#NJ L L LDDD99994???? LLL ###J""" """H$$$ $$$$$$$rr?c.eZdZdZfdZdZdZxZS)rkzClass to create `RemoteCall`s.c Ptt|d|tt|d|tt|d|tt|d|dS)N_comms_wrapper_comm_id _callback _settings)rDrk __setattr__)r comms_wrapperrTrlrmrOs rrzRemoteCallFactory.__init__s &&22 m - - - &&22:wGGG &&22;III &&22;IIIIIrcPt||j|j|j|jS)z'Get a call for a function named 'name'.) RemoteCallrrrr)rnames r __getattr__zRemoteCallFactory.__getattr__s($ 3T].$.:: :rct)z#Set an attribute to the other side.r)rrr<s rrzRemoteCallFactory.__setattr__s!!r)r r r rrrrrrs@rrkrksa((JJJJJ::: """""""rrkceZdZdZdZdZdS)rz:Class to call the other side of the comms like a function.cL||_||_||_||_||_dSr)_namerrrr)rrrrTrlrms rrzRemoteCall.__init__ s* + !!rcd|jvo |jd}|p|jdu|jd<tjj}|j||jd}||d}|j|js5|rtdt d|jzdS|j ||j|j |||jS)zw Transmit the call to the other side of the tunnel. The args and kwargs have to be picklable. rNr)rrrm)rrrozCall to unconnected comm: %s)rruuiduuid4hexrrr\rr rrrr)rr7kwargsrrrrs r__call__zRemoteCall.__call__s /NDN:4N'/'M4>3M|$*,," ! "**4=99  > <=== LL7$*D E E E F **9dnEEE"99 y$-11 1rN)r r r rrrr rrrrs8DD"""11111rr)r __future__rrwrloggingrrrspyder_kernels.py3compatrr getLoggerr rrr RuntimeErrorr r excepthookr:r=objectr?rkrr rrrs--\&%%%%%  --------  8 $ $         ' ' ' ' ' ' ' ' V$$$!i$i$i$i$i$vi$i$i$X """"""""*&1&1&1&1&1&1&1&1&1&1r