常用目录和文件位置#

Jupyter 将不同类型的文件(例如配置、数据、运行时文件)存储在多个不同的位置。可以通过设置环境变量来自定义每种文件类型的存储位置。

Jupyter 将 数据文件 (nbextensions, kernelspecs) 与 运行时文件 (日志, pid 文件, 连接文件) 以及 配置 (配置文件, custom.js) 分开。

配置文件#

配置文件默认存储在 ~/.jupyter 目录中。

JUPYTER_CONFIG_DIR#

设置此环境变量以使用特定目录(而非默认目录)来存放Jupyter配置文件。

除了 JUPYTER_CONFIG_DIR 之外,还可以通过 JUPYTER_CONFIG_PATH 指定额外的搜索目录。

JUPYTER_CONFIG_PATH#

设置此环境变量以提供额外的配置搜索路径目录。JUPYTER_CONFIG_PATH 应包含一系列目录,由 `` os.pathsep`` 分隔(Windows 上为 ;,Unix 上为 :)。

一个设置 JUPYTER_CONFIG_PATH 的例子是,如果笔记本或服务器扩展安装在一个自定义前缀中。由于笔记本和服务器扩展是通过配置文件自动启用的,只有当自定义前缀的 etc/jupyter 目录被添加到 Jupyter 配置搜索路径中时,自动启用才会生效。

除了上述用户配置目录外,Jupyter 还有一个搜索路径,用于加载额外的配置文件。以下是按优先顺序搜索的位置表:

Unix

Windows

JUPYTER_CONFIG_DIR

JUPYTER_CONFIG_PATH

{sys.prefix}/etc/jupyter/

/usr/local/etc/jupyter/ /etc/jupyter/

%PROGRAMDATA%\jupyter\

要列出当前正在使用的配置目录,可以从 命令行 运行以下命令:

jupyter --paths

以下命令专门显示配置目录:

jupyter --config-dir

数据文件#

Jupyter 使用搜索路径来查找可安装的数据文件,例如 内核规范 和笔记本扩展。当搜索资源时,代码将从第一个目录开始搜索,直到找到包含该资源的位置。

每个文件类别都位于搜索路径中每个目录的子目录中。例如,内核规范位于 kernels 子目录中。

JUPYTER_PATH#

设置此环境变量以提供额外的目录用于数据搜索路径。JUPYTER_PATH 应包含一系列目录,由 os.pathsep 分隔(Windows 上为 ;,Unix 上为 :)。在 JUPYTER_PATH 中给出的目录会在其他位置之前被搜索。这是作为其他条目的补充,而不是替换任何条目。

Linux(及其他自由桌面)

Mac

Windows

JUPYTER_PATH

JUPYTER_DATA_DIR 或(如果未设置) ~/.local/share/jupyter/ (尊重 $XDG_DATA_HOME

JUPYTER_DATA_DIR 或(如果未设置) ~/Library/Jupyter

JUPYTER_DATA_DIR 或(如果未设置)``%APPDATA%jupyter``

{sys.prefix}/share/jupyter/

/usr/local/share/jupyter /usr/share/jupyter

%PROGRAMDATA\jupyter

Jupyter 数据文件的配置目录,其中包含非瞬态、非配置文件。例如包括内核规范、nbextensions 或 voila 模板。

JUPYTER_DATA_DIR#

设置此环境变量以使用特定目录,而不是默认目录,作为用户数据目录。

如上所述,要列出当前使用的配置目录,可以从 命令行 运行以下命令:

jupyter --paths

以下命令显示数据目录具体内容:

jupyter --data-dir

运行时文件#

像连接文件这样的东西,它们只在特定进程的生命周期内有用,有一个运行时目录。

这些运行时文件存储在用户数据目录的 runtime/ 子目录中(上表的第二行)。

也可以使用环境变量来设置运行时目录。

JUPYTER_RUNTIME_DIR#

设置此项以覆盖 Jupyter 存储运行时文件的位置。

如上所述,要列出当前使用的配置目录,可以从 命令行 运行以下命令:

jupyter --paths

以下命令显示运行时目录,具体如下:

jupyter --runtime-dir

摘要#

JUPYTER_CONFIG_DIR 用于配置文件位置

JUPYTER_CONFIG_PATH 用于配置文件位置

JUPYTER_PATH 用于数据文件目录位置

JUPYTER_DATA_DIR 用于数据文件位置

JUPYTER_RUNTIME_DIR 用于运行时文件位置

参见

jupyter_core.paths

用于定位这些目录的 Python API。

The jupyter 命令

从命令行定位这些目录。