常见目录和文件位置#

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 使用搜索路径查找可安装的数据文件,例如 kernelspecs 和笔记本扩展。在搜索资源时,代码将从第一个目录开始搜索搜索路径,直到找到包含资源的位置。

每类文件都位于搜索路径的每个目录的子目录中。例如,内核规范位于 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 数据文件(包含非瞬态非配置文件)的配置目录。示例包括 kernelspecs、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。

jupyter 命令

从命令行查找这些目录。