PyCharm 2025.3 Help

YAML

PyCharm 允许您处理 YAML 文件( .yml .yaml ),并支持以下功能:

让我们了解编辑器中提供的一些 YAML 特定功能。

锚点和别名

PyCharm 支持使用锚点和别名。 如果您在 YAML 文件中指定了新的锚点,编辑器会显示一条警告,提示该锚点未被任何节点使用。

YAML:未使用的锚点警告

编辑器现在允许您为该锚点的别名进行 补全

YAML:补全别名

要快速查找某个锚点的用法,请将插入符号置于该锚点上并按 Ctrl+B

YAML:导航到别名

PyCharm 支持对锚点和别名执行 重命名重构 :将插入符号置于锚点上并按 Shift+F6。 或者,右键点击该锚点并选择 重构(R) | 重命名

重命名 YAML 锚点

使用 结构 工具窗口(Alt+7 )可在 YAML 文件中快速导航。 要在 结构 工具窗口中显示或隐藏复用锚点的元素,请点击 视图选项 ,或使用 别名子树

YAML 结构视图

JSON 架构

PyCharm 支持对使用 JSON 架构的 YAML 文件进行代码补全和检查。 PyCharm 可自动推断架构(基于文件位置或结构),也可以由您 手动选择。 例如,如果您在 .github/workflows 目录中拥有 GitHub Actions 工作流文件,PyCharm 将基于从 schemastore.org 自动加载的 github-workflow.json 架构建议对其选项进行补全:

YAML:根据架构补全

您可以使用 设置 对话框(Ctrl+Alt+S )的 语言 & 框架 | 架构与 DTD | 远程 JSON 架构 页面管理 JSON 架构的加载。

如有需要,您可以在 语言 & 框架 | 架构与 DTD | JSON 架构映射 中指定所需架构文件的路径。

为文件选择 JSON 架构

您可以为特定文件指定自定义架构。

  1. 点击状态栏中的架构切换器。

    为文件选择架构
  2. 在打开的列表中,选择一个建议的架构,或点击 新建架构映射…。 这将打开 JSON 架构映射 设置,您可以在其中为您的文件指定本地或远程架构。

从架构获取属性

如果 PyCharm 检测到您的 YAML 文件的架构,您可以使用专用操作将其所有属性快速插入该文件,从而无需手动输入。

  • 如果架构包含必需的属性,并且您只想插入这些特定属性,请在文件中的任意位置按 Alt+Enter显示上下文操作 ),然后选择 添加缺失的属性

  • 如果您想插入架构中可用的所有属性,请在文件中的任意位置按 Alt+Enter显示上下文操作 ),然后选择 从 JSON 架构填充所有属性

使用 $schema 关键字

您还可以在文件中直接引用架构。

  1. 在文件顶部输入 # $schema:

  2. 开始键入架构文件的名称。 您将获得从 schemastore.org 加载的架构名称的补全。

    如果您想使用本地架构文件,请指定相对于要使用该架构的文件的路径,例如 # $schema: ./my-schema.json。 这样将启用与使用远程架构时相同的代码辅助功能,包括检查、补全和属性填充操作。

    来自本地架构的补全

复制键

PyCharm 提供复制 YAML 文件中某个特定选项完整路径的功能。 您可以通过两种方式执行此操作:

  • 将插入符号置于所需键上并按 Ctrl+Alt+Shift+C

  • 将鼠标悬停在所需键上,右键点击它并选择 复制引用(Y)

YAML:复制引用

例如,在上图中,将复制 default.server.port

最后修改日期: 2025年 12月 2日