bokeh.application.application¶
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.
-
class
bokeh.application.application.
Application
(*handlers, **kwargs)¶ An Application is a factory for Document instances.
-
add
(handler)¶ Add a handler to the pipeline used to initialize new documents.
Parameters: handler (Handler) – a handler for this Application to use to process Documents
-
create_document
()¶ Creates and initializes a document using the Application’s handlers.
-
initialize_document
(doc)¶ Fills in a new document using the Application’s handlers.
-
on_server_loaded
(server_context)¶ 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.
-
on_server_unloaded
(server_context)¶ 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.
-
on_session_created
(*args, **kwargs)¶ 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 theFuture
completes.
-
on_session_destroyed
(*args, **kwargs)¶ 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 beTrue
.
-
handlers
¶ The ordered list of handlers this Application is configured with.
-
metadata
¶ Arbitrary user-supplied metadata to associate with this application.
-
safe_to_fork
¶
-
static_path
¶ Path to any (optional) static resources specified by handlers.
-
-
class
bokeh.application.application.
ServerContext
¶ 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.
-
add_next_tick_callback
(callback)¶ Add a callback to be run on the next tick of the event loop.
Subclasses must implement this method.
Parameters: callback (callable) – a callback to add
The callback will execute on the next tick of the event loop, and should have the form
def callback()
(i.e. it should not accept any arguments)
-
add_periodic_callback
(callback, period_milliseconds)¶ Add a callback to be run periodically until it is removed.
Subclasses must implement this method.
Parameters:
-
add_timeout_callback
(callback, timeout_milliseconds)¶ Add a callback to be run once after timeout_milliseconds.
Subclasses must implement this method.
Parameters:
-
remove_next_tick_callback
(callback)¶ Remove a callback added with
add_next_tick_callback
, before it runs.Subclasses must implement this method.Parameters: callback (callable) – the callback to remove
-
remove_periodic_callback
(callback)¶ Removes a callback added with
add_periodic_callback
.Subclasses must implement this method.
Parameters: callback (callable) – the callback to remove
-
remove_timeout_callback
(callback)¶ Remove a callback added with
add_timeout_callback
, before it runs.Subclasses must implement this method.
Parameters: callback (callable) – the callback to remove
-
sessions
¶ SessionContext instances belonging to this application.
Subclasses must implement this method.
-
-
class
bokeh.application.application.
SessionContext
(server_context, session_id)¶ A harness for server-specific information and tasks related to Bokeh sessions.
This base class is probably not of interest to general users.
-
with_locked_document
(func)¶ Runs a function with the document lock held, passing the document to the function.
Subclasses must implement this method.
Parameters: func (callable) – function that takes a single parameter (the Document) and returns None
or aFuture
Returns: a Future
containing the result of the function
-
destroyed
¶ 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.
-
id
¶ The unique ID for the session associated with this context.
-
server_context
¶ The server context for this session context
-