#-----------------------------------------------------------------------------
# Copyright (c) 2012 - 2021, Anaconda, Inc., and Bokeh Contributors.
# All rights reserved.
#
# The full license is in the file LICENSE.txt, distributed with this software.
#-----------------------------------------------------------------------------
''' Provide a Bokeh Application Handler to build up documents by running
the code from Python script (``.py``) files.
This handler is configured with the filename of a Python module. When a
Bokeh application calls ``modify_doc``, the contents of the module are run to
process a new Document for a session. When the script code is executed, the
Document being modified will be available as ``curdoc``, and any optionally
provided ``args`` will be available as ``sys.argv``.
As an example, consider the following Python module ``myapp.py``
.. code-block:: python
# myapp.py
import sys
from bokeh.io import cudoc
from bokeh.plotting import figure
p = figure(x_range=(10, 10), y_range=(10, 10), title=sys.argv[1])
curdoc().add_root(p)
The a ``ScriptHandler`` configured with this script will modify new Bokeh
Documents by adding an empty plot with a title taken from ``args``.
'''
#-----------------------------------------------------------------------------
# Boilerplate
#-----------------------------------------------------------------------------
from __future__ import annotations
import logging # isort:skip
log = logging.getLogger(__name__)
#-----------------------------------------------------------------------------
# Imports
#-----------------------------------------------------------------------------
# Standard library imports
from types import ModuleType
from typing import List
# Bokeh imports
from ...core.types import PathLike
from .code import CodeHandler
#-----------------------------------------------------------------------------
# Globals and constants
#-----------------------------------------------------------------------------
__all__ = (
'ScriptHandler',
)
#-----------------------------------------------------------------------------
# General API
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Dev API
#-----------------------------------------------------------------------------
[docs]class ScriptHandler(CodeHandler):
''' Modify Bokeh documents by executing code from Python scripts.
.. autoclasstoc::
'''
_logger_text = "%s: call to %s() ignored when running scripts with the 'bokeh' command."
_origin = "Script"
[docs] def __init__(self, *, filename: PathLike, argv: List[str] = [], package: ModuleType | None = None) -> None:
'''
Keywords:
filename (str) : a path to a Python source (".py") file
'''
with open(filename, 'r', encoding='utf-8') as f:
source = f.read()
super().__init__(source=source, filename=filename, argv=argv, package=package)
#-----------------------------------------------------------------------------
# Private API
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Code
#-----------------------------------------------------------------------------