B \XM @s4dZddlmZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl m Z ddl Z ddl mZddlmZddlmZdd lmZmZmZmZdd lmZmZmZmZmZmZdd lm Z m!Z!dddZ"dddZ#dddZ$e j%e j&e j'e j&e j&dZ(dddDZ)GdddeZ*dddgZ+dS) zUtilities for connecting to jupyter kernels The :class:`ConnectionFileMixin` class in this module encapsulates the logic related to writing and reading connections files. )absolute_importN)getpass)LoggingConfigurable) localhost)filefind) bytes_to_str cast_bytescast_bytes_py2 string_types)BoolIntegerUnicodeCaselessStrEnumInstanceType)jupyter_data_dirjupyter_runtime_dirtcp hmac-sha256c  Cs|s t}|s&td\} }t| g} t|dkt|dkt|dkt|dkt|dk} |dkrxBt| D]6}t}|tj tj d| |df| |qxWxt | D]$\}}|d}||| |<qWnPd}xJt| D]>}x&tjd|t|fr|d7}qW| ||d7}qW|dkrJ| d}|dkr^| d}|dkrr| d}|dkr| d}|dkr| d}t|||||d}||d<t||d <||d <| |d <| |d <t|d }|tj|ddWdQRXttdr|g}tj|}|r0| |x|D]}t|j}|tjB}||kr6yt||WnRtk r}z2|j t j!kr||krnt"#d||ft$Wdd}~XYnXq6W||fS)aGenerates a JSON config file, including the selection of random ports. Parameters ---------- fname : unicode The path to the file to write shell_port : int, optional The port to use for ROUTER (shell) channel. iopub_port : int, optional The port to use for the SUB channel. stdin_port : int, optional The port to use for the ROUTER (raw input) channel. control_port : int, optional The port to use for the ROUTER (control) channel. hb_port : int, optional The port to use for the heartbeat REP channel. ip : str, optional The ip address the kernel will bind to. key : str, optional The Session key used for message authentication. signature_scheme : str, optional The scheme used for message authentication. This has the form 'digest-hash', where 'digest' is the scheme used for digests, and 'hash' is the name of the hash function used by the digest scheme. Currently, 'hmac' is the only supported digest scheme, and 'sha256' is the default hash function. kernel_name : str, optional The name of the kernel currently connected to. z.jsonrrsrz%s-%s) shell_port iopub_port stdin_port control_porthb_portipkey transportsignature_scheme kernel_namew)indentNS_ISVTXzmFailed to set sticky bit on %r: %s Probably not a big deal, but runtime files may be cleaned up periodically.)%rtempfileZmkstemposcloseintrangesocket setsockoptZ SOL_SOCKETZ SO_LINGERZbindappend enumerateZ getsocknamepathexistsstrpopdictropenwritejsondumpshasattrstatdirnamest_moder%chmodOSErrorerrnoZEPERMwarningswarnRuntimeWarning)fnamerrrrrrrrr r!fdportsZ ports_neededisockportNcfgfpathsZ runtime_dirr/Z permissionsZnew_permissionserM5lib/python3.7/site-packages/jupyter_client/connect.pywrite_connection_file%s, .                       rO kernel-*.jsonc Cs|dk rtd||dkr(dtg}t|tr8|g}y t||Stk rVYnXd|krf|}nd|}g}x&|D]}|tt j ||qxWdd|D}|std||fn(t |d kr|d St |d d d dSdS)afind a connection file, and return its absolute path. The current working directory and optional search path will be searched for the file if it is not given by absolute path. If the argument does not match an existing file, it will be interpreted as a fileglob, and the matching file in the profile's security dir with the latest access time will be used. Parameters ---------- filename : str The connection file or fileglob to search for. path : str or list of strs[optional] Paths in which to search for connection files. Returns ------- str : The absolute path of the connection file. Nz5Jupyter has no profiles. profile=%s has been ignored..*z*%s*cSsg|]}tj|qSrM)r'r/abspath).0mrMrMrN sz(find_connection_file..zCould not find %r in %rrrcSs t|jS)N)r'r9st_atime)rJrMrMrNsz&find_connection_file..)r)r?r@r isinstancer rIOErrorextendglobr'r/joinlensorted)filenamer/ZprofileZpatZmatchesprMrMrNfind_connection_files,     rcc Csddlm}t|tr8t|}t|}WdQRX|}|d}|d|d|d|df}|d }| ||r|d } nt d t |} x*t ||D]\} } | | | |||| qWt|S) atunnel connections to a kernel via ssh This will open four SSH tunnels from localhost on this machine to the ports associated with the kernel. They can be either direct localhost-localhost tunnels, or if an intermediate server is necessary, the kernel must be listening on a public IP. Parameters ---------- connection_info : dict or str (path) Either a connection dict, or the path to a JSON connection file sshserver : str The ssh sever to use to tunnel to the kernel. Can be a full `user@server:port` string. ssh config aliases are respected. sshkey : str [optional] Path to file containing ssh key to use for authentication. Only necessary if your ssh config does not already associate a keyfile with the host. Returns ------- (shell, iopub, stdin, hb) : ints The four ports on localhost that have been forwarded to the kernel. r)tunnelNrrrrrFzSSH Password for %s: )Zzmq.sshrdrZr r4r6loadsreadZselect_random_portsZtry_passwordless_sshrr zipZ ssh_tunneltuple) Zconnection_infoZ sshserverZsshkeyrdrJZcfZlportsZrportsZ remote_ipZpasswordZlpZrprMrMrNtunnel_to_kernels     rj)hbshelliopubstdincontrolcCsg|] }d|qS)z%s_portrM)rTchannelrMrMrNrV srV)rlrnrmrkroc@sjeZdZdZeZddZeddddZedZ e d d gd dd Z eZ edd dZ d dZddZeddddZeddddZeddddZeddddZeddddZdZeddZedZddZd?ddZeedd Zd!d"Z d#d$Z!d%d&Z"d'd(Z#d)d*Z$d+d,Z%d@d-d.Z&d/d0Z'd1d2Z(dAd3d4Z)dBd5d6Z*dCd7d8Z+dDd9d:Z,dEd;d<Z-dFd=d>Z.dS)GConnectionFileMixinz>Mixin for configurable classes that work with connection filescCstS)N)r)selfrMrMrN_data_dir_default&sz%ConnectionFileMixin._data_dir_defaultrTa:JSON file in which to store connection info [default: kernel-.json] This file will contain the IP, ports, and authentication key needed to connect clients to this kernel. By default, this file will be created in the security dir of the current profile, but can be specified by absolute path. )confighelpFripc) default_valuertzSet the kernel's IP address [default localhost]. If the IP address is something other than localhost, then Consoles on other machines will be able to connect to the Kernel, so be careful!cCs6|jdkr,|jr&tj|jddSdSntSdS)Nrvrz-ipcz kernel-ipc)rconnection_filer'r/splitextr)rrrMrMrN _ip_default=s  zConnectionFileMixin._ip_defaultcCs|dkrd|_dS)NrRz0.0.0.0)r)rrnameoldnewrMrMrN _ip_changedFszConnectionFileMixin._ip_changedrz(set the heartbeat port [default: random]z-set the shell (ROUTER) port [default: random]z*set the iopub (PUB) port [default: random]z-set the stdin (ROUTER) port [default: random]z/set the control (ROUTER) port [default: random]NcsfddtDS)Ncsg|]}t|qSrM)getattr)rTr{)rrrMrNrV\sz-ConnectionFileMixin.ports..) port_names)rrrM)rrrNrDZszConnectionFileMixin.portszjupyter_client.session.SessioncCsddlm}||dS)Nr)Session)parent)Zjupyter_client.sessionr)rrrrMrMrN_session_default`s z$ConnectionFileMixin._session_defaultc CsVt|j|j|j|j|j|j|jd}|r8|j |d<n| t|jj |jj d|S)aReturn the connection info as a dict Parameters ---------- session : bool [default: False] If True, return our session object will be included in the connection info. If False (default), the configuration parameters of our session object will be included, rather than the session object itself. Returns ------- connect_info : dict dictionary of connection information. )rrrrrrrsession)r r) r3rrrrrrrrZcloneupdater r)rrrinforMrMrNget_connection_infohs z'ConnectionFileMixin.get_connection_infoz#jupyter_client.BlockingKernelClient)klassrwcCs,|}||d<|jf|}|jj|j_|S)z-Make a blocking client connected to my kernelr)rblocking_classrr)rrrZbcrMrMrNblocking_clients   z#ConnectionFileMixin.blocking_clientc Cs<|jr8d|_yt|jWntttfk r6YnXdS)z}Cleanup connection file *if we wrote it* Will not raise if the connection file was already removed somehow. FN)_connection_file_writtenr'removerxr[r=AttributeError)rrrMrMrNcleanup_connection_files z+ConnectionFileMixin.cleanup_connection_filec CsX|jdkrdSxD|jD]:}d|j|f}yt|Wqttfk rNYqXqWdS)z#Cleanup ipc files if we wrote them.rvNz%s-%i)rrDrr'rr[r=)rrrGZipcfilerMrMrNcleanup_ipc_filess  z%ConnectionFileMixin.cleanup_ipc_filescCsN|jdkrdS|jdk rdSg|_x&tD]}t||dkr(|j|q(WdS)zRecords which of the ports are randomly assigned. Records on first invocation, if the transport is tcp. Does nothing on later invocations.rNr)r_random_port_namesrrr-)rrr{rMrMrN_record_random_port_namess   z-ConnectionFileMixin._record_random_port_namescCs2|js dSx|jD]}t||dqW|dS)zForgets randomly assigned port numbers and cleans up the connection file. Does nothing if no port numbers have been randomly assigned. In particular, does nothing unless the transport is tcp. Nr)rsetattrr)rrr{rMrMrNcleanup_random_portss  z(ConnectionFileMixin.cleanup_random_portsc Cs|jrtj|jrdSt|j|j|j|jj |j |j |j |j |j|jj|jd \|_}|xtD]}t||||qdWd|_dS)z;Write connection info to JSON dict in self.connection_file.N) rrrrrrrrr r!T)rr'r/r0rxrOrrrrrrrrrr r!rrr)rrrIr{rMrMrNrOs z)ConnectionFileMixin.write_connection_filec CsH|dkr|j}|jd|t|}t|}WdQRX||dS)aLoad connection info from JSON dict in self.connection_file. Parameters ---------- connection_file: unicode, optional Path to connection file to load. If unspecified, use self.connection_file NzLoading connection file %s)rxlogdebugr4r6loadload_connection_info)rrrxrJrrMrMrNload_connection_files  z(ConnectionFileMixin.load_connection_filecCs|d|j|_|d||_|x2tD]*}t||dkr0||kr0t||||q0Wd|krvt|d|j _ d|kr|d|j _ dS)aaLoad connection info from a dict containing connection info. Typically this data comes from a connection file and is called by load_connection_file. Parameters ---------- info: dict Dictionary containing connection_info. See the connection_file spec for details. rrrrr N) getrrzrrrrrr rrr )rrrr{rMrMrNrs  z(ConnectionFileMixin.load_connection_infocCs@|j}|j}t|d|}|dkr.d||fSd|||fSdS)z&Make a ZeroMQ URL for a given channel.z%s_portrz tcp://%s:%iz %s://%s-%sN)rrr)rrrprrrGrMrMrN _make_urls  zConnectionFileMixin._make_urlcCsL||}t|}|jd||j|}d|_|r>||_|||S)z1Create a zmq Socket and connect it to the kernel.zConnecting to: %si) rchannel_socket_typesrrcontextr+ZlingeridentityZconnect)rrrprZurlZ socket_typerFrMrMrN_create_connected_sockets   z,ConnectionFileMixin._create_connected_socketcCs |jd|d}|tjd|S)z0return zmq Socket connected to the IOPub channelrm)rr)rr,zmqZ SUBSCRIBE)rrrrFrMrMrN connect_iopub'sz!ConnectionFileMixin.connect_iopubcCs|jd|dS)z0return zmq Socket connected to the Shell channelrl)r)r)rrrrMrMrN connect_shell-sz!ConnectionFileMixin.connect_shellcCs|jd|dS)z0return zmq Socket connected to the StdIn channelrn)r)r)rrrrMrMrN connect_stdin1sz!ConnectionFileMixin.connect_stdincCs|jd|dS)z4return zmq Socket connected to the Heartbeat channelrk)r)r)rrrrMrMrN connect_hb5szConnectionFileMixin.connect_hbcCs|jd|dS)z2return zmq Socket connected to the Control channelro)r)r)rrrrMrMrNconnect_control9sz#ConnectionFileMixin.connect_control)F)N)N)N)N)N)N)N)/__name__ __module__ __qualname____doc__rZdata_dirrsrxr rrrr!rrzr~r rrrrrrpropertyrDrrrrrobjectrrrrrrrOrrrrrrrrrrMrMrMrNrq"sV   %        rq) Nrrrrrrrrrr)rPNN)N),rZ __future__rr>r]r6r'r+r9r&r?rrZtraitlets.configrZlocalinterfacesrZipython_genutils.pathrZipython_genutils.py3compatrr r r Z traitletsr r rrrrZjupyter_core.pathsrrrOrcrjZREQZDEALERZSUBrrrq__all__rMrMrMrNsF        9 7