U lu fIX@s dZddlmZddlZddlZddlZddlZddlZddl Z ddl m Z ddl m Z ddlZddlmZmZmZmZmZmZmZmZddlmZddlmZd d lmZd d lmZm Z d d l!m"Z"d d l#m$Z$m%Z%m&Z&Gddde'Z(dddddZ)GdddeZ*Gddde*Z+dS)z%A kernel manager for multiple kernels) annotationsNwraps)Path)AnyBoolDictDottedObjectNameInstanceUnicodedefaultobserve)LoggingConfigurable) import_item)KernelConnectionInfo)NATIVE_KERNEL_NAMEKernelSpecManager) KernelManager) ensure_asyncrun_syncutcnowc@s eZdZdS)DuplicateKernelErrorN)__name__ __module__ __qualname__rrE/tmp/pip-unpacked-wheel-naub1w99/jupyter_client/multikernelmanager.pyrsr t.Callable)freturncs&tddddddfdd }|S)zDdecorator for proxying MKM.method(kernel_id) to individual KMs by IDt.Anystrzt.Callable | t.Awaitable)self kernel_idargskwargsr cs6||}t|j}|||}||f|||SN) get_kernelgetattrr)r#r$r%r&kmmethodrrrrwrapped!s    zkernel_method..wrappedr)rr.rr-r kernel_methodsr/cseZdZdZeeddjddZee ddZ e dddjddZ e d d d d d dZeddZedddddZddddZedddjddZedZedZeZeddddZedddddZed Zed!ddZeZd d d d"fd#d$ Z d dfd%d& Z!d'dd(d)Z"d*dd+d,Z#d-d.d/d0d1Z$d2d d3d4d5d6Z%d-d7d d8d9d:Z&d-d;dd?Z'd-de/d-dod/dpdqZ?e/dd-drdsdtdudvZ@e/dd-drdsdtdwdxZAe/dd-drdsdtdydzZBe/dd-drdsdtd{d|ZCe/dd-drdsdtd}d~ZDd d-dddZEZFS)MultiKernelManagerz&A class for managing multiple kernels.z'The name of the default kernel to starthelpTconfig) allow_nonez)jupyter_client.ioloop.IOLoopKernelManagerzThe kernel manager class. This is configurable to allow subclassing of the KernelManager for customized behavior. kernel_manager_classr!None)changer cCs||_dSr')_create_kernel_manager_factorykernel_manager_factory)r#r8rrr_kernel_manager_class_changedCsz0MultiKernelManager._kernel_manager_class_changedz)this is kernel_manager_class after importr:rr cCs|Sr')r9r#rrr_kernel_manager_factory_defaultIsz2MultiKernelManager._kernel_manager_factory_defaultcs&tjddddfdd }|S)Nr!rr%r&r cs4jr&jjr_|dj||}|S)Ncontext)shared_contextr@closed_context_default setdefault)r%r&r*Zkernel_manager_ctorr#rrcreate_kernel_managerPs   zPMultiKernelManager._create_kernel_manager_factory..create_kernel_manager)rr6)r#rFrrErr9Ms  z1MultiKernelManager._create_kernel_manager_factoryz4Share a single zmq.Context to talk to all my kernelsz zmq.ContextFdictcCs|jS)z#A shim for backwards compatibility.)_pending_kernelsr=rrr_starting_kernelsfsz$MultiKernelManager._starting_kernelsr@cCsd|_tSNT)_created_contextzmqContextr=rrrrCksz#MultiKernelManager._context_defaultNr?cstj||i|_dSr')super__init__kernel_id_to_connection_file)r#r%r& __class__rrrPuszMultiKernelManager.__init__cs^|jr2|jr2|jjs2|jr(|jd||jz tj}Wntk rRYnX|dS)z:Handle garbage collection. Destroy context if applicable.zDestroying zmq context for %sN) rKr@rBlogdebugdestroyrO__del__AttributeError)r#Z super_delrRrrrWys  zMultiKernelManager.__del__z list[str]c Csd|jdk rVt|j}|rVdd|D}t|j}t|j}t|jD]*}||kr\|||}|j|=|j |=q\|D]}||jkrqzt | }Wnt k rYqYnX|jd|d|krd|ksq|}||j|<|j||jdd}||t|_d |_d |_||_|d|_|jd||j |<qt|j S) z6Return a list of the kernel ids of the active kernels.NcSsg|]}|r|qSr)is_file).0prrr sz6MultiKernelManager.list_kernel_ids..zLoading connection file %s kernel_namekeyF)parentrTZ owns_kernelZidler)external_connection_dirris_diriterdirlistrQkeysvaluesindex_kernelsjsonloads read_text ExceptionrTrU new_kernel_idr:Zload_connection_inforZ last_activityZexecution_state connectionsr$r]readyZ set_result) r#r`Zconnection_fileskvconnection_filer$Zconnection_infor*rrrlist_kernel_idssN          z"MultiKernelManager.list_kernel_idsintcCs t|S)z%Return the number of running kernels.)lenrrr=rrr__len__szMultiKernelManager.__len__r"bool)r$r cCs ||jkSr')rgr#r$rrr __contains__szMultiKernelManager.__contains__z str | Noneztuple[KernelManager, str, str])r]r&r cCs|d|jf|}||kr(td||dkr6|j}i}|jrJ|j|d<|jftj|j d|||j |d|}|||fS)Nr$zKernel already exists: %skernel_spec_managerzkernel-%s.json)rqr_rTr]) poprlrdefault_kernel_nameryr:ospathjoinconnection_dirrT)r#r]r&r$Zconstructor_kwargsr*rrrpre_start_kernels"  z#MultiKernelManager.pre_start_kernelzt.Dict[str, str])r$envr cCs||kr|j|j|ddS)z Allow to update the environment of the given kernel. Forward the update env request to the corresponding kernel. .. version-added: 8.5 )rN)rg update_env)r#r$rrrrrszMultiKernelManager.update_envrz t.Awaitable)r$r*kernel_awaitabler c sZz&|IdH||j|<|j|dWn.tk rT}z|j|W5d}~XYnXdSr')rgrHrzrkrT exception)r#r$r*rerrr_add_kernel_when_readys   z)MultiKernelManager._add_kernel_when_ready)r$rr c sZz&|IdH|||j|dWn.tk rT}z|j|W5d}~XYnXdSr') remove_kernelrHrzrkrTr)r#r$rrrrr_remove_kernel_when_readys   z,MultiKernelManager._remove_kernel_when_readycCs t|ddS)zReturns a boolean; a clearer method for determining if this multikernelmanager is using pending kernels or not use_pending_kernelsF)r)r=rrr_using_pending_kernelssz)MultiKernelManager._using_pending_kernels)r]cs|||\}}}t|ts4|jdj|jjd||d<t|j f|}t | |||}||j |<|r~||j|<n|IdH|jr|j|S)zStart a new kernel. The caller can pick a kernel_id by passing one in as a keyword arg, otherwise one will be generated using new_kernel_id(). The kernel ID for the newly started kernel is returned. zHKernel manager class ({km_class}) is not an instance of 'KernelManager'!)Zkm_classr$N)r isinstancerrTwarningformatr6rSr start_kernelasyncioZ create_taskrrHrrgrnr)r#r]r&r*r$Zstartertaskrrr_async_start_kernels"      z&MultiKernelManager._async_start_kernelz bool | None)r$nowrestartr cs |jd|||jkr|j|}z.|IdH||}ttj|jIdHWn4tj k rfYn t k r| |YdSX||}|j s|j r| |dSt|||}t|||}||j|<|s|IdH|j r|j dS)a3Shutdown a kernel by its kernel uuid. Parameters ========== kernel_id : uuid The id of the kernel to shutdown. now : bool Should the kernel be shutdown forcibly using a signal. restart : bool Will the kernel be restarted? Kernel shutdown: %sN)rTinforHr(tcastrZFuturernCancelledErrorrkrZ cancelledrrshutdown_kernelZ ensure_futurerr)r#r$rrrr*ZstopperZfutrrr_async_shutdown_kernel!s.           z)MultiKernelManager._async_shutdown_kernel)r$rr cCsdS)z,Ask a kernel to shut down by its kernel uuidNrr#r$rrrrrequest_shutdownPsz#MultiKernelManager.request_shutdown皙?z float | None)r$waittime pollintervalr cCs|jd|dS)zDWait for a kernel to finish shutting down, and kill it if it doesn'trNrTr)r#r$rrrrrfinish_shutdownTsz"MultiKernelManager.finish_shutdowncCsdS)zClean up a kernel's resourcesNrrrrrcleanup_resources^sz$MultiKernelManager.cleanup_resourcescCs|j|dS)zremove a kernel from our mapping. Mainly so that a kernel can be removed if it is already dead, without having to call shutdown_kernel. The kernel object is returned, or `None` if not found. N)rgrzrwrrrrbsz MultiKernelManager.remove_kernel)rr c s}|tj7}tj}fddt|D}tj|IdHr|D]N}z|j IdHWqXtj k rj|j  YqXt k rYqXXqXdS)zShutdown all kernels.csg|]}j|dqS)r)r)rZZkidrr#rrr\qsz:MultiKernelManager._async_shutdown_all..N)rrrcrHrgresetrZgatherrrnrr$cancelrk)r#rZkidsZkmsZfutsr*rrr_async_shutdown_alllsz&MultiKernelManager._async_shutdown_allcCs:||}|js d}t||}|jd||S)zInterrupt (SIGINT) the kernel by its uuid. Parameters ========== kernel_id : uuid The id of the kernel to interrupt. z/Kernel is in a pending state. Cannot interrupt.zKernel interrupted: %s)r(rndone RuntimeErrorinterrupt_kernelrTr)r#r$kernelmsgoutrrrrs  z#MultiKernelManager.interrupt_kernel)r$signumr cCs|jd||dS)aRSends a signal to the kernel by its uuid. Note that since only SIGTERM is supported on Windows, this function is only useful on Unix systems. Parameters ========== kernel_id : uuid The id of the kernel to signal. signum : int Signal number to send kernel. zSignaled Kernel %s with %sNr)r#r$rrrr signal_kernelsz MultiKernelManager.signal_kernel)r$rr csP||}|r(|js(d}t|t|j|dIdH|jd|dS)aERestart a kernel by its uuid, keeping the same ports. Parameters ========== kernel_id : uuid The id of the kernel to interrupt. now : bool, optional If True, the kernel is forcefully restarted *immediately*, without having a chance to do any cleanup action. Otherwise the kernel is given 1s to clean up before a forceful restart is issued. In all cases the kernel is restarted, the only difference is whether it is given a chance to perform a clean shutdown or not. z-Kernel is in a pending state. Cannot restart.rNzKernel restarted: %s) r(rrnrrrrestart_kernelrTr)r#r$rrrrrr_async_restart_kernels  z(MultiKernelManager._async_restart_kernelcCsdS)zIs the kernel alive. This calls KernelManager.is_alive() which calls Popen.poll on the actual kernel subprocess. Parameters ========== kernel_id : uuid The id of the kernel. Nrrwrrris_aliveszMultiKernelManager.is_alivecCs||krtd|dS)zcheck that a kernel id is validzKernel with id not found: %sN)KeyErrorrwrrr_check_kernel_idsz#MultiKernelManager._check_kernel_idcCs|||j|S)zGet the single KernelManager object for a kernel by its uuid. Parameters ========== kernel_id : uuid The id of the kernel. )rrgrwrrrr(s zMultiKernelManager.get_kernelr)r$callbackeventr cCsdS)z&add a callback for the KernelRestarterNrr#r$rrrrradd_restart_callbacksz'MultiKernelManager.add_restart_callbackcCsdS)z)remove a callback for the KernelRestarterNrrrrrremove_restart_callbacksz*MultiKernelManager.remove_restart_callbackzdict[str, t.Any]cCsdS)aReturn a dictionary of connection data for a kernel. Parameters ========== kernel_id : uuid The id of the kernel. Returns ======= connection_dict : dict A dict of the information needed to connect to a kernel. This includes the ip address and the integer port numbers of the different channels (stdin_port, iopub_port, shell_port, hb_port). Nrrwrrrget_connection_infosz&MultiKernelManager.get_connection_infoz bytes | Nonez socket.socket)r$identityr cCsdS)a6Return a zmq Socket connected to the iopub channel. Parameters ========== kernel_id : uuid The id of the kernel identity : bytes (optional) The zmq identity of the socket Returns ======= stream : zmq Socket or ZMQStream Nrr#r$rrrr connect_iopubsz MultiKernelManager.connect_iopubcCsdS)a6Return a zmq Socket connected to the shell channel. Parameters ========== kernel_id : uuid The id of the kernel identity : bytes (optional) The zmq identity of the socket Returns ======= stream : zmq Socket or ZMQStream Nrrrrr connect_shellsz MultiKernelManager.connect_shellcCsdS)a8Return a zmq Socket connected to the control channel. Parameters ========== kernel_id : uuid The id of the kernel identity : bytes (optional) The zmq identity of the socket Returns ======= stream : zmq Socket or ZMQStream Nrrrrrconnect_controlsz"MultiKernelManager.connect_controlcCsdS)a6Return a zmq Socket connected to the stdin channel. Parameters ========== kernel_id : uuid The id of the kernel identity : bytes (optional) The zmq identity of the socket Returns ======= stream : zmq Socket or ZMQStream Nrrrrr connect_stdin)sz MultiKernelManager.connect_stdincCsdS)a3Return a zmq Socket connected to the hb channel. Parameters ========== kernel_id : uuid The id of the kernel identity : bytes (optional) The zmq identity of the socket Returns ======= stream : zmq Socket or ZMQStream Nrrrrr connect_hb;szMultiKernelManager.connect_hb)r&r cKs ttS)z Returns the id to associate with the kernel for this request. Subclasses may override this method to substitute other sources of kernel ids. :param kwargs: :return: string-ized version 4 uuid )r"uuidZuuid4)r#r&rrrrlMsz MultiKernelManager.new_kernel_id)FF)F)Nr)F)F)F)r)r)N)N)N)N)N)Grrr__doc__r rtagr{r rryr r6r r;rr:r r>r9rrAr@rKrrHpropertyrIrCrr`rgrPrWrrrurxrrrrrrrrrrr/rrrrr shutdown_allrrrrrrr(rrrrrrrrrl __classcell__rrrRrr03s    3   !-    r0c@seZdZUeddddZedddjddZed Z e d d d d d Z e j Zded<e jZded<e jZded<e jZded<dS)AsyncMultiKernelManagerz.jupyter_client.ioloop.AsyncIOLoopKernelManagerTzThe kernel manager class. This is configurable to allow subclassing of the AsyncKernelManager for customized behavior. )r4r2FzWhether to make kernels available before the process has started. The kernel has a `.ready` future which can be awaited before connectingr1r3zzmq.asyncio.Contextr@r<cCsd|_tjSrJ)rKrLrrMr=rrrrChsz(AsyncMultiKernelManager._context_defaultzt.Callable[..., t.Awaitable]rrrrN)rrrr r6rrrr r@r rCr0rr__annotations__rrrrrrrrrrrWs$ r),r __future__rrrhr|sockettypingrr functoolsrpathlibrrLZ traitletsrrrr r r r r Ztraitlets.config.configurablerZtraitlets.utils.importstringrconnectrZ kernelspecrrmanagerrutilsrrrrkrr/r0rrrrrs2   (    (