` IeEHdZddlmZddlZddlZddlZddlZddlZddlZddl m Z m Z eje ZdZdZGddeZGd d Zej(Zd Zee_Gd d eZGddeZGddZy)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)PY2PY3c eZdZy) CommErrorN)__name__ __module__ __qualname__?/usr/lib/python3/dist-packages/spyder_kernels/comms/commbase.pyr r Jsrr c2eZdZdZdZdZddZdZdZy) CommsErrorWrapperc||_||_tj\|_|_}t j||_yN) call_namecall_idsysexc_infoetypeerror traceback extract_tbtb)selfrrrs r__init__zCommsErrorWrapper.__init__Os8" %(\\^" DJ&&r*rc$|j|)zL Raise the error while adding informations on the callback. )rrs r raise_errorzCommsErrorWrapper.raise_errorUs jjrcdj|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\sW 288HI((12224::tzzJK rNcl|tj}|jD]}t||y)zK Print the error to file or to sys.stderr if file is None. N)file)rstderrr'print)rr)lines r print_errorzCommsErrorWrapper.print_errorfs4 <::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__ssDJJrr) r r r rr!r'r-r0r3r rrrrNs + # rrct|jdk(rPt|jdtr3t j ||jdj yt|||y)Nr)lenargs isinstancerrprint_tbr-sys_excepthook)typevaluers rcomm_excepthookr=|sU 5::! 5::a=:K L2 1 !!#4#rceZdZdZfdZddZddZddZddZdZ ddZ dd Z d Z e d Zd Zd ZdZdZdZdZddZddZdZdZdZdZdZdZdZxZS)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`. c&tt| d|_i|_i|_i|_i|_i|_|jd|j|jd|j|jd|jy)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&(# !#%'"! && 433 5 && !?!? A ""#9#'#<#< >rcZ|%t|jj}|S|g}|S)zGet a list of comms id.)listrFkeysrcomm_idid_lists rget_comm_id_listzCommBase.get_comm_id_lists3 ?4;;++-.GiGrc|j|}|D]0} |j|dj|j|=2y#t$rY?wxYw)z)Close the comm and notify the other side.commN)rVrFcloseKeyErrorrSs rrYzCommBase.closes`''0 G  G$V,224KK(   s-A AAcR|t|jdkDS||jvS)z!Check to see if the comm is open.r)r6rF)rrTs ris_openzCommBase.is_opens* ?t{{#a' '$++%%rc|j|}t|dk(ryt|Dcgc]}|j|ddk(c}Scc}w)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. rFstatusready)rVr6allrF)rrTrUcids ris_readyzCommBase.is_readysO''0 w<1 WMcDKK$X.'9MNNMsA c`|s|jj|dy||j|<y)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_handlers0  & & * *9d ; 07""9-rc t|||fi|S)zGet a handler for remote calls.)RemoteCallFactory)rrTcallbacksettingss rrAzCommBase.remote_calls wEHEErcL|j|s td|j|}|D]r}|||j|dtj d}t j||j|dg}|j|dj||ty)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_typecontentrlpython_version)protocolrX)buffersN) r\r rVrFrversion cloudpickledumpssend)rrmrndatarTrUmsg_dictrqs r _send_messagezCommBase._send_messages"||G$89 9''0 IG#2"#';;w#78I#J"%++ H #((t{{734EFHIG KK  ( - -h - H Irct|tj}||j|jd<d|j|jd<y)z*Set the pickle protocol used to send data.rlr_r^N)minpickleHIGHEST_PROTOCOLrFrE)rrps rrCzCommBase._set_pickle_protocolsGx!8!89?G D(()*;<6= D(()(3rcy)z= Get the name used for the underlying comms. spyder_apir r s r _comm_namezCommBase._comm_names rc`||jj|dy||j|<y)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)rGrd)r message_idres rrKz"CommBase._register_message_handlers2 ?  " " & &z4 8 -4z*rc|j|j|j|j|tdd|j |j <y)z0 Open a new comm to the kernel. opening)rXrlr^N)on_msg _comm_messageon_close _comm_closeDEFAULT_PICKLE_PROTOCOLrFrT)rrXs r_register_commzCommBase._register_commsE D&&' d&&'6% DLL!rc.|dd}|j|=y)z Close comm.rnrTN)rF)rmsgrTs rrzCommBase._comm_close(si.+ KK rc|dd|_|dd} trtj|ddd}ntj|dd}|d}||jvr|j|||y t j d|zy #t$rK}t j dt|zt|dd |dd }d |dd <Yd }~d }~wwxYw)z2 Handle internal spyder messages. rnrTrvrqrzlatin-1)encodingz#Exception in cloudpickle.loads : %srrTis_errorNrmzNo such spyder message type: %s) rErrsloads Exceptionloggerdebugr/rrG)rrrwbuffererms rrzCommBase._comm_message-s #9~i8y>&) 3 %**3y>!+<4=?%**3y>!+<=##45 d44 4 3D " "? 3& " LL:_L M 3 LL5A> @&#K0#I.0F/3HY  + 3s?B C-"AC((C-c|d}|j| |j|d|d|d}|j||y#t$r)t |d|d}|j||dYywxYw) zHandle a remote call.rnr call_args call_kwargsrT)rN)on_incoming_call_remote_callback_set_call_return_valuerr)rrrrw return_value exc_infoss rrLzCommBase._handle_remote_callRsy> h' L00[);'=)+L  ' ', ? L)%x ':D  ),rc,tj|d<|S)zA message is about to be sentpickle_highest_protocol)r{r|rrs ron_outgoing_callzCommBase.on_outgoing_calls/5/F/F +,rc6d|vr|j|dyy)zA call was receivedrN)rCrs rrzCommBase.on_incoming_calls# $ 1  % %i0I&J K 2rcJ|j|}|jd||||d}d|vxr|d}|sy|d}|d}d|vr |d|d}nt}|j||||jj |} | d r|j | 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. rArrirNrrtimeoutrr<)rrxTIMEOUT _wait_replyrIrd _sync_error) rr call_datarTrirrrrreplys r_get_call_return_valuezCommBase._get_call_return_values)))4   99  Z()Bhz.B I&k*   Xi%8%Dy)GG )W5!!%%g.  ##E'N3 3W~rct)z0 Wait for the other side reply. NotImplementedError)rrrrs rrzCommBase._wait_replys "!rcd|d}|d}|d}|d}||jvr9|r|j|Stjdj ||y|jj |\}}|r|s|j|S| |s|||r|||d|j |<yy)z3 A blocking call received a reply. rnrrrz!Got an unexpected reply {}, id:{}N)rr<rn)rJ _async_errorrrr#rdrI) rrwrrnrrrrrhs rrMz"CommBase._handle_remote_call_replys9%)$K( :& $.. .((00 @GGw() !1155g>( H$$V, ,   V   (#&*D  g & rc$|jy)zR Handle an error that was raised on the other side asyncronously. N)r-r error_wrappers rrzCommBase._async_error !!#rc$|jy)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\rbrNrArxrCpropertyrrKrrrrLrrrrrrrrMrr __classcell__rOs@rr?r?s >$ & O8$F AE"I>>  5( ! #NJ LD94? L #J" "H$ $rr?c.eZdZdZfdZdZdZxZS)rgzClass to create `RemoteCall`s.c tt| d|tt| d|tt| d|tt| d|y)N_comms_wrapper_comm_id _callback _settings)rDrg __setattr__)r comms_wrapperrTrhrirOs rrzRemoteCallFactory.__init__sN 2 m - 2:wG 2;I 2;Ircpt||j|j|j|jS)z'Get a call for a function named 'name'.) RemoteCallrrrr)rnames r __getattr__zRemoteCallFactory.__getattr__s,$ 3 3T]]..$..: :rct)z#Set an attribute to the other side.r)rrr<s rrzRemoteCallFactory.__setattr__s!!r)r r r rrrrrrs@rrgrgs(J: "rrgceZdZdZdZdZy)rz:Class to call the other side of the comms like a function.cJ||_||_||_||_||_yr)_namerrrr)rrrrTrhris rrzRemoteCall.__init__ s& + !!rc<d|jvxr|jd}|xs|jdu|jd<tjj}|j ||jd}||d}|j j|js0|r tdtjd|j zy|j j||j|j j|||jS)zw Transmit the call to the other side of the tunnel. The args and kwargs have to be picklable. rNr)rrri)rrrkzCall to unconnected comm: %s)rruuiduuid4hexrrr\rr rrrr)rr7kwargsrrrrs r__call__zRemoteCall.__call__s /NDNN:4N'/'M4>>3M|$**,"" ! ""**4==9 <== LL7$**D E  **9dnnE""99 y$--1 1rN)r r r rrrr rrrrsD"1rr)r __future__rrsr{loggingrrrspyder_kernels.py3compatrr getLoggerr rrr RuntimeErrorr r excepthookr:r=objectr?rgrr rrrs-\&  -   8 $   ' ' V$!i$vi$X ""*&1&1r