B 9d8p@sddlZddlZddlmZddlmZddlmZmZm Z ddl m Z m Z m Z ddlmZddlmZdd lmZdd lmZdd lmZmZmZmZmZmZmZmZdd lm Z Gd dde Z!ddZ"GdddeZ#GdddeZ$GdddeZ%dS)N)gaierror)web) json_encode json_decode url_escape) HTTPClientAsyncHTTPClient HTTPError)AsyncMappingKernelManager)SessionManager)KernelSpecManager) url_path_join)InstanceUnicodeIntFloatBooldefaultvalidate TraitError)SingletonConfigurablecs2eZdZdZedddddZdZeddd Ze dd d Z edddd dZ d Z edddZ e dddZdZdZeedddZedddZdZdZeedddZedddZd Zd!Zeedd"dZed#d$d%Zd&Zd'Zeedd(dZed)d*d+Zd&Z d,Z!ee dd-dZ"ed.d/d0Z#edddd1dZ$d2Z%ed3d4d5Z&edddd6dZ'd7Z(ed8d9d:Z)edddd;dZ*dd?Z,edddd@dZ-dAZ.edBdCdDZ/eddddEdZ0dFZ1edGdHdIZ2dJZ3dKZ4ee3dddLdZ5edMdNdOZ6eddddPdZ7dQZ8edRdSdTZ9dZ:dUZ;efdZd[Z?d\Z@d]ZAee@dd^dZBed_d`daZCdbZDdcZEeeDddddZFededfdgZGdhZHdiZIeeHddjdZJedkdldmZKdnZLdoZMeNeLddpdZOedqdrdsZPeQdtduZReSeTjUVdvdwZWdxdyZXdzd{ZYZZS)| GatewayClientzThis class manages the configuration. It's its own singleton class so that we can share these values across all objects. It also contains some helper methods to build request arguments out of the various config options. NTa,The url of the Kernel or Enterprise Gateway server where kernel specifications are defined and kernel management takes place. If defined, this Notebook server acts as a proxy for all kernel management and kernel specification retrieval. (JUPYTER_GATEWAY_URL env var) ) default_value allow_noneconfighelpZJUPYTER_GATEWAY_URLurlcCstj|jS)N)osenvirongeturl_env)selfr#f/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/notebook/gateway/managers.py _url_default'szGatewayClient._url_defaultcCsB|d}|dk r>t|dkr>t|ds>td|d|S)Nvaluerhttpz+GatewayClient url must start with 'http': '')lenstrlower startswithr)r"proposalr&r#r#r$ _url_validate+s zGatewayClient._url_validatezThe websocket url of the Kernel or Enterprise Gateway server. If not provided, this value will correspond to the value of the Gateway url with 'ws' in place of 'http'. (JUPYTER_GATEWAY_WS_URL env var) ZJUPYTER_GATEWAY_WS_URLws_urlcCs2tj|j}|dkr.|jr.|jdd}|S)Nr'ws)rrr ws_url_envgateway_enabledrr+replace)r"rr#r#r$_ws_url_default<s zGatewayClient._ws_url_defaultcCsB|d}|dk r>t|dkr>t|ds>td|d|S)Nr&rr0z,GatewayClient ws_url must start with 'ws': 'r()r)r*r+r,r)r"r-r&r#r#r$_ws_url_validateDs zGatewayClient._ws_url_validatez /api/kernelsZ JUPYTER_GATEWAY_KERNELS_ENDPOINTzbThe gateway API endpoint for accessing kernel resources (JUPYTER_GATEWAY_KERNELS_ENDPOINT env var))rrrkernels_endpointcCstj|j|jS)N)rrr kernels_endpoint_envkernels_endpoint_default_value)r"r#r#r$_kernels_endpoint_defaultRsz'GatewayClient._kernels_endpoint_defaultz/api/kernelspecsZ$JUPYTER_GATEWAY_KERNELSPECS_ENDPOINTzaThe gateway API endpoint for accessing kernelspecs (JUPYTER_GATEWAY_KERNELSPECS_ENDPOINT env var)kernelspecs_endpointcCstj|j|jS)N)rrr kernelspecs_endpoint_env"kernelspecs_endpoint_default_value)r"r#r#r$_kernelspecs_endpoint_default[sz+GatewayClient._kernelspecs_endpoint_defaultz /kernelspecsZ-JUPYTER_GATEWAY_KERNELSPECS_RESOURCE_ENDPOINTz|The gateway endpoint for accessing kernelspecs resources (JUPYTER_GATEWAY_KERNELSPECS_RESOURCE_ENDPOINT env var)kernelspecs_resource_endpointcCstj|j|jS)N)rrr !kernelspecs_resource_endpoint_env+kernelspecs_resource_endpoint_default_value)r"r#r#r$&_kernelspecs_resource_endpoint_defaultesz4GatewayClient._kernelspecs_resource_endpoint_defaultgD@JUPYTER_GATEWAY_CONNECT_TIMEOUTz}The time allowed for HTTP connection establishment with the Gateway server. (JUPYTER_GATEWAY_CONNECT_TIMEOUT env var)connect_timeoutcCsttjd|jS)NrB)floatrrr connect_timeout_default_value)r"r#r#r$connect_timeout_defaultosz%GatewayClient.connect_timeout_defaultJUPYTER_GATEWAY_REQUEST_TIMEOUTzWThe time allowed for HTTP request completion. (JUPYTER_GATEWAY_REQUEST_TIMEOUT env var)request_timeoutcCsttjd|jS)NrG)rDrrr request_timeout_default_value)r"r#r#r$request_timeout_defaultxsz%GatewayClient.request_timeout_defaultzWThe filename for client SSL key, if any. (JUPYTER_GATEWAY_CLIENT_KEY env var) ZJUPYTER_GATEWAY_CLIENT_KEY client_keycCstj|jS)N)rrr client_key_env)r"r#r#r$_client_key_defaultsz!GatewayClient._client_key_defaultz`The filename for client SSL certificate, if any. (JUPYTER_GATEWAY_CLIENT_CERT env var) ZJUPYTER_GATEWAY_CLIENT_CERT client_certcCstj|jS)N)rrr client_cert_env)r"r#r#r$_client_cert_defaultsz"GatewayClient._client_cert_defaultzeThe filename of CA certificates or None to use defaults. (JUPYTER_GATEWAY_CA_CERTS env var) ZJUPYTER_GATEWAY_CA_CERTSca_certscCstj|jS)N)rrr ca_certs_env)r"r#r#r$_ca_certs_defaultszGatewayClient._ca_certs_defaultzRThe username for HTTP authentication. (JUPYTER_GATEWAY_HTTP_USER env var) ZJUPYTER_GATEWAY_HTTP_USER http_usercCstj|jS)N)rrr http_user_env)r"r#r#r$_http_user_defaultsz GatewayClient._http_user_defaultzRThe password for HTTP authentication. (JUPYTER_GATEWAY_HTTP_PWD env var) ZJUPYTER_GATEWAY_HTTP_PWDhttp_pwdcCstj|jS)N)rrr http_pwd_env)r"r#r#r$_http_pwd_defaultszGatewayClient._http_pwd_defaultz{}ZJUPYTER_GATEWAY_HEADERSzAdditional HTTP headers to pass on the request. This value will be converted to a dict. (JUPYTER_GATEWAY_HEADERS env var) headerscCstj|j|jS)N)rrr headers_envheaders_default_value)r"r#r#r$_headers_defaultszGatewayClient._headers_defaultz`The authorization token used in the HTTP headers. (JUPYTER_GATEWAY_AUTH_TOKEN env var) ZJUPYTER_GATEWAY_AUTH_TOKEN auth_tokencCstj|jdS)N)rrr auth_token_env)r"r#r#r$_auth_token_defaultsz!GatewayClient._auth_token_defaultZJUPYTER_GATEWAY_VALIDATE_CERTzFor HTTPS requests, determines if server's certificate should be validated or not. (JUPYTER_GATEWAY_VALIDATE_CERT env var) validate_certcCsttj|jt|jdkS)N)nofalse)boolrrr validate_cert_envr*validate_cert_default_value)r"r#r#r$validate_cert_defaultsz#GatewayClient.validate_cert_defaultc stjf|i|_dS)N)super__init__ _static_args)r"kwargs) __class__r#r$rjszGatewayClient.__init__r_ZJUPYTER_GATEWAY_ENV_WHITELISTaA comma-separated list of environment variable names that will be included, along with their values, in the kernel startup request. The corresponding `env_whitelist` configuration value must also be set on the Gateway server - since that configuration value indicates which environmental values to make available to the kernel. (JUPYTER_GATEWAY_ENV_WHITELIST env var) env_whitelistcCstj|j|jS)N)rrr env_whitelist_envenv_whitelist_default_value)r"r#r#r$_env_whitelist_defaultsz$GatewayClient._env_whitelist_defaultg?JUPYTER_GATEWAY_RETRY_INTERVALa;The time allowed for HTTP reconnection with the Gateway server for the first time. Next will be JUPYTER_GATEWAY_RETRY_INTERVAL multiplied by two in factor of numbers of retries but less than JUPYTER_GATEWAY_RETRY_INTERVAL_MAX. (JUPYTER_GATEWAY_RETRY_INTERVAL env var)gateway_retry_intervalcCsttjd|jS)Nrr)rDrrr $gateway_retry_interval_default_value)r"r#r#r$gateway_retry_interval_defaultsz,GatewayClient.gateway_retry_interval_defaultg>@"JUPYTER_GATEWAY_RETRY_INTERVAL_MAXzThe maximum time allowed for HTTP reconnection retry with the Gateway server. (JUPYTER_GATEWAY_RETRY_INTERVAL_MAX env var)gateway_retry_interval_maxcCsttjd|jS)Nrv)rDrrr (gateway_retry_interval_max_default_value)r"r#r#r$"gateway_retry_interval_max_defaultsz0GatewayClient.gateway_retry_interval_max_defaultJUPYTER_GATEWAY_RETRY_MAXz~The maximum retries allowed for HTTP reconnection with the Gateway server. (JUPYTER_GATEWAY_RETRY_MAX env var)gateway_retry_maxcCsttjd|jS)Nr{)intrrr gateway_retry_max_default_value)r"r#r#r$gateway_retry_max_defaultsz'GatewayClient.gateway_retry_max_defaultcCst|jdk ot|jdkS)Nr)rerr))r"r#r#r$r2szGatewayClient.gateway_enabledKERNEL_LAUNCH_TIMEOUT(cCs|jttjkrttj|_n|jttjkr:t|jt_ttjtjd<t |j |j d<d|j d kr|j d dd|ji|j|j d<|j|j d<|j|j d<|jr|j|j d<|j|j d <|jr|j|j d <|jr|j|j d <|jr|j|j d <d S)zInitialize arguments used on every request. Since these are static values, we'll perform this operation once. rrZ Authorizationztoken rCrHrbrNrKrQZ auth_usernameZ auth_passwordN)rHrDrrr}r*rrjsonloadsrZrkkeysupdater^rCrbrNrKrQrTrW)r"r#r#r$init_static_argss*         zGatewayClient.init_static_argscKsdt|jdkr|xH|jD]:\}}|dkrT||i}t|tr\||q"|||<q"W|S)zMerges the static args relative to the connection, with the given keyword arguments. If statics have yet to be initialized, we'll do that here. rrZ)r)rkritems setdefault isinstancedictr)r"rlargZ static_valueZ given_valuer#r#r$load_connection_args&s    z"GatewayClient.load_connection_args)[__name__ __module__ __qualname____doc__rrr!rr%rr.r/r1r4r5r8r7r6r9r<r;r:r=r@r?r>rArEZconnect_timeout_envrrCrFrIZrequest_timeout_envrHrJrKrLrMrNrOrPrQrRrSrTrUrVrWrXrYr\r[rZr]r^r`rargrfrrbrhrjrprornrqrtZgateway_retry_interval_envrsrurxZgateway_retry_interval_max_envrwryr~Zgateway_retry_max_envrr|rpropertyr2r}rrr rrr __classcell__r#r#)rmr$rs     rc st}tjf|}y|j|f|IdH}Wntk rl}z tddtjd|Wdd}~XYn|tk r}z"t|j dtjd|Wdd}~XYn>t k r}z tddtjd |Wdd}~XYnX|S) zEMake an async request to kernel gateway endpoint, returns a response Niz,Connection refused from Gateway server url 'z5'. Check to be sure the Gateway instance is running.z3Error attempting to connect to Gateway server url 'zD'. Ensure gateway url is valid and the Gateway instance is running.iz1The Gateway server specified in the gateway_url 'z_' doesn't appear to be valid. Ensure gateway url is valid and the Gateway instance is running.) rrinstancerfetchConnectionRefusedErrorrr rcoder)Zendpointrlclientresponseer#r#r$gateway_request8s(rcseZdZdZiZfddZddZddZdd d Zdd d Z dd dZ ddZ ddZ dddZ d ddZddZd!ddZZS)"GatewayKernelManagerz[Kernel manager that supports remote kernels hosted by Jupyter Kernel or Enterprise Gateway.c s*tjf|ttjtj|_dS)N)rirjrrrrr6 base_endpoint)r"rl)rmr#r$rj`szGatewayKernelManager.__init__cCs ||jkS)N)_kernels)r" kernel_idr#r#r$ __contains__dsz!GatewayKernelManager.__contains__cCs&y |j|Stk r YnXdS)zDComplete override since we want to be more tolerant of missing keys N)rpopKeyError)r"rr#r#r$ remove_kernelgs z"GatewayKernelManager.remove_kernelNcCs|rt|jtt|S|jS)zBuilds a url for the kernels endpoint Parameters ---------- kernel_id: kernel UUID (optional) )rrrr*)r"rr#r#r$_get_kernel_endpoint_urlnsz-GatewayKernelManager._get_kernel_endpoint_urlc sR|jd|||dkr|dk r0|||d<|dd}|}|jd|tjddkrt j rt j tjd<dd t tj D}|dk r|d dkr|d|d <t ||d }t|d d di|dIdH}t|j} | d}|jd||jd|n*||IdH} | d}|jd|| |j|<|S)aStart a kernel for a session and return its kernel_id. Parameters ---------- kernel_id : uuid The uuid to associate the new kernel with. If this is not None, this kernel will be persistent whenever it is requested. path : API path The API path (unicode, '/' delimited) for the cwd. Will be transformed to an OS path relative to root_dir. z-Request start kernel: kernel_id=%s, path="%s"Ncwd kernel_namepython3zRequest new kernel at: KERNEL_USERNAMEcSs4i|],\}}|ds*|tjdkr||qS)ZKERNEL_,)r,rrrnsplit).0kvr#r#r$ sz5GatewayKernelManager.start_kernel..ZKERNEL_WORKING_DIR)nameenvPOSTz Content-Typezapplication/json)methodrZbodyidzKernel started: z Kernel args: zUsing existing kernel: )loginfoZ cwd_for_pathr rdebugrrrrrTrrrrrr get_kernelr) r"rpathrlr kernel_urlZ kernel_envZ json_bodyrkernelr#r#r$ start_kernelzs0      z!GatewayKernelManager.start_kernelc s||}|jd|yt|ddIdH}WnRtjk r}z2|jdkrr|jd|||d}nWdd}~XYnBXt |j }||j kr||j |<|jd|n|j d|d}|S) zGet kernel for kernel_id. Parameters ---------- kernel_id : uuid The uuid of the kernel. zRequest kernel at: GET)rNizKernel not found at: zKernel retrieved: %sz,Kernel '%s' is not managed by this instance.) rrrrrr status_codewarnrrrrwarning)r"rrlrrerrorrr#r#r$rs"      zGatewayKernelManager.get_kernelcs"|jd|||IdH}|S)zReturn a dictionary of kernel information described in the JSON standard model. Parameters ---------- kernel_id : uuid The uuid of the kernel. z$RemoteKernelManager.kernel_model: %sN)rrr)r"rmodelr#r#r$ kernel_models z!GatewayKernelManager.kernel_modelcsT}jd|t|ddIdH}t|j}fdd|D_tjS)zGet a list of kernels.zRequest list kernels: %sr)rNcs$i|]}|djkr||dqS)r)r)rx)r"r#r$rsz5GatewayKernelManager.list_kernels..) rrrrrrrlistvalues)r"rlrrZkernelsr#)r"r$ list_kernelss  z!GatewayKernelManager.list_kernelsFcsL||}|jd|t|ddIdH}|jd|j|j||dS)aXShutdown a kernel by its kernel uuid. Parameters ========== kernel_id : uuid The id of the kernel to shutdown. now : bool Shutdown the kernel immediately (True) or gracefully (False) restart : bool The purpose of this shutdown is to restart the kernel (True) zRequest shutdown kernel at: %sDELETE)rNzShutdown kernel response: %d %s)rrrrrreasonr)r"rnowZrestartrrr#r#r$shutdown_kernels z$GatewayKernelManager.shutdown_kernelcsR||d}|jd|t|ddditidIdH}|jd|j|jdS) zRestart a kernel by its kernel uuid. Parameters ========== kernel_id : uuid The id of the kernel to restart. z/restartzRequest restart kernel at: %srz Content-Typezapplication/json)rrZrNzRestart kernel response: %d %s)rrrrrrr)r"rrrlrrr#r#r$restart_kernels z#GatewayKernelManager.restart_kernelcsR||d}|jd|t|ddditidIdH}|jd|j|jdS) zInterrupt a kernel by its kernel uuid. Parameters ========== kernel_id : uuid The id of the kernel to interrupt. z /interruptzRequest interrupt kernel at: %srz Content-Typezapplication/json)rrZrNz Interrupt kernel response: %d %s)rrrrrrr)r"rrlrrr#r#r$interrupt_kernels z%GatewayKernelManager.interrupt_kernelc Csg}ddi}tjf|}t}xl|jD]b}||}|jd|y|j|f|}Wnt k rlYnX|jd|j |j | |q*W| x|D]}||qWdS)zShutdown all kernels.rrzRequest delete kernel at: %szDelete kernel response: %d %sN)rrrrrrrrrr rrappendcloser)r"rZshutdown_kernelsrlrrrrr#r#r$ shutdown_alls    z!GatewayKernelManager.shutdown_all)N)NN)N)FF)F)F)rrrrrrjrrrrrrrrrrrrr#r#)rmr$rZs  2    rcsReZdZfddZeddZdddZdd Zd d Zd d Z ddZ Z S)GatewayKernelSpecManagerc sLtjf|ttjtj}t||_ ttjtj |_ dS)N) rirjrrrrr:r_get_endpoint_for_user_filterrr>base_resource_endpoint)r"rlr)rmr#r$rj)s     z!GatewayKernelSpecManager.__init__cCs"tjd}|rd||gS|S)Nrz?user=)rrr join)Zdefault_endpointZ kernel_userr#r#r$r2s z6GatewayKernelSpecManager._get_endpoint_for_user_filterNcCs|rt|jt|S|jS)zBuilds a url for the kernels endpoint Parameters ---------- kernel_name: kernel name (optional) )rrr)r"rr#r#r$_get_kernelspecs_endpoint_url9sz6GatewayKernelSpecManager._get_kernelspecs_endpoint_urlcsV|IdH}|jj}|d}||jkrH|jdj||jd||_|d}|S)NrzDefault kernel name on Gateway server ({gateway_default}) differs from Notebook server ({notebook_default}). Updating to Gateway server's value.)Zgateway_defaultZnotebook_defaultZ kernelspecs)list_kernel_specsparentkernel_managerr Zdefault_kernel_namerrformat)r"Zfetched_kspecskmZremote_default_kernel_nameZ remote_kspecsr#r#r$ get_all_specsEs     z&GatewayKernelSpecManager.get_all_specscs6|}|jd|t|ddIdH}t|j}|S)zGet a list of kernel specs.z Request list kernel specs at: %sr)rN)rrrrrr)r"kernel_spec_urlrZ kernel_specsr#r#r$rXs  z*GatewayKernelSpecManager.list_kernel_specsc s|jt|d}|jd|yt|ddIdH}WnLtjk r}z,|jdkrrtdj |t j d|nWdd}~XYn Xt |j}|S) zGet kernel spec for kernel_name. Parameters ---------- kernel_name : str The name of the kernel. )rzRequest kernel spec at: r)rNizFkernelspec {kernel_name} not found on Gateway server at: {gateway_url})rZ gateway_url)rr*rrrrr rrrrrrrr)r"rrlrrrZ kernel_specr#r#r$get_kernel_spec`s  z(GatewayKernelSpecManager.get_kernel_specc st|jt|t|}|jd|d|yt|ddIdH}Wn6tjk rz}z|jdkrhd}nWdd}~XYnX|j }|S)zGet kernel spec for kernel_name. Parameters ---------- kernel_name : str The name of the kernel. path : str The name of the desired resource zRequest kernel spec resource 'z' at: r)rNi) rrr*rrrrr rr)r"rrZkernel_spec_resource_urlrrZkernel_spec_resourcer#r#r$get_kernel_spec_resource{s  z1GatewayKernelSpecManager.get_kernel_spec_resource)N) rrrrj staticmethodrrrrrrrr#r#)rmr$r's  rc@seZdZedZddZdS)GatewaySessionManagerz.notebook.gateway.managers.GatewayKernelManagercs|j|IdH}|dkS)zRChecks if the kernel is still considered alive and returns true if its not found. N)rr)r"rrr#r#r$ kernel_culledsz#GatewaySessionManager.kernel_culledN)rrrrrrr#r#r#r$rsr)&rrsocketrtornadorZtornado.escaperrrZtornado.httpclientrrr Zservices.kernels.kernelmanagerr Z services.sessions.sessionmanagerr Zjupyter_client.kernelspecr utilsrZ traitletsrrrrrrrrZtraitlets.configrrrrrrr#r#r#r$s&      ( $"Nl