-e'dZddlmZddlZejeZddlZddlZddl Z ddl m Z m Z ddl mZddlmZmZe r dd lmZd d lmZd ZGd dZddZdS)a Provide a base class for Bokeh Application handler classes. 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. Below is an example outline of a custom handler that might modify documents based off information in some database: .. code-block:: python class DatabaseHandler(Handler): """ A Bokeh Application handler to initialize Documents from a database """ def modify_document(self, doc: Document) -> None: # do some data base lookup here to generate 'plot' # add the plot to the document (i.e modify the document) doc.add_root(plot) ) annotationsN) TYPE_CHECKINGAny)Document) ServerContextSessionContext)HTTPServerRequest) CodeRunner)HandlerceZdZUdZded<ded<ded<ded<d!d Zed"d Zed"d Zed#d Z ed#dZ d$dZ d%dZ d%dZ d&dZd&dZd'dZd"dZd"dZd S)(rzV Provide a mechanism for Bokeh applications to build up new Bokeh Documents. bool_failed str | None_error _error_detail_staticreturnNonec>d|_d|_d|_d|_dS)NF)rrrrselfs Blib/python3.11/site-packages/bokeh/application/handlers/handler.py__init__zHandler.__init__Ws#  ! c|jS)zE If the handler fails, may contain a related error message. )rrs rerrorz Handler.error_s {rc|jS)zJ If the handler fails, may contain a traceback or other details. )rrs r error_detailzHandler.error_detailfs !!rc|jS)z; ``True`` if the handler failed to modify the doc )rrs rfailedzHandler.failedms |rcdS)NTrs r safe_to_forkzHandler.safe_to_forktstrdocrc td)a Modify an application document in a specified manner. 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 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. *Subclasses must implement this method* Args: doc (Document) : A Bokeh Document to update in-place Returns: Document zimplement modify_document())NotImplementedError)rr's rmodify_documentzHandler.modify_documentzs&""?@@@rserver_contextr cdS)a. Execute code when the server is first started. Subclasses may implement this method to provide for any one-time initialization that is necessary after the server starts, but before any sessions are created. Args: server_context (ServerContext) : Nr%rr+s ron_server_loadedzHandler.on_server_loadeds  rcdS)a Execute code when the server cleanly exits. (Before stopping the server's ``IOLoop``.) Subclasses may implement this method to provide for any one-time tear down that is necessary before the server exits. Args: server_context (ServerContext) : .. warning:: In practice this code may not run, since servers are often killed by a signal. Nr%r-s ron_server_unloadedzHandler.on_server_unloadeds  rsession_contextr c KdS)a# Execute code when a new session is created. Subclasses may implement this method to provide for any per-session initialization that is necessary before ``modify_doc`` is called for the session. Args: session_context (SessionContext) : Nr%rr1s ron_session_createdzHandler.on_session_createds  rc KdS)a Execute code when a session is destroyed. Subclasses may implement this method to provide for any per-session tear-down that is necessary when sessions are destroyed. Args: session_context (SessionContext) : Nr%r3s ron_session_destroyedzHandler.on_session_destroyeds  rrequestr dict[str, Any]ciS)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. r%)rr7s rprocess_requestzHandler.process_requests  rc"|jrdS|jS)zI Return a path to app-specific static resources, if applicable. N)r#rrs r static_pathzHandler.static_paths ; 4< rcdS)aR Returns a default URL path, if applicable. Handlers subclasses may optionally implement this method, to inform the Bokeh application what URL it should be installed at. If multiple handlers specify ``url_path`` the Application will use the value from the first handler in its list of handlers. Nr%rs rurl_pathzHandler.url_paths trN)rr)rr)rr)r'rrr)r+r rr)r1r rr)r7r rr8)__name__ __module__ __qualname____doc____annotations__rpropertyrr!r#r&r*r.r0r4r6r:r<r>r%rrrrLs MMMX """X" X X AAAA*         "                        rrhandlerHandler | CodeRunnere Exceptionrrc d|_tj|_t j\}}}tj|d\}}}}tj |}|d|d|d|d| |_ dS)z4 Record an exception and details on a Handler. Tz File z, line z, in z: N) r traceback format_excrsysexc_info extract_tbospathbasenamer) rErG_ exc_tracebackfilename line_numberfunctxtrRs rhandle_exceptionrYsGO%022G,..Aq-'0';M'J'J2'N$Hk4w))HUU(UU[UUtUUPSUUGNNNr)rErFrGrHrr)rB __future__rlogging getLoggerr?logrPrMrKtypingrrdocumentr applicationr r tornado.httputilr code_runnerr __all__rrYr%rrrds*:#"""""g!! %%%%%%%%! 77777777(222222''''''  ZZZZZZZZz V V V V V Vr