bokeh.sphinxext#

为了帮助自动化和简化Bokeh文档的生成，创建了几个Sphinx扩展。除了bokeh.sphinxext.bokeh_plot之外，大多数这些扩展都不会引起普遍兴趣，它允许任何人直接在自己的Sphinx文档中包含和嵌入Bokeh图表。

bokeh_autodoc#

将Bokeh扩展集成到Sphinx自动文档中。

确保在适当的情况下，autoclass等自动文档指令自动使用Bokeh特定的指令。以下Bokeh扩展已配置：

要启用此扩展，请将“bokeh.sphinxext.bokeh_autodoc”添加到您的Sphinx配置模块中的扩展列表中。

bokeh_color#

记录Bokeh命名的颜色。

bokeh-color 指令接受一个命名颜色作为其参数：

.. bokeh-color:: aliceblue

并生成一个带标签的颜色样本作为输出。

aliceblue

bokeh-color 方向可以显式使用，但也可以与 bokeh_autodoc 扩展一起使用。

要启用此扩展，请将“bokeh.sphinxext.bokeh_color”添加到您的Sphinx配置模块中的扩展列表中。

bokeh_dataframe#

生成一个pandas Dataframe的内联可视化表示。

该指令将嵌入df.head().to_html()的输出到HTML输出中。

例如：

:bokeh-dataframe:`bokeh.sampledata.sprint.sprint`

将生成输出：

姓名 国家 奖牌 时间 年份 缩写 速度 米数差距 奖牌填充 奖牌线条 选中姓名
0 Usain Bolt JAM 金牌 9.63 2012 JAM 10.384216 0.000000 #efcf6d #c8a850
1 Yohan Blake JAM 银牌 9.75 2012 JAM 10.256410 1.230769 #cccccc #b0b0b1
2 Justin Gatlin USA 铜牌 9.79 2012 USA 10.214505 1.634321 #c59e8a #98715d
3 Usain Bolt JAM 金牌 9.69 2008 JAM 10.319917 0.619195 #efcf6d #c8a850
4 Richard Thompson TRI 银牌 9.89 2008 TRI 10.111223 2.628918 #cccccc #b0b0b1

要启用此扩展，请将“bokeh.sphinxext.bokeh_dataframe”添加到您的Sphinx配置模块中的扩展列表中。

bokeh_enum#

彻底记录Bokeh枚举

bokeh-enum 指令为枚举生成有用的文档，包括所有允许的值。如果值的数量很大，完整列表将放在一个可折叠的代码块中。

该指令以Bokeh枚举变量的名称作为参数，模块名称作为选项。可以添加一个可选的描述作为内容：

.. bokeh-enum:: baz
    :module: bokeh.sphinxext.sample

    Specify a baz style

示例

上面的指令将生成以下输出：

baz = Enumeration(a, b, c)#

指定一个baz样式

虽然bokeh-enum可以显式使用，但通常与bokeh_autodoc扩展一起使用更为方便。结合使用时，上述相同的输出将直接从以下代码生成：

#: Specify a baz style
baz = enumeration("a", "b", "c")

要启用此扩展，请将“bokeh.sphinxext.bokeh_enum”添加到您的Sphinx配置模块中的扩展列表中。

bokeh_jinja#

自动记录Bokeh Jinja2模板。

该指令将模块路径作为属性名称，该属性名称定义了Jinja2模板：

.. bokeh-jinja:: bokeh.core.templates.FILE

任何模板参数都将显示，并且模板源代码将以可折叠的代码块形式呈现。例如，上述用法将生成以下输出：

FILE = <Template 'file.html'>

将Bokeh模型渲染成基本的.html文件。

Parameters:

  • title (str) – 标签的值

  • plot_resources (str) – 通常是 RESOURCES 的输出

  • plot_script (str) – 通常是 PLOT_SCRIPT 的输出

用户可以通过提供自己的Jinja2模板来自定义文件输出，该模板接受这些相同的参数。

Template: file.html
{% from macros import embed %}
<!DOCTYPE html>
<html lang="en">
  {% block head %}
  <head>
  {% block inner_head %}
    <meta charset="utf-8">
    <title>{% block title %}{{ title | e if title else "Bokeh Plot" }}{% endblock %}</title>
  {%  block preamble -%}{%- endblock %}
  {%  block resources %}
    <style>
      html, body {
        box-sizing: border-box;
        display: flow-root;
        height: 100%;
        margin: 0;
        padding: 0;
      }
    </style>
  {%   block css_resources -%}
    {{- bokeh_css if bokeh_css }}
  {%-  endblock css_resources %}
  {%   block js_resources -%}
    {{  bokeh_js if bokeh_js }}
  {%-  endblock js_resources %}
  {%  endblock resources %}
  {%  block postamble %}{% endblock %}
  {% endblock inner_head %}
  </head>
  {% endblock head%}
  {% block body %}
  <body>
  {%  block inner_body %}
  {%    block contents %}
  {%      for doc in docs %}
  {{        embed(doc) if doc.elementid }}
  {%-       for root in doc.roots %}
  {%          block root scoped %}
  {{            embed(root) }}
  {%          endblock %}
  {%        endfor %}
  {%      endfor %}
  {%    endblock contents %}
  {{ plot_script | indent(4) }}
  {%  endblock inner_body %}
  </body>
  {% endblock body%}
</html>

要启用此扩展，请将“bokeh.sphinxext.bokeh_jinja”添加到您的Sphinx配置模块中的扩展列表中。

bokeh_model#

彻底记录Bokeh模型类。

bokeh-model 指令将自动记录 Bokeh 模型子类的所有属性（包括 Bokeh 属性）。还会生成一个显示所有可能的 JSON 字段的 JSON 原型。

该指令以Bokeh模型类的名称作为参数，并将其模块作为选项：

.. bokeh-model:: Foo
    :module: bokeh.sphinxext.sample

示例

对于以下bokeh.sphinxext.sample.Foo的定义：

class Foo(Model):
    ''' This is a Foo model. '''
    index = Either(Auto, Enum('abc', 'def', 'xzy'), help="doc for index")
    value = Tuple(Float, Float, help="doc for value")

用法产生输出：

class Foo(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

基础类：Model

这是一个Foo模型。

JSON Prototype
{
  "id": "p72051", 
  "index": "auto", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "value": {
    "name": "unset", 
    "type": "symbol"
  }
}
index = 'auto'#
Type:

Either(Auto, Enum(Enumeration(abc, def, xzy)))

索引文档

name = None#
Type:

Nullable(String)

此模型的任意用户提供的名称。

在查询文档以检索特定Bokeh模型时，此名称可能很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，没有强制执行唯一性保证或其他条件，Bokeh也不会直接使用这些名称。

syncable = True#
Type:

Bool

指示当在网页浏览器中更新时，此模型是否应同步回Bokeh服务器。设置为False可能有助于在处理频繁更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []#
Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者只是将任何必要的元数据附加到模型的一种便捷方式，这些元数据可以通过CustomJS回调等方式访问。

注意

对于提供的任何标签，没有强制执行唯一性保证或其他条件，Bokeh也不会出于任何原因直接使用这些标签。

value = Undefined#
Type:

Tuple(Float, Float)

值的文档

apply_theme(property_values: dict[str, Any]) → None#

应用一组主题值，这些值将用于替代默认值，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和HasProps实例都不应修改它）。

Parameters:

property_values (dict) – 用于替换默认值的主题值

Returns:

无

classmethod clear_extensions() → None#

清除当前定义的所有自定义扩展。

序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self#

复制一个HasProps对象。

这将创建原始模型的浅克隆，即任何可变的容器或子模型将不会被复制。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]#

收集此类上所有DataSpec属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

DataSpec 属性的名称

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]#

属性描述符的列表，按定义的顺序排列。

destroy() → None#

清理对文档和属性的引用

equals(other: HasProps) → bool#

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

如果属性在结构上相等，则为True，否则为False

使用JavaScript链接两个Bokeh模型属性。

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个Bokeh模型属性值发生变化时更新它。

Parameters:

  • attr (str) – 此模型上的Bokeh属性的名称

  • 其他 (Model) – 一个要链接到 self.attr 的 Bokeh 模型

  • other_attr (str) – 要链接在一起的other上的属性

  • attr_selector (int | str) – 用于链接可下标对象 attr 中项目的索引

在版本1.1中添加

Raises:

ValueError –

示例

这段代码使用了 js_link:

select.js_link('value', plot, 'sizing_mode')

等同于以下内容：

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，使用attr_selector将范围滑块的左侧附加到绘图的x_range：

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这相当于：

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)
js_on_change(event: str, *callbacks: JSChangeCallback) → None#

将一个CustomJS回调附加到任意的BokehJS模型事件。

在BokehJS方面，模型属性的更改事件具有"change:property_name"的形式。为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，那么它将自动加上"change:"前缀：

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能对响应有用。例如，每当数据流式传输到ColumnDataSource时运行回调，可以在源上使用"stream"事件：

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None#

在类上找到Bokeh属性的PropertyDescriptor，给定属性名称。

Parameters:

  • name (str) – 要搜索的属性的名称

  • raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None#

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

  • attr (str) – 此对象上的一个属性名称

  • *callbacks (callable) – 要注册的回调函数

Returns:

无

示例

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None#

当此模型上发生指定事件时运行回调

并非所有模型都支持所有事件。 有关哪些模型能够触发这些事件的更多信息，请参见bokeh.events中的具体事件。

classmethod parameters() → list[Parameter]#

生成适用于从字形派生的函数的Python Parameter值。

Returns:

列表(参数)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]#

收集此类的属性名称。

警告

在Bokeh的未来版本中，此方法将返回一个将属性名称映射到属性对象的字典。为了使当前使用此方法的方式具有未来兼容性，请将返回值包装在list中。

Returns:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]#

收集此类上所有具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

具有引用的属性名称

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

不可序列化的属性将被跳过，属性值以“序列化”格式呈现，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重构对象实例所需的信息。

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

使用谓词查询HasProps实例的属性值。

Parameters:

  • query (callable) – 一个可调用对象，接受属性描述符并返回 True 或 False

  • include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]#

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None#

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]#

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None#

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何内容，则返回None :param selector: :type selector: JSON-like

Returns:

模型

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None#

从JSON设置此对象的属性值。

Parameters:

  • name (str) – 要设置的属性名称

  • value (JSON-value) – 要设置给属性的值

  • setter (ClientSession 或 ServerSession 或 None, 可选) –

    这用于防止对Bokeh应用程序的“回旋镖”更新。

    在Bokeh服务器应用程序的上下文中，属性的传入更新将使用正在执行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置器与自身进行比较，并抑制源自自身的任何更新。

Returns:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None#

使用指定的属性/值更新来更新与给定选择器匹配的对象。

Parameters:

  • selector (类似JSON的)

  • 更新 (dict)

Returns:

无

themed_values() → dict[str, Any] | None#

获取任何主题提供的覆盖。

结果以属性名称到值的字典形式返回，如果此实例没有主题覆盖任何值，则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep#

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None#
unapply_theme() → None#

移除任何主题值并恢复默认设置。

Returns:

无

update(**kwargs: Any) → None#

从给定的关键字参数更新对象的属性。

Returns:

无

示例

以下是等价的：

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)
property document: Document | None#

该模型附加到的Document（可以为None）

bokeh-model 方向可以显式使用，但它也可以与 bokeh_autodoc 扩展一起使用。

要启用此扩展，请将“bokeh.sphinxext.bokeh_model”添加到您的Sphinx配置模块中的扩展列表中。

bokeh_options#

彻底记录Bokeh选项类。

bokeh-options 指令将自动在“关键字参数”标题下记录 Bokeh Options 类的所有属性。

该指令以Bokeh Options子类的名称作为参数，并将其模块作为选项：

.. bokeh-options:: Opts
    :module: bokeh.sphinxext.sample

示例

对于以下bokeh.sphinxext.sample.Opts的定义：

class Opts(Options):
    ''' This is an Options class '''

    host = String(default="localhost", help="a host to connect to")
    port = Int(default=5890, help="a port to connect to")

上述用法产生以下输出：

Keyword Arguments:

  • 主机 (String): 要连接的主机（默认：'localhost'）

  • 端口 (Int): 要连接的端口（默认值：5890）

要启用此扩展，请将“bokeh.sphinxext.bokeh_options”添加到您的Sphinx配置模块中的扩展列表中。

bokeh_palette#

生成单个调色板的内联视觉表示。

:bokeh-palette: 角色可以通过提供以下任意一项来使用：

  • 一个来自 bokeh.palettes 的调色板名称，例如 Spectral9

  • 一个来自 bokeh.palettes 的调色板函数，带有参数调用，例如 viridis(12)

  • 明确的颜色列表：['#000000', '#333333', '#666666', '#999999', '#cccccc', '#ffffff']

以下指令的使用是有效的：

  • 按名称

:bokeh-palette:`Spectral9`

  • 通过函数

:bokeh-palette:`viridis(12)`

  • 按列表

:bokeh-palette:`['#000000', '#333333', '#666666', '#999999', '#cccccc', '#ffffff']`

调色板样本的高度为20像素。对于少于20种颜色的调色板，样本的默认宽度为20像素。如果提供更大的调色板，HTML跨度的宽度会逐渐减少，最小为一个像素。例如，使用表达式显示完整的Viridis调色板

:bokeh-palette:`viridis(256)`

将生成输出：

</span

要启用此扩展，请将“bokeh.sphinxext.bokeh_palette”添加到您的Sphinx配置模块中的扩展列表中。

bokeh_palette_group#

生成Bokeh调色板组中调色板的视觉表示。

bokeh.palettes 模块暴露了诸如 mpl、brewer 和 d3 等属性，这些属性提供了调色板组。bokeh-palette-group 指令接受这些组中的一个名称，并为组中的每个调色板生成一个可视化的颜色矩阵。

例如，以下指令的用法：

.. bokeh-palette-group:: mpl

生成输出：

Cividis
3
4
5
6
7
8
9
10
11

地狱
3
4
5
6
7
8
9
10
11

岩浆
3
4
5
6
7
8
9
10
11

等离子体
3
4
5
6
7
8
9
10
11

Viridis
3
4
5
6
7
8
9
10
11

注意

此扩展假定Bootstrap和JQuery都存在（这是Bokeh文档主题的情况）。如果在Bokeh文档之外使用此主题，请确保手动包含这些资源。

要启用此扩展，请将“bokeh.sphinxext.bokeh_palette_group”添加到您的Sphinx配置模块中的扩展列表中。

bokeh_plot#

在Sphinx HTML文档中包含Bokeh图表。

对于其他输出类型，将生成占位符文本 [graph]。

bokeh-plot 指令可以通过以下方式使用：

源文件的路径 作为指令的参数：

.. bokeh-plot:: path/to/plot.py

注意

.py 脚本不会自动扫描！为了将某些目录包含到 .py 扫描过程中，请在 sphinx conf.py 文件中使用以下指令：bokeh_plot_pyfile_include_dirs = [“dir1”,”dir2”]

内联代码 作为指令的内容：

.. bokeh-plot::

    from bokeh.plotting import figure, output_file, show

    output_file("example.html")

    x = [1, 2, 3, 4, 5]
    y = [6, 7, 6, 4, 5]

    p = figure(title="example", width=300, height=300)
    p.line(x, y, line_width=2)
    p.scatter(x, y, size=10, fill_color="white")

    show(p)

此指令也与Sphinx自动文档结合使用，当在文档字符串中使用时。

bokeh-plot 指令接受以下选项：

process-docstring (bool):

是否在格式化块中显示文档字符串，与源代码分开。

source-position (enum(‘above’, ‘below’, ‘none’)):

格式化源代码块的位置（如果有的话）。

linenos (bool):

是否在源代码旁边显示行号。

示例

上面的内联示例代码产生以下输出：

from bokeh.plotting import figure, output_file, show

output_file("example.html")

x = [1, 2, 3, 4, 5]
y = [6, 7, 6, 4, 5]

p = figure(title="example", width=300, height=300)
p.line(x, y, line_width=2)
p.scatter(x, y, size=10, fill_color="white")

show(p)

要启用此扩展，请将“bokeh.sphinxext.bokeh_plot”添加到您的Sphinx配置模块中的扩展列表中。

bokeh_prop#

彻底记录Bokeh属性特性。

bokeh-prop 指令生成 Bokeh 模型属性的文档，包括相关属性类型的交叉链接。此外，还会显示每个属性的帮助字符串。

该指令以Bokeh属性的名称 (class.attr) 作为其参数，并将模块作为选项：

.. bokeh-prop:: Bar.thing
    :module: bokeh.sphinxext.sample

示例

对于以下bokeh.sphinxext.sample.Bar的定义：

class Bar(Model):
    ''' This is a Bar model. '''
    thing = List(Int, help="doc for thing")

上述用法产生以下输出：

thing = []#
Type:

List

事物文档

bokeh-prop 方向可以显式使用，但也可以与 bokeh_autodoc 扩展一起使用。

要启用此扩展，请将“bokeh.sphinxext.bokeh_prop”添加到您的Sphinx配置模块中的扩展列表中。

bokeh_releases#

将所有Bokeh发布说明发布到单个页面上。

该指令收集docs/releases子目录中的所有发布说明文件，并以反向版本顺序包含它们。典型用法：

.. toctree::

.. bokeh-releases::

为了避免关于孤立文件的警告，请将以下内容添加到 Sphinx 的 conf.py 文件中：

exclude_patterns = ['docs/releases/*']

要启用此扩展，请将“bokeh.sphinxext.bokeh_releases”添加到您的Sphinx配置模块中的扩展列表中。

bokeh_roles#

简化链接到Bokeh Github资源。

该模块提供了可用于轻松引用Bokeh项目结构中各种来源信息的角色：

:bokeh-commit: : 链接到特定的提交

:bokeh-issue: : 链接到一个问题

:bokeh-minpy: : 提供最低支持的Python版本

:bokeh-pull: : 链接到一个拉取请求

:bokeh-requires: : 列出pyproject.toml中的安装依赖

:bokeh-tree: : （版本化的）链接到源代码树 URL

示例

以下代码：

The repo history shows that :bokeh-commit:`bf19bcb` was made in
in :bokeh-pull:`1698`, which closed :bokeh-issue:`1694`. This included
updating all of the files in the :bokeh-tree:`examples` subdirectory.

产生输出：

仓库历史显示，提交 bf19bcb 是在 拉取请求 1698 中进行的，该请求关闭了 #1694。这包括 更新了 examples 子目录中的所有文件。

要启用此扩展，请将“bokeh.sphinxext.bokeh_roles”添加到您的Sphinx配置模块中的扩展列表中。

bokeh_sitemap#

生成一个sitemap.txt以帮助搜索索引。

sitemap.txt 是文档站点中所有页面的纯文本列表。 文本文件中的每一行都列出了一个URL。它是机器可读的， 并被搜索引擎用来了解哪些页面可供索引。

生成站点地图所需的所有操作就是在Sphinx配置文件conf.py的扩展列表中列出这个模块bokeh.sphinxext.sitemap。

要启用此扩展，请将“bokeh.sphinxext.bokeh_sitemap”添加到您的Sphinx配置模块中的扩展列表中。