PyCharm 2025.3 Help

Python 工具支持

设置 | Python | 工具

PyCharm 支持多种工具，以提高代码质量、可维护性和工作流程效率：

  • Ruff ：一种高性能的代码检查器和格式化器，可检测错误并强制执行编码规范。

  • Pyright (and basedpyright), Pyrefly, ty ：提供实时类型分析的快速类型检查器。

  • Black ：一种自动代码格式化器，有助于保持一致的风格。

Ruff

Ruff 可以在您输入时高亮问题、建议修复，并帮助在整个项目中保持一致的代码质量。 其运行速度快，并可直接在编辑器中提供实时反馈。

PyCharm 对 Ruff 的支持包括：

  • 格式化

  • 导入优化

  • 快速修复

  • 配置文件验证

  • 错误代码的内联提示

    查看错误代码的内联提示

  • 错误代码和配置选项的补全

    使用自动补全

  • 错误代码和配置选项的 Web 链接

    使用可点击的文档链接

  • 错误代码和配置选项的编辑器内文档预览

    在编辑器中预览文档

配置 Ruff

  1. 在 设置 对话框（Ctrl+Alt+S ）中，转到 Python | 工具 | Ruff。

    2. Ruff 设置

  2. 选择 启用 复选框以开始配置 Ruff 设置。

  3. 在 执行模式 设置中，选择 PyCharm 应如何搜索 Ruff 可执行文件：

    • 解释器 模式：PyCharm 会在您的解释器中搜索已安装的 Ruff 可执行文件。 要为所选解释器安装 Ruff 包，请点击 安装 Ruff。

    • 路径 模式：PyCharm 会在 $PATH 中搜索 Ruff 可执行文件。 如果未找到可执行文件，您可以点击 浏览...浏览... 图标来指定路径。

  4. 选择要启用的 Ruff 选项：

    点击 保存时的所有操作... 以配置其他选项。 如果在设置中启用了 Ruff 集成，则在运行 重新格式化代码 或 优化导入 时将使用它。

    配置保存时的操作

  5. 也可以使用 pyproject.toml、 ruff.toml 或 .ruff.toml 文件配置 Ruff 设置。 有关详细信息，请参阅 Ruff 文档。

Pyrefly

Pyrefly 是适用于 Python 的类型检查器和语言服务器。

配置 Pyrefly

  1. 在 设置 对话框（Ctrl+Alt+S ）中，转到 Python | 工具 | Pyrefly。

    2. Pyrefly 设置

  2. 选择 启用 复选框以开始配置 Pyrefly 设置。

  3. 在 执行模式 设置中，选择 PyCharm 应如何搜索 Pyrefly 可执行文件：

    • 解释器 模式：PyCharm 会在您的解释器中搜索已安装的 Pyrefly 可执行文件。 要为所选解释器安装 Pyrefly 包，请点击 安装 Pyrefly。

    • 路径 模式：PyCharm 会在 $PATH 中搜索 Pyrefly 可执行文件。 如果未找到可执行文件，您可以点击 浏览... 图标来指定路径。

  4. 选择要启用的 Pyrefly 选项：

  5. 可以使用 pyrefly.toml 或 pyproject.toml 文件配置 Pyrefly 设置。 有关详细信息，请参阅 Pyrefly 文档。

Pyright 和 basedpyright

Pyright 是 Python 的静态类型检查器。

basedpyright 是 Pyright 的一个分支，包含多项类型检查改进。

配置 Pyright

  1. 在 设置 对话框（Ctrl+Alt+S ）中，转到 Python | 工具 | Pyright。

    2. Pyright 设置

  2. 选择 启用 复选框以开始配置 Pyright 设置。

  3. 在 执行模式 设置中，选择 PyCharm 应如何搜索 Pyright 可执行文件：

    • 解释器 模式：PyCharm 会在您的解释器中搜索已安装的 Pyright 可执行文件。 要为所选解释器安装 basedpyright 包，请点击 安装 basedpyright。

      如果您想使用纯 Pyright，请安装 pyright[nodejs]。

    • 路径 模式：PyCharm 会在 $PATH 中搜索 Pyright 可执行文件。 如果未找到可执行文件，您可以点击 浏览... 图标来指定路径。

  4. 选择要启用的 Pyright 选项：

  5. 可以使用 pyrightconfig.json 或 pyproject.toml 文件配置 Pyright 设置。 有关详细信息，请参阅 Pyright 和 basedpyright 文档。

ty

ty 是一个快速的 Python 类型检查器，使用 Rust 编写。 当前为预览版，功能可能不完整。

配置 ty

  1. 在 设置 对话框（Ctrl+Alt+S ）中，转到 Python | 工具 | ty。

    2. ty 设置

  2. 选择 启用 复选框以开始配置 ty 设置。

  3. 在 执行模式 设置中，选择 PyCharm 应如何搜索 ty 可执行文件：

    • 解释器 模式：PyCharm 会在您的解释器中搜索已安装的 ty 可执行文件。 要为所选解释器安装 ty 包，请点击 安装 ty。

    • 路径 模式，PyCharm 会在 $PATH 中搜索 ty 可执行文件。 如果未找到可执行文件，您可以点击 浏览... 图标来指定路径。

  4. 选择要启用的 ty 选项：

  5. 可以使用 pyproject.toml 或 ty.toml 文件配置 ty 设置。 有关详细信息，请参阅 ty 文档。

Black

您可以在 PyCharm 中使用 Black 格式化您的 Python 代码。

配置 Black

  1. 在 设置 对话框（Ctrl+Alt+S ）中，转到 Python | 工具 | Black。

  2. 在 执行模式 下拉列表中，选择 PyCharm 应如何运行 Black 格式化器：

    • 可执行文件 模式：PyCharm 使用您系统中安装的 Black 可执行文件。 如果未找到可执行文件，您可以点击 浏览... 图标来指定路径：

      配置 Black 格式化器：二进制模式

    • 软件包 模式：PyCharm 使用项目解释器中安装的 Black 包。 要为所选解释器安装 Black 包，请点击 安装 Black：

      配置 Black 格式化器：包模式

  3. 选择您希望何时运行 Black 格式化器：

    • 启用 代码重新格式化时 复选框，以在您按下 Ctrl+Alt+L 或从主菜单选择 代码 | 重新设置代码格式 时使用 Black 而不是内置格式化器。

    • 如果您希望在保存更改时自动运行 Black 格式化器，请选择 保存时。 要配置其他操作，请点击 保存时的所有操作...。

  4. 可以在 pyproject.toml 文件中配置 Black 格式化器的设置。 对于 Black v21.4.0 及更高版本，这些设置会自动应用。 有关详细信息，请参阅 Black 文档。

    您还可以使用 设置 字段来指定其他选项，或覆盖来自 pyproject.toml 的设置：

    指定 Black CLI 选项

    有关详细信息，请参阅 Black CLI 参考。

最后修改日期： 2025年 12月 2日
Python 代码洞察解析引用