配置文件
uv 支持在项目级别和用户级别使用持久化配置文件。
具体来说,uv 会在当前目录或最近的父目录中搜索 pyproject.toml 或 uv.toml 文件。
注意
对于在用户级别运行的 tool 命令,本地配置文件将被忽略。相反,uv 将仅从用户级配置(例如 ~/.config/uv/uv.toml)和系统级配置(例如 /etc/uv/uv.toml)中读取。
在工作区中,uv 将从工作区根目录开始搜索,忽略工作区成员中定义的任何配置。由于工作区作为一个整体被锁定,配置在所有成员之间共享。
如果找到 pyproject.toml 文件,uv 将从 [tool.uv] 表中读取配置。例如,要设置持久化的索引 URL,请将以下内容添加到 pyproject.toml 中:
(如果没有该表,pyproject.toml 文件将被忽略,uv 将继续在目录层级中搜索。)
uv 还会搜索 uv.toml 文件,其结构相同,但省略了 [tool.uv] 前缀。例如:
注意
uv.toml 文件的优先级高于 pyproject.toml 文件。因此,如果一个目录下同时存在 uv.toml 和 pyproject.toml,配置将从 uv.toml 中读取,而随附的 pyproject.toml 中的 [tool.uv] 部分将被忽略。
uv 也会在用户级和系统级的配置目录中发现 uv.toml 配置文件,例如 macOS 和 Linux 上位于 ~/.config/uv/uv.toml 或 Windows 上位于 %APPDATA%\uv\uv.toml 的用户级配置,以及 macOS 和 Linux 上位于 /etc/uv/uv.toml 或 Windows 上位于 %PROGRAMDATA%\uv\uv.toml 的系统级配置。
重要
用户级和系统级配置文件不能使用 pyproject.toml 格式。
如果同时找到了项目级、用户级和系统级配置文件,设置将被合并。项目级配置优先于用户级配置,用户级配置优先于系统级配置。(如果发现多个系统级配置文件,例如同时存在于 /etc/uv/uv.toml 和 $XDG_CONFIG_DIRS/uv/uv.toml,则仅使用最先发现的文件,其中 XDG 具有优先权。)
例如,如果某个字符串、数字或布尔值同时存在于项目级和用户级配置表中,则使用项目级值,而用户级值将被忽略。如果数组同时存在于两个表中,则数组将被合并,项目级设置将出现在合并后数组的前面。
通过环境变量提供的设置优先于持久化配置,而通过命令行提供的设置优先于前两者。
uv 接受 --no-config 命令行参数,提供该参数后,将禁用对任何持久化配置的发现。
uv 还接受 --config-file 命令行参数,该参数接受一个用于配置文件的 uv.toml 路径。提供该参数时,此文件将取代任何被发现的配置文件(例如,用户级配置将被忽略)。
设置
请参阅设置参考以获取可用设置的列表。
环境变量文件
uv run 可以从 dotenv 文件(例如 .env, .env.local, .env.development)加载环境变量,该功能由 dotenvy crate 提供支持。
要从指定位置加载 .env 文件,请设置 UV_ENV_FILE 环境变量,或向 uv run 传递 --env-file 标志。
例如,要从当前工作目录中的 .env 文件加载环境变量:
$ echo "MY_VAR='Hello, world!'" > .env
$ uv run --env-file .env -- python -c 'import os; print(os.getenv("MY_VAR"))'
Hello, world!
--env-file 标志可以多次提供,后续文件会覆盖之前文件中定义的值。若要通过 UV_ENV_FILE 环境变量提供多个文件,请用空格分隔路径(例如 UV_ENV_FILE="/path/to/file1 /path/to/file2")。
要禁用 dotenv 加载(例如覆盖 UV_ENV_FILE 或 --env-file 命令行参数),请将 UV_NO_ENV_FILE 环境变量设置为 1,或向 uv run 传递 --no-env-file 标志。
如果环境变量和 .env 文件中定义了相同的变量,则环境变量中的值优先。
配置 pip 接口
专门的 [tool.uv.pip] 部分用于仅配置 uv pip 命令行界面。此部分中的设置不会应用于 uv pip 命名空间之外的 uv 命令。但是,此部分中的许多设置在顶级命名空间中都有对应的设置,除非被 uv.pip 部分中的值覆盖,否则它们确实会应用于 uv pip 接口。
uv.pip 设置旨在紧密遵循 pip 的接口,并单独声明以保持兼容性,同时允许全局设置使用替代设计(例如 --no-build)。
例如,在 [tool.uv.pip] 下设置 index-url(如下面的 pyproject.toml 所示),将仅影响 uv pip 子命令(例如 uv pip install,但不会影响 uv sync、uv lock 或 uv run):