PyCharm 2025.1 Help

新建监视器对话框

当您点击 添加   "添加"按钮编辑   “编辑”按钮 按钮时,该对话框将在 文件监视器页面 中打开。 使用该对话框基于预定义的 PyCharm File Watcher 模板创建一个项目 File Watcher 或编辑一个现有的项目 File Watcher。

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

名称

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

要观察的文件

文件类型

请使用此列表指定预期的输入文件类型。 文件监视器将只考虑这种类型的文件作为分析和处理的对象。 文件类型是根据 文件类型和文件扩展名之间的关联来识别的。

范围

使用此列表定义可以应用 File Watcher 的文件范围。

这些文件的更改将立即或在保存或窗口失去焦点时引发 File Watcher,这取决于 自动保存编辑的文件以触发观察程序 复选框的状态。

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

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

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

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

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

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

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

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

VCS 范围: 这些范围仅在您的 项目处于版本控制下时才可用。

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

  • 默认更改列表: 与变更列表相关的所有文件  Default.

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

仅跟踪根文件

根文件是指不包含在任何其他文件中的文件(例如通过 import ),并且 在指定范围内

  • 当选中此复选框时,File Watcher 仅针对 root files运行。

  • 当取消选中复选框时,File Watcher 将针对调用它的文件以及在指定范围内递归包含此文件的所有文件运行。

请注意, 范围 设置会覆盖 仅跟踪根文件 复选框设置:如果某个依赖超出了指定范围,文件监视器将不会应用于其。

例如 假设您有两个文件 root.scss another.scss ,其中 root.scss 导入了 another.scss 。 在选中 仅跟踪根文件 复选框的情况下,编辑 another.scss 只会调用 root.scss 上的File Watcher。 否则,如果选中框未选中,File Watcher 将处理这两个文件。

更改时运行的工具

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

程序

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

实参

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

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

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

要刷新的输出路径

在此字段中,告诉 PyCharm 应该在哪里搜索工具的输出:生成的源代码、源映射、依赖项或文件本身。 输出位置是特定于工具的。

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

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

工作目录和环境变量

工作目录

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

环境变量

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

高级选项

自动保存编辑的文件以触发观察程序

  • 选中此复选框后,PyCharm 会在您编辑文件时立即保存该文件,从而使 File Watcher 立即启动。

  • 清除复选框后,File Watcher 会在保存时启动(文件 | 全部保存 )或当您从 PyCharm 移开焦点(在窗口失去焦点时)。

进行外部更改时触发观察程序

  • 选中此复选框后,文件观察器会在文件范围内的任何更改时唤醒,包括在 PyCharm 外部进行的更改或在版本控制系统中检出分支后的更改。

  • 当复选框被清除时,File Watcher 只在其范围内的文件从 PyCharm 更新时启动,并忽略其他更改,例如从版本控制系统接收的更改。

触发监视器,即使存在语法错误

  • 选中复选框时,File Watcher 会在文件语法正确与否的情况下启动。 根据 自动保存编辑的文件以触发观察程序 复选框的状态,文件观察器将在更新、保存或撤销框架时启动。

  • 清除此复选框时,File Watcher 会忽略语法无效文件中的所有触发器,仅在无错误的文件中启动。

从 stdout 创建输出文件

  • 在大多数情况下,应该取消选中此复选框,因为大多数工具直接将输出写入相关文件。

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

显示控制台

从此列表中选择您希望 File Watcher 何时打开控制台。

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

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

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

输出过滤器

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

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

最后修改日期: 2025年 4月 23日