PyCharm 2025.2 Help

使用 pyproject.toml

您可以在项目目录中的 pyproject.toml 文件中指定项目依赖项。 您可以手动创建 pyproject.toml ,或者 配置一个 Poetry 环境 ,以便自动创建它。

PyCharm 提供包名称的代码补全功能,并提供安装缺失依赖项的快速修复操作。

指定项目依赖项

  1. 在编辑器中打开 pyproject.toml

  2. 找到或创建 [project] 部分。

  3. dependencies 数组中以字符串形式指定所需包的名称。

    当您开始输入包名时,PyCharm 会提供补全选项:

    在 pyproject.toml 中为包名提供代码补全

    Enter 插入建议。

您还可以在 [project.optional-dependencies] 部分中提供 项目的可选依赖项 ,或者在 [build-system.requires] 中指定 构建时依赖项

如果包名被高亮显示,这意味着该包尚未为当前的 Python 解释器安装。

安装缺少的软件包

  1. 将插入符号放在高亮显示的包名处,然后按 Alt+Enter

  2. 点击 安装软件包

在 pyproject.toml 中安装包的快速修复

更新 .lock 文件

  1. 在编辑器中打开 pyproject.toml

  2. 编辑 pyproject.toml 以添加、移除或更改依赖项。

    如果 .锁定 文件已过期,编辑器右上角会显示包含可用操作的弹出窗口。 如果未显示弹出窗口,请将鼠标悬停在该区域以显示它。

  3. 可用操作取决于环境类型:

    • Poetry 锁定 :更新 poetry .lock 文件以匹配 pyproject.toml 中的依赖项。

      Poetry 锁定
    • Poetry 更新 :根据 pyproject .toml 安装或更新依赖项,并相应更新 poetry.lock 文件。

      Poetry 更新

    有关更多信息,请参阅 Poetry 文档

    • uv 锁定 :升级所有依赖项到允许的最新版本,并更新 uv.lock 文件。

      uv 锁定
    • uv 同步 :更新项目环境,以确保所有依赖项与 uv.lock 文件保持一致。

      uv 同步

    有关更多信息,请参阅 uv 文档

    • Hatch 运行 :运行默认 Hatch 环境以根据 pyproject.toml 安装或更新软件包。 如果任何依赖项发生更改,环境将自动更新以反映这些更改。

      Hatch 运行

    有关更多信息,请参阅 Hatch 文档

最后修改日期: 2025年 9月 26日