U /e-@sdZddlmZddlZeeZddlmZm Z ddl m Z m Z m Z mZmZmZmZmZddlmZddlmZdd lmZe rdd lmZdd lmZd d lmZdZegdfZGdddZ GdddedZ!GdddedZ"ee"gdfZ#dS)a Provide the ``Application`` class. Application instances are factories for creating new Bokeh Documents. When a Bokeh server session is initiated, the Bokeh server asks the Application for a new Document to service the session. To do this, the Application first creates a new empty Document, then it passes this new Document to the ``modify_document`` method of each of its handlers. When all handlers have updated the Document, it is used to service the user session. ) annotationsN)ABCMetaabstractmethod) TYPE_CHECKINGAny AwaitableCallableClassVarDictListTuple)ID)Document)settings)HTTPServerRequest) ServerSession)Handler) Application ServerContextSessionContextc@seZdZUdZdZded<ded<ded<d ed <d d d d ddddZeddddZed dddZ eddddZ eddddZ d ddddZ d dd!d"Z d dd#d$d%Zd&dd'd(d)Zd&dd'd*d+Zd,dd-d.d/Zd,dd-d0d1Zd2d3d4d5d6Zd S)7rzQ An Application is a factory for Document instances. .. autoclasstoc:: TzClassVar[bool]_is_a_bokeh_application_classz str | None _static_pathz List[Handler] _handlerszDict[str, Any] | None _metadataN)metadatarNone)handlersrreturncGs*d|_g|_||_|D]}||qdS)a? Application factory. Args: handlers (seq[Handler]): List of handlers to call. The URL is taken from the first one only. Keyword Args: metadata (dict): arbitrary user-supplied JSON data to make available with the application. The server will provide a URL ``http://applicationurl/metadata`` which returns a JSON blob of the form: .. code-block:: json { "data": { "hi": "hi", "there": "there" }, "url": "/myapp" } The user-supplied metadata is returned as-is under the ``"data"`` key in the blob. N)rrradd)selfrrhr#A/tmp/pip-unpacked-wheel-f5fndrjf/bokeh/application/application.py__init__\s zApplication.__init__zTuple[Handler, ...]rcCs t|jS)zL The ordered list of handlers this Application is configured with. )tuplerr!r#r#r$rszApplication.handlerscCs|jS)zO Arbitrary user-supplied metadata to associate with this application. )rr(r#r#r$rszApplication.metadataboolcCstdd|jDS) css|] }|jVqdS)N) safe_to_fork).0handlerr#r#r$ sz+Application.safe_to_fork..)allrr(r#r#r$r+szApplication.safe_to_forkcCs|jS)zI Path to any (optional) static resources specified by handlers. )rr(r#r#r$ static_pathszApplication.static_path)r-rcCsf|j|dd|jD}|dt|dkrDtdt|nt|dkr\||_nd|_dS)z Add a handler to the pipeline used to initialize new documents. Args: handler (Handler) : a handler for this Application to use to process Documents cSsh|] }|qSr#)r0)r,r"r#r#r$ sz"Application.add..Nrz/More than one static path requested for app: %r) rappendrdiscardlen RuntimeErrorlistpopr)r!r-Z static_pathsr#r#r$r s     zApplication.addrcCst}|||S)zO Creates and initializes a document using the Application's handlers. )rinitialize_document)r!docr#r#r$create_documents zApplication.create_document)r9rcCsD|jD](}|||jrtd||j|jqtr@|dS)zD Fills in a new document using the Application's handlers. z,Error running application handler %r: %s %s N) rZmodify_documentfailedlogerrorZ error_detailrZperform_document_validationvalidate)r!r9r"r#r#r$r8s   zApplication.initialize_documentr)server_contextrcCs|jD]}||qdS)z Invoked to execute code when a new session is created. This method calls ``on_server_loaded`` on each handler, in order, with the server context passed as the only argument. N)ron_server_loadedr!r?r"r#r#r$r@s zApplication.on_server_loadedcCs|jD]}||qdS)a{ Invoked to execute code when the server cleanly exits. (Before stopping the server's ``IOLoop``.) This method calls ``on_server_unloaded`` on each handler, in order, with the server context passed as the only argument. .. warning:: In practice this code may not run, since servers are often killed by a signal. N)ron_server_unloadedrAr#r#r$rBs zApplication.on_server_unloadedr)session_contextrcs |jD]}||IdHqdS)a7 Invoked to execute code when a new session is created. This method calls ``on_session_created`` on each handler, in order, with the session context passed as the only argument. May return a ``Future`` which will delay session creation until the ``Future`` completes. N)ron_session_createdr!rCr"r#r#r$rDs zApplication.on_session_createdcs |jD]}||IdHqdS)a Invoked to execute code when a session is destroyed. This method calls ``on_session_destroyed`` on each handler, in order, with the session context passed as the only argument. Afterwards, ``session_context.destroyed`` will be ``True``. N)ron_session_destroyedrEr#r#r$rFs z Application.on_session_destroyedrzDict[str, Any])requestrcCs$i}|jD]}|||q |S)a# Processes incoming HTTP request returning a dictionary of additional data to add to the session_context. Args: request: HTTP request Returns: A dictionary of JSON serializable data to be included on the session context. )rupdateprocess_request)r!rGZ request_datar"r#r#r$rIs  zApplication.process_request)__name__ __module__ __qualname____doc__r__annotations__r%propertyrrr+r0r r:r8r@rBrDrFrIr#r#r#r$rKs,  $  rc@s&eZdZdZeeddddZdS)rz A harness for server-specific information and tasks related to collections of Bokeh sessions. *This base class is probably not of interest to general users.* zList[ServerSession]r&cCsdS)zx ``SessionContext`` instances belonging to this application. *Subclasses must implement this method.* Nr#r(r#r#r$sessionsszServerContext.sessionsN)rJrKrLrMrOrrPr#r#r#r$rs r) metaclassc@seZdZUdZded<ded<dddddd Zeed d d d Zedd ddZ edd ddZ edddddZ dS)rz A harness for server-specific information and tasks related to Bokeh sessions. *This base class is probably not of interest to general users.* r_server_contextr_idr)r? session_idrcCs||_||_dS)r*N)rRrS)r!r?rTr#r#r$r%-szSessionContext.__init__r)r&cCsdS)z If ``True``, the session has been discarded and cannot be used. A new session with the same ID could be created later but this instance will not come back to life. Nr#r(r#r#r$ destroyed6s zSessionContext.destroyedcCs|jS)zF The unique ID for the session associated with this context. )rSr(r#r#r$idAszSessionContext.idcCs|jS)z6 The server context for this session context )rRr(r#r#r$r?HszSessionContext.server_contextz%Callable[[Document], Awaitable[None]]zAwaitable[None])funcrcCsdS)a Runs a function with the document lock held, passing the document to the function. *Subclasses must implement this method.* Args: func (callable): function that takes a single parameter (the Document) and returns ``None`` or a ``Future`` Returns: a ``Future`` containing the result of the function Nr#)r!rWr#r#r$with_locked_documentQsz#SessionContext.with_locked_documentN) rJrKrLrMrNr%rOrrUrVr?rXr#r#r#r$r"s   r)$rM __future__rlogging getLoggerrJr<abcrrtypingrrrrr r r r Z core.typesrdocumentrrZtornado.httputilrZserver.sessionrZhandlers.handlerr__all__ZCallbackrrrZSessionDestroyedCallbackr#r#r#r$s&  (       D@