B @\C@sdZddlmZmZmZmZddlZeeZ ddl Z ddl Z ddl Z ddl Z ddlmZddlmZddlmZddlmZdd lmZmZmZmZdd lmZdd lmZd d lm Z m!Z!d dl m"Z"m#Z#dZ$Gddde%Z&Gddde&Z'GdddeZ(dS)a Provide basic Bokeh server objects that use a Tornado ``HTTPServer`` and ``BokeTornado`` Tornado Application to service Bokeh Server Applications. There are two public classes in this module: :class:`~bokeh.server.server.BaseServer` This is a lightweight class to explicitly coordinate the components needed to run a Bokeh server (A :class:`~bokeh.server.tornado.BokehTornado` instance, and Tornado ``HTTPServer`` and a Tornado ``IOLoop``) :class:`~bokeh.server.server.Server` This higher-level convenience class only needs to be configured with Bokeh :class:`~bokeh.application.application.Application` instances, and will automatically create and coordinate the lower level Tornado components. )absolute_importdivisionprint_functionunicode_literalsN) HTTPServer)IOLoop) __version__) Application)BoolIntListString)DEFAULT_SERVER_PORT)Options) bind_socketscreate_hosts_whitelist) BokehTornado(DEFAULT_WEBSOCKET_MAX_MESSAGE_SIZE_BYTES) BaseServerServerc@sveZdZdZddZeddZddZdd d Zd d Z d dZ ddZ dddZ dddZ dZddZddZdS)ra4 Explicitly coordinate the level Tornado components required to run a Bokeh server: * A Tornado ``IOLoop`` to run the Bokeh server machinery. * a ``BokehTornado`` Tornado application that defines the Bokeh server machinery. * a Tornado ``HTTPServer`` to direct HTTP requests All three of these components must be passed to ``BaseServer``, which will initialize the ``BokehTornado`` instance on the ``io_loop``. The ``http_server`` must have been previously created and initialized with the ``BokehTornado`` instance. cCs.d|_d|_||_||_||_|j|dS)a7 Create a ``BaseServer`` instance. Args: io_loop (IOLoop) : A Tornado ``IOLoop`` to run the Bokeh Tornado application on. tornado_app (BokehTornado) : An instance of the Bokeh Tornado application that generates Bokeh Documents and Sessions. http_server (HTTPServer) : A Tornado ``HTTPServer`` to service HTTP requests for Bokeh applications. Should have already be configured with the ``tornado_app`` when created. FN)_started_stopped_http_loop_tornadoZ initialize)selfio_loop tornado_app http_serverr!2lib/python3.7/site-packages/bokeh/server/server.py__init__Vs zBaseServer.__init__cCs|jS)zG The Tornado ``IOLoop`` that this Bokeh Server is running on. )r)rr!r!r"rqszBaseServer.io_loopcCs"|jrtdd|_|jdS)a Install the Bokeh Server and its background tasks on a Tornado ``IOLoop``. This method does *not* block and does *not* affect the state of the Tornado ``IOLoop`` You must start and stop the loop yourself, i.e. this method is typically useful when you are already explicitly managing an ``IOLoop`` yourself. To start a Bokeh server and immediately "run forever" in a blocking manner, see :func:`~bokeh.server.server.BaseServer.run_until_shutdown`. zAlready startedTN)rAssertionErrorrstart)rr!r!r"r%xs zBaseServer.startTcCs.|jrtdd|_|j||jdS)aK Stop the Bokeh Server. This stops and removes all Bokeh Server ``IOLoop`` callbacks, as well as stops the ``HTTPServer`` that this instance was configured with. Args: fast (bool): Whether to wait for orderly cleanup (default: True) Returns: None zAlready stoppedTN)rr$rstopr)rwaitr!r!r"r&s zBaseServer.stopcCs|j|jdS)z Stop listening on ports. The server will no longer be usable after calling this function. Returns: None N)rZclose_all_connectionsr&)rr!r!r"unlistens zBaseServer.unlistencCsb|js|t|jttj|jy|jWnt k rTt dYnX| dS)a Run the Bokeh Server until shutdown is requested by the user, either via a Keyboard interrupt (Ctrl-C) or SIGTERM. Calling this method will start the Tornado ``IOLoop`` and block all execution in the calling process. Returns: None z Interrupted, shutting downN) rr%atexitregister_atexitsignalSIGTERM_sigtermrKeyboardInterruptprintr&)rr!r!r"run_until_shutdowns  zBaseServer.run_until_shutdowncCs|j||S)ak Get an active a session by name application path and session ID. Args: app_path (str) : The configured application path for the application to return a session for. session_id (str) : The session ID of the session to retrieve. Returns: ServerSession )r get_session)rapp_pathZ session_idr!r!r"r2szBaseServer.get_sessionNcCs>|dk r|j|Sg}x |jjD]}||j|7}q"W|S)ai Gets all currently active sessions for applications. Args: app_path (str, optional) : The configured application path for the application to return sessions for. If None, return active sessions for all applications. (default: None) Returns: list[ServerSession] N)r get_sessionsZ app_paths)rr3Z all_sessionspathr!r!r"r4s  zBaseServer.get_sessionstabcCsb|dstdd}|jdk r0|jdkr0|j}d||j|j|f}ddlm}||||d dS) a Opens an app in a browser window or tab. This method is useful for testing or running Bokeh server applications on a local machine but should not call when running Bokeh server for an actual deployment. Args: app_path (str) : the app path to open The part of the URL after the hostname:port, with leading slash. browser (str, optional) : browser to show with (default: None) For systems that support it, the **browser** argument allows specifying which browser to display in, e.g. "safari", "firefox", "opera", "windows-default" (see the ``webbrowser`` module documentation in the standard lib for more details). new (str, optional) : window or tab (default: "tab") If ``new`` is 'tab', then opens a new tab. If ``new`` is 'window', then opens a new window. Returns: None /zapp_path must start with a /Z localhostNzhttp://%s:%d%s%sr)view)browsernew) startswith ValueErroraddressportprefixZbokeh.util.browserr9)rr3r:r;Zaddress_stringZurlr9r!r!r"shows  zBaseServer.showFcCs0|jr dSd|_td|js,|jdddS)NTzShutdown: cleaning upF)r') _atexit_ranlogdebugrr&)rr!r!r"r+s  zBaseServer._atexitcCs"td|f|j|jjdS)Nz!Received signal %d, shutting down)r0rZadd_callback_from_signalr&)rZsignumframer!r!r"r.szBaseServer._sigterm)T)N)Nr6)__name__ __module__ __qualname____doc__r#propertyrr%r&r(r1r2r4rArBr+r.r!r!r!r"rDs     % rcsFeZdZdZd fdd ZeddZeddZed d ZZ S) ra A high level convenience class to run a Bokeh server. This class can automatically coordinate the three the base level components required to run a Bokeh server: * A Tornado ``IOLoop`` to run the Bokeh server machinery. * a ``BokehTornado`` Tornado application that defines the Bokeh server machinery. * a Tornado ``HTTPServer`` to direct HTTP requests This high level ``Server`` class has some limitations. In particular, it is not possible to set an explicit ``io_loop`` and ``num_procs`` other than 1 at the same time. To do that, it is necessary to use ``BaseServer`` and coordinate the three components above explicitly. Nc stdttjfddlm}ddlmt |r@t ||}t |t rRd|i}x\t | D]L\}}t |rt ||||<tfdd||jDr`||q`Wt|}|j|_|j|_|j|_|jdkrtd d|Dstd |jdkr|d k rtd |jdkr6tjd kr6td|d krDi}|d|jt |j|j\} |_t!|j"|j} yBt#|f| |j|j$d|} t%| f|} | &|j| '| Wn0t(k rx| D]} | )qWYnX|d krt*+}t,t-|.|| | d S)a Create a ``Server`` instance. Args: applications (dict[str, Application] or Application or callable) : A mapping from URL paths to Application instances, or a single Application to put at the root URL. The Application is a factory for Documents, with a new Document initialized for each Session. Each application is identified by a path that corresponds to a URL, like "/" or "/myapp" If a single Application is provided, it is mapped to the URL path "/" automatically. As a convenience, a callable may also be provided, in which an Application will be created for it using ``FunctionHandler``. io_loop (IOLoop, optional) : An explicit Tornado ``IOLoop`` to run Bokeh Server code on. If None, ``IOLoop.current()`` will be used (default: None) http_server_kwargs (dict, optional) : Extra arguments passed to ``tornado.httpserver.HTTPServer``. E.g. ``max_buffer_size`` to specify the maximum upload size. More details can be found at: http://www.tornadoweb.org/en/stable/httpserver.html#http-server If None, no extra arguments are passed (default: None) Additionally, the following options may be passed to configure the operation of ``Server``: .. bokeh-options:: _ServerOpts :module: bokeh.server.server Any remaining keyword arguments will be passed as-is to ``BokehTornado``. z8Starting Bokeh server version %s (running on Tornado %s)r)FunctionHandler)DocumentLifecycleHandlerr7c3s|]}t| VqdS)N) isinstance).0Zhandler)rLr!r" gsz"Server.__init__..rcss|] }|jVqdS)N)Z safe_to_fork)rNZappr!r!r"rOqsztUser application code has run before attempting to start multiple processes. This is considered an unsafe operation.NzSetting both num_procs and io_loop in Server is incompatible. Use BaseServer to coordinate an explicit IOLoop and multi-process HTTPServerZwin32z&num_procs > 1 not supported on WindowsZxheaders)extra_websocket_originsr@Z websocket_max_message_size_bytes)/rCinfor tornadoversionZ#bokeh.application.handlers.functionrKZ-bokeh.application.handlers.document_lifecyclerLcallabler rMlistitemsallZ _handlersadd _ServerOptsr?_portr>_addressr@_prefix num_procsvaluesr$ RuntimeErrorsysplatform setdefault use_xheadersrrallow_websocket_originrwebsocket_max_message_sizerr%Z add_sockets ExceptioncloserZcurrentsuperrr#)rZ applicationsrZhttp_server_kwargskwargsrKkvZoptsZsocketsrPrr s) __class__)rLr"r#.s\+           zServer.__init__cCs|jS)zG The configured URL prefix to use for all Bokeh server paths. )r\)rr!r!r"r@sz Server.prefixcCs|jS)z[ The configured port number that the server listens on for HTTP requests. )rZ)rr!r!r"r?sz Server.portcCs|jS)zW The configured address that the server listens on for HTTP requests. )r[)rr!r!r"r>szServer.address)NN) rFrGrHrIr#rJr@r?r> __classcell__r!r!)rmr"rs m  rc@sbeZdZedddZedddZeeddZedddZ e edd dZ e d d dZ eed dZdS) rYra The number of worker processes to start for the HTTP server. If an explicit ``io_loop`` is also configured, then ``num_procs=1`` is the only compatible value. Use ``BaseServer`` to coordinate an explicit ``IOLoop`` with a multi-process HTTP server. A value of 0 will auto detect number of cores. Note that due to limitations inherent in Tornado, Windows does not support ``num_procs`` values greater than one! In this case consider running multiple Bokeh server instances behind a load balancer. )defaulthelpNzD The address the server should listen on for HTTP requests. zH The port number the server should listen on for HTTP requests. r8z9 A URL prefix to use for all Bokeh server paths. z A list of hosts that can connect to the websocket. This is typically required when embedding a Bokeh server app in an external web site using :func:`~bokeh.embed.server_document` or similar. If None, "localhost" is used. Fz Whether to have the Bokeh server override the remote IP and URI scheme and protocol for all requests with ``X-Real-Ip``, ``X-Forwarded-For``, ``X-Scheme``, ``X-Forwarded-Proto`` headers (if they are provided). zx Set the Tornado ``websocket_max_message_size`` value. NOTE: This setting has effect ONLY for Tornado>=4.5 )rFrGrHr r]rr>rr?r@r rdr rcrrer!r!r!r"rYs rY))rIZ __future__rrrrZloggingZ getLoggerrFrCr)r,r`rRZtornado.httpserverrZtornado.iolooprr8r Z applicationr Zcore.propertiesr r r rZ resourcesrZ util.optionsrutilrrrr__all__objectrrrYr!r!r!r"s,       W