PyCharm 2025.3 Help

新建监视器对话框

当您在 文件监视器页面 上点击 添加   添加按钮编辑   编辑按钮 按钮时,将打开该对话框。 使用此对话框根据预定义的 PyCharm 文件监视器模板创建项目文件监视器,或编辑现有的项目文件监视器。

每个模板都包含针对所选工具优化的设置。 因此,在大多数情况下,您只需指定该工具可执行文件的路径。

名称

名称 字段中,输入文件监视器的名称。 默认情况下,PyCharm 会建议所选预定义模板的名称。

要监视的文件

文件类型

使用此列表指定输入文件的预期类型。 文件监视器仅将此类型的文件视为分析和处理的对象。 文件类型是基于 文件类型与文件扩展名之间的关联 来识别的。

范围

使用此列表定义文件监视器可应用到的文件范围。

这些文件的更改将根据 自动保存已编辑的文件以触发监视器 复选框的状态,立即触发文件监视器,或在保存或框架停用时触发。

从列表中选择一个预定义范围。 对于项目级文件监视器,您也可以点击 浏览按钮 ,在打开的 作用域 对话框中配置自定义范围。

  • 所有位置: 以下所有范围。

  • 项目文件: 项目内容根内的所有文件(请参阅 配置项目结构)。

  • 项目生产文件: 项目内容根内的所有文件(不包括测试源)。

  • 项目测试文件: 项目测试源根内的所有文件。

  • 临时文件和控制台: 位于 项目 工具窗口中的 临时文件和控制台 目录中的所有文件。

  • 打开的文件: 当前在编辑器中打开的所有文件。

  • 当前文件: 活动编辑器选项卡中打开的文件。

VCS 作用域: 仅当您的 项目受版本控制 时,这些范围才可用。

  • 所有已更改的文件: 所有已更改的文件,即与所有现有更改列表关联的所有文件。

  • 默认更改列表: 与更改列表  Default 关联的所有文件。

或者,点击 浏览按钮 ,在打开的 范围 对话框中配置 自定义范围

仅跟踪根文件

一个 根文件 是指未被包含到任何其他文件 在指定范围内 中的文件(例如通过 import)。

  • 选中此复选框时,文件监视器仅针对 根文件 运行。

  • 清除此复选框时,文件监视器将针对其被调用的文件,以及在指定范围内递归包含该文件的所有文件运行。

请注意, 作用域 设置会覆盖 仅跟踪根文件 复选框设置:如果某个依赖项位于指定范围之外,则不会对其应用文件监视器。

示例 假设您有两个文件 root.scss another.scss ,其中 root.scss 导入 another.scss 。 选中 仅跟踪根文件 复选框时,编辑 another.scss 将仅对 root.scss 调用文件监视器。 否则,如果清除此复选框,文件监视器会处理这两个文件。

在更改时运行的工具

在此区域配置与该工具的交互:指定要使用的可执行文件、传递给它的参数,以及 PyCharm 应在何处查找该工具的输出。

程序

在此字段中,指定该工具可执行文件的路径( .com .exe .cmd .bat ,或取决于具体工具的其他文件)。

参数

在此字段中,定义要传递给该工具的参数,从而影响其行为。

参数通常使用 指定,例如 $FileName$$FileNameWithoutExtension$ ,它们将被替换为实际的文件名。

手动输入宏,或点击 插入宏图标 ,并在打开的 对话框中的列表里选择相关模式。

要刷新输出路径

在此字段中,告诉 PyCharm 应在何处查找该工具的输出:生成的源代码、源映射、依赖项或文件本身。 输出的位置因工具而异。

输出路径通常使用 指定。 您可以手动输入,或点击 插入宏图标 ,然后在打开的对话框中的列表里选择相关项。

要指定多个宏,请使用冒号 : 作为分隔符,例如 $FileNameWithoutExtension$.css:$FileNameWithoutExtension$.css.map

工作目录与环境变量

工作目录

在此字段中,指定该工具将应用到的目录。 由于该工具始终在文件的上下文中调用,默认工作目录为当前文件所在的目录。 在所有预定义模板中,默认工作目录都通过 $FileDir$ 宏指定。 要指定自定义工作目录,请在字段中键入其路径,或点击 浏览图标 并在 选择路径 对话框中选择目录,或点击 插入宏图标 并在 对话框的列表中选择所需的

环境变量

在此字段中,指定该工具所需但未在操作系统级别指定的环境变量。

高级选项

自动保存已编辑的文件以触发监视器

  • 选中此复选框时,PyCharm 会在您编辑文件后立即保存该文件,从而立即唤醒文件监视器。

  • 清除此复选框时,文件监视器会在保存(文件 | 全部保存 )或您将焦点从 PyCharm 移开时(框架停用时)启动。

在外部更改时触发监视器

  • 选中此复选框时,文件监视器会在其范围内的文件发生任何更改时被唤醒,包括在 PyCharm 之外所做的更改,或您在版本控制系统中检出分支后的更改。

  • 清除此复选框时,文件监视器仅在其范围内的文件由 PyCharm 更新时启动,并会忽略其他更改,例如从版本控制系统接收的更改。

无论是否存在语法错误均触发监视器

  • 选中此复选框时,无论文件在语法上是否正确,文件监视器都会启动。 文件监视器将在更新、保存或框架停用时启动,具体取决于 自动保存已编辑的文件以触发监视器 复选框的状态。

  • 清除此复选框时,文件监视器将忽略语法无效文件中的所有触发器,只在无错误的文件中启动。

从 stdout 创建输出文件

  • 在大多数情况下,此复选框应清除,因为大多数工具会将其输出直接写入相应的文件。

  • 选中此复选框时,PyCharm 会读取原生工具的输出 standard output stream (stdout) ,并据此生成结果文件。 生成文件的名称取自 要刷新的输出路径 字段。 如果该字段包含多个名称,则使用列表中的第一个。

显示控制台

在此列表中,选择您希望文件监视器在何时打开控制台。

  • 始终: 使用此选项时,工具执行完成后始终打开控制台。

  • 出错时: 使用此选项时,仅当 Exit code0 不同时,工具执行后才会打开控制台。

  • 从不: 选择此选项可完全禁止打开控制台。

输出过滤器

在此字段中,指定与该工具关联的输出过滤器。 根据这些过滤器,将工具输出中的绝对文件路径和行号转换为超链接。 点击这些链接会在编辑器中打开相应文件。

例如,若要显示有用的错误消息,请输入 $FILE_PATH$:$LINE$ $MESSAGE$

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