U /eD@sdZddlmZddlZeeZddlZddlZddl Z ddl m Z m Z m Z ddlmZddlmZmZe rdd lmZd d lmZd ZGd ddZddddddZdS)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_CHECKINGAnyDict)Document) ServerContextSessionContext)HTTPServerRequest) CodeRunner)Handlerc@seZdZUdZded<ded<ded<ded<dd d d Zedd d d Zedd ddZedd ddZ edd ddZ dddddZ dddddZ dddddZ dddd d!Zdddd"d#Zd$d%d&d'd(Zdd d)d*Zdd d+d,Zd-S).rzm Provide a mechanism for Bokeh applications to build up new Bokeh Documents. .. autoclasstoc:: bool_failedz str | None_error _error_detail_staticNone)returncCsd|_d|_d|_d|_dS)NF)rrrrselfrF/tmp/pip-unpacked-wheel-f5fndrjf/bokeh/application/handlers/handler.py__init__YszHandler.__init__cCs|jS)zE If the handler fails, may contain a related error message. )rrrrrerrorasz Handler.errorcCs|jS)zJ If the handler fails, may contain a traceback or other details. )rrrrr error_detailhszHandler.error_detailcCs|jS)z; ``True`` if the handler failed to modify the doc )rrrrrfailedoszHandler.failedcCsdS)NTrrrrr safe_to_forkvszHandler.safe_to_forkr)docrcCs tddS)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()N)NotImplementedError)rrrrrmodify_document|szHandler.modify_documentr )server_contextrcCsdS)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) : Nrrr"rrron_server_loadeds zHandler.on_server_loadedcCsdS)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. Nrr#rrron_server_unloadedszHandler.on_server_unloadedr )session_contextrcsdS)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) : Nrrr&rrron_session_createds zHandler.on_session_createdcsdS)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) : Nrr'rrron_session_destroyeds zHandler.on_session_destroyedr zDict[str, Any])requestrcCsiS)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)rr*rrrprocess_requests zHandler.process_requestcCs|jr dS|jSdS)zI Return a path to app-specific static resources, if applicable. N)rrrrrr static_pathszHandler.static_pathcCsdS)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. Nrrrrrurl_paths zHandler.url_pathN)__name__ __module__ __qualname____doc____annotations__rpropertyrrrrr!r$r%r(r)r+r,r-rrrrrLs,      rzHandler | CodeRunner Exceptionr)handlererc Csfd|_t|_t\}}}t|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) r5r6_ exc_tracebackfilename line_numberfunctxtr?rrrhandle_exceptions   rF)r1 __future__rlogging getLoggerr.logr=r:r8typingrrrdocumentrZ applicationr r Ztornado.httputilr Z code_runnerr __all__rrFrrrrs