bokeh.settings

使用环境变量控制全局配置选项。Bokeh的其他部分可以引用的全局设置对象。

定义的设置

可在上访问设置 bokeh.settings.settings 实例，通过访问器方法。例如：

settings.minified()

Bokeh提供以下定义的设置：

allowed_ws_origin

Type

表 [弦]

变量环境

BOKEH_ALLOW_WS_ORIGIN

Default

[]

开发默认值

（未设置）

Bokeh服务器应用程序允许的websocket源的逗号分隔列表。

auth_module

Type

弦

变量环境

BOKEH_AUTH_MODULE

Default

没有

开发默认值

（未设置）

为Bokeh服务器实现用户身份验证功能的Python模块的路径。

警告

将执行此模块的内容！

browser

Type

弦

变量环境

BOKEH_BROWSER

Default

没有

开发默认值

'无'

Bokeh用来显示文档的默认浏览器。

有效值是python标准库可以理解的任何浏览器名称 webbrowser 模块。

version

Type

弦

变量环境

BOKEH_CDN_VERSION

Default

没有

开发默认值

（未设置）

用于CDN资源的BokehJS的哪个版本。

见 Resources 完整详细信息的类引用。

docs_cdn

Type

弦

变量环境

BOKEH_DOCS_CDN

Default

没有

开发默认值

（未设置）

构建文档时用于加载CDN资源的BokehJS版本。

要使用本地构建的BokehJS生成和显示文档，请使用 local . 例如：

BOKEH_DOCS_CDN=local make clean serve

将使用本地构建的BokehJS生成文档的新副本，并打开一个新的浏览器选项卡来查看它们。

否则，该值将被解释为CDN的版本。例如：

BOKEH_DOCS_CDN=1.4.0rc1 make clean

将生成使用BokehJS版本的文档 1.4.0rc1 来自CDN。

docs_version

Type

弦

变量环境

BOKEH_DOCS_VERSION

Default

没有

开发默认值

（未设置）

在构建文档时要规定Bokeh版本。

使用新的修订或更改重新部署文档的现有版本时，必须使用此设置。

ignore_filename

Type

布尔

变量环境

BOKEH_IGNORE_FILENAME

Default

假

开发默认值

（未设置）

保存Bokeh内容时是否忽略当前脚本文件名。

log_level

Type

弦

变量环境

BOKEH_LOG_LEVEL

Default

'信息'

开发默认值

'调试'

设置JavaScript BokehJS代码的日志级别。

有效值按严重程度的顺序为：

  • trace

  • debug

  • info

  • warn

  • error

  • fatal

minified

Type

布尔

变量环境

BOKEH_MINIFIED

Default

对

开发默认值

假

Bokeh是否应该使用小型BokehJS资源。

legacy

Type

布尔

变量环境

BOKEH_LEGACY

Default

假

开发默认值

假

Bokeh是否应该使用遗留（IE和phantomjs兼容）BokehJS资源。

nodejs_path

Type

弦

变量环境

BOKEH_NODEJS_PATH

Default

没有

开发默认值

（未设置）

节点可执行文件的路径。

NodeJS是PNG和SVG导出以及编译自定义扩展所必需的可选依赖项。Bokeh将尝试自动定位已安装的节点可执行文件。使用此环境变量可以覆盖Bokeh找到的位置，或指向非标准位置。

validate_doc

Type

布尔

变量环境

BOKEH_VALIDATE_DOC

Default

对

开发默认值

（未设置）

Bokeh是否应对文件进行验证检查。

将此值设置为False可能会带来较小的性能改进。

pretty

Type

弦

变量环境

BOKEH_PRETTY

Default

假

开发默认值

对

JSON字符串是否应该很好地打印。

py_log_level

Type

日志级别

变量环境

BOKEH_PY_LOG_LEVEL

Default

'无'

开发默认值

'调试'

Python Bokeh代码的日志级别。

有效值按严重程度的顺序为：

  • trace

  • debug

  • info

  • warn

  • error

  • fatal

  • none

resources

Type

弦

变量环境

BOKEH_RESOURCES

Default

“cdn”

开发默认值

'绝对偏差'

配置什么样的BokehJS资源，例如 inline 或 cdn

见 Resources 完整详细信息的类引用。

rootdir

Type

弦

变量环境

BOKEH_ROOTDIR

Default

没有

开发默认值

（未设置）

要用于的根目录 relative 资源

见 Resources 完整详细信息的类引用。

secret_key

Type

弦

变量环境

BOKEH_SECRET_KEY

Default

没有

开发默认值

（未设置）

Bokeh部署中唯一的长的、加密的随机秘密。

sign_sessions

Type

弦

变量环境

BOKEH_SIGN_SESSIONS

Default

假

开发默认值

（未设置）

Boeh服务器是否只允许使用密钥签名的会话。

如果属实， BOKEH_SECRET_KEY 也必须设置。

simple_ids

Type

布尔

变量环境

BOKEH_SIMPLE_IDS

Default

对

开发默认值

（未设置）

Bokeh是否应该对模型id使用简单整数（从1000开始）。

如果为False，Bokeh将使用uuid作为对象标识符。例如，如果多个流程对一个Bokeh文档起作用，则可能需要这样做。

ssl_certfile

Type

弦

变量环境

BOKEH_SSL_CERTFILE

Default

没有

开发默认值

（未设置）

SSL终止的证书文件的路径。

ssl_keyfile

Type

弦

变量环境

BOKEH_SSL_KEYFILE

Default

没有

开发默认值

（未设置）

SSL终止的私钥文件的路径。

ssl_password

Type

弦

变量环境

BOKEH_SSL_PASSWORD

Default

没有

开发默认值

（未设置）

解密SSL密钥文件的密码（如果需要）。

strict

Type

布尔

变量环境

BOKEH_STRICT

Default

（未设置）

开发默认值

（未设置）

验证检查是否应该严格（即引发错误）。

xsrf_cookies

Type

布尔

变量环境

BOKEH_XSRF_COOKIES

Default

假

开发默认值

（未设置）

是否在Bokeh服务器上启用Tornado XSRF cookie保护。这仅适用于同时使用身份验证模块或自定义处理程序的情况。看到了吗

https://www.tornarweb.org/en/stable/guide/security.htmlcross-网站请求防伪

有关龙卷风中XSRF保护的更多信息。当此设置处于活动状态时，需要适当地检测所有PUT、POST和DELETE处理程序。

优先

始终按以下顺序设置值：

立即提供的值

这些值传递给设置：

settings.minified(minified_val)

如果 minified_val 不是没有，那么它将按原样返回。否则，如果没有传递，则设置将继续查找值的搜索顺序。这对于传递默认为无的可选函数参数非常有用。如果参数传递给函数，则它将优先。

以前的用户设置值

如果在代码中明确设置了该值：

settings.minified = False

则此值将优先于其他源。应用程序可以使用此功能设置命令行上提供的值，以便它们优先于环境变量。

用户指定的配置重写文件

显式加载的YAML配置文件中的值：

settings.load_config("/path/to/bokeh.yaml)

任何值来自 bokeh.yaml 将优先于下面的源。应用程序可以提供命令行参数来加载这样的文件。例如 bokeh serve --use-config myconf.yaml

环境变量

在关联的环境变量中找到的值：

BOKEH_MINIFIED=no bokeh serve app.py
本地用户配置文件

Bokeh将在当前用户的主目录中查找YAML配置文件 ${{HOME}}/.bokeh/bokeh.yaml .

全局系统配置（尚未实现）

未来的支持计划从全局系统配置加载Bokeh设置。

本地默认值

以下是访问设置时定义的默认值：

settings.resources(default="server")

除全局默认值外，本地默认值的优先级低于其他所有设置机制。

全局默认值

这些是由设置声明定义的默认值。它们的优先级低于其他设置机制。

如果在搜索所有这些位置后未获得值，则将引发运行时错误。

API

在 settings 对象：

class Settings[源代码]
bokehjsdir()[源代码]

BokehJS源树的位置。

css_files()[源代码]

BokehJS目录中的CSS文件。

js_files()[源代码]

BokehJS目录中的JS文件。

load_config(location)[源代码]

加载用户指定的覆盖配置文件。

该文件应为具有 key: value 线。

secret_key_bytes() → Optional[bytes][源代码]

返回密钥，转换为字节并缓存。