PyCharm 2025.3 Help

作用域和文件颜色

作用域 作用域图标 是 项目 中一组命名的文件和文件夹。 作用域可帮助您 在视觉上区分 不同 IDE 视图中的 项目 条目,并限制某些操作的范围。

作用域可让您按逻辑组织文件。 例如,您可以将测试源放入测试作用域,将生产代码保留在生产作用域中。 这使处理大型 项目 更加容易。 仅在测试上运行检查比在整个代码库上运行检查更快。

PyCharm 随附一组 预定义范围 ,但您也可以创建自定义的。 自定义作用域可以包含任意文件集,例如仅包含您负责的 项目 部分。

在 PyCharm 中,作用域用于代码检查、某些重构、搜索、版权设置以及各种代码分析功能等。

作用域共有 2 种类型: 本地共享

  • 本地作用域 存储在 IDE 配置目录 中,因此不会通过 VCS 共享,团队的其他成员也无法使用。

  • 共享作用域 会添加到 VCS 中,这样参与同一 项目 的人员即可使用相同的作用域。 这些作用域与 项目 一起存储在 .idea 下的 scopes 文件夹中。 每个作用域都会保存为扩展名为 .xml 的文件(例如: My项目/.idea/scopes/shared-scope.xml )。

如果您的 项目 受 版本控制 ,使用共享作用域更有意义。 如果您未使用 VCS,本地作用域足以满足您的需求。

定义新作用域

在 PyCharm 中,有一组 预定义作用域 ,但您也可以定义自己的作用域。

  1. Ctrl+Alt+S 打开设置,然后选择 外观与行为 | 作用域

  2. 点击 添加作用域 按钮(添加作用域按钮 ),然后选择要定义的作用域类型: 本地共享

    稍后可通过 通过VCS 共享 复选框更改所选作用域的状态(本地或共享)。

  3. 在打开的对话框中,为新作用域命名并点击 确定

  4. 向新作用域添加文件。 在 项目 树中选择所需条目,然后点击树右侧的以下任一选项:

    • 包含 :包含所选条目。 如果您包含的是文件夹,此操作仅添加该文件夹内的文件。 所有嵌套的子文件夹及其内容都不会被包含。

    • 递归包含 :包含所选文件夹以及其中的嵌套子文件夹及其内容。

    • 排除 :将所选条目从作用域中排除。 如果您排除的是文件夹,此操作仅移除该文件夹内的文件。 所有嵌套的子文件夹及其内容将保留在作用域中。

    • 递归排除 :将所选文件夹连同嵌套的子文件夹及其内容一并排除。

    添加了文件和文件夹的新作用域

    当您向作用域添加文件时,PyCharm 会创建一个表达式并将其显示在 模式(P) 字段中。

    除了使用按钮之外,您还可以参照 作用域语言语法 ,在 模式(P) 字段中手动输入模式。

  5. 应用更改并关闭对话框。

为所选作用域显示的文件和文件夹会以不同颜色显示,以帮助您了解哪些已包含、哪些未包含:

  • 绿色示例颜色 作用域中包含的文件和文件夹。

  • 深蓝色示例颜色 同时包含已排除和已包含的文件与文件夹的文件夹。

  • 黑色示例颜色 从所选作用域中排除的文件和文件夹。

创建自定义作用域后,您可以在 项目 工具窗口以及 所有对话框 中找到它,这些对话框允许您限定要应用某个操作的文件范围。

预定义的作用域

PyCharm 提供一组预定义的作用域。 IDE 会根据有关文件的信息自动将其添加到这些作用域中。 请注意,无法修改这些作用域。

预定义作用域列表

  • 项目文件 :包含 项目 内容根内的所有文件。 有关详细信息,请参阅 内容根。 库和 SDK 不包含在此作用域中。

  • 问题 :包含 项目 内容根内存在语法错误的文件。

  • 打开文件 :包含当前打开的所有文件。

  • 所有更改的文件 :包含所有最近更改的文件。

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

  • 最近查看的文件最近更改的文件 :包含您在编辑器中打开或修改的最近 50 个文件。 要更改最近文件的数量,请按 Ctrl+Alt+S 打开设置并选择 高级设置 ,搜索 最近文件的最大数量 字段,然后指定首选数量。

  • 项目和库 :包含 项目 内容根内的所有文件以及所有模块依赖项(库和 SDK)。

  • 由 Git 跟踪的项目文件 :包含 项目 内容根内受 Git 版本控制的所有文件。

  • 排除被 Git 忽略的项目文件 :包含 项目 内容根内的所有文件,包括受 Git 版本控制和未受版本控制的文件,但不包括 .gitignore 中指定的文件。

  • 项目生产文件 :包含 项目 内容根内除测试源根之外的所有文件。 在 项目 工具窗口 Alt+1 中,此作用域对应于 生产 视图。

  • 测试 :此作用域仅限于 项目 的测试源根。

  • 非项目文件 :此作用域仅在 项目 工具窗口中以视图形式提供。 其中包括库和 SDK。

  • 当前文件 :对应于编辑器中当前活动的文件。

  • 所选文件 :包含在某个工具窗口中所选文件(例如在 项目 工具窗口 Alt+1 中)。

  • 类层次结构 :包含与所选类相互关联的类。 选择此作用域后,系统会提示您选择层次结构的基类。

  • 本地更改 (仅在启用 VCS 集成 时显示这些作用域)

    • 所有更改的文件 :包含所有更改列表中尚未添加到 VCS 的已修改文件。

    • 默认更改列表 :包含来自 默认 更改列表且尚未添加到 VCS 的已修改文件。

    • '变更列表名称' :包含来自特定自定义更改列表且尚未添加到 VCS 的已修改文件。

  • 数据源

    • 上下文数据源 :包含您此刻正在使用的数据源。 可以通过您正在使用的控制台或数据编辑器定义上下文,或在数据库资源管理器中进行选择。

    • 已连接的数据源 :包含具有活动连接的数据源。

    • 已缓存的数据源 :包含 PyCharm 先前访问并缓存的数据源。

    • 所有数据源 :包含所有已添加的数据源。

将作用域与颜色关联

属于不同作用域的文件可以在搜索结果、编辑器选项卡以及 项目 工具窗口 Alt+1 中以不同颜色高亮显示。

在编辑器选项卡和搜索结果中的作用域高亮显示

您可以为每个作用域分配其独有的颜色。 例如,您可以为 打开文件 作用域分配一种颜色,并将 IDE 配置为在 项目 工具窗口中显示该颜色。 在这种情况下,您当前在编辑器中使用的文件将在项目树中着色显示。 这会使 项目 导航更快、更简单。 请注意,文件颜色仅在与作用域关联时才能使用。

与作用域类似,颜色关联可以是 本地共享

  • 本地颜色 仅对您可见,且不会通过 VCS 共享。

  • 共享颜色 会添加到 VCS 中,这样参与同一 项目 的人员即可使用相同的颜色关联。 它们存储在 项目 文件夹下的 .idea 中的 fileColors.xml 文件(例如: My项目/.idea/fileColors.xml )。

创建新的颜色关联

  1. Ctrl+Alt+S 打开设置,然后选择 外观与行为 | 文件颜色

  2. 请确保已选中 启用文件颜色(F) 复选框,然后选择您希望使用颜色的位置:选择 在编辑器标签页中使用(T)在项目视图中使用(P)

    为该作用域配置颜色

    如果您选择 在项目视图中使用(P) 复选框,您将在 项目 工具窗口 Alt+1 和搜索结果中看到颜色(例如,在 在文件中查找 对话框 Ctrl+Shift+F 中)。

  3. 点击 添加 按钮(添加图标 ),然后选择要为其配置颜色的作用域。

    您可以选择预定义作用域之一,或使用 自定义作用域

  4. 点击所需作用域旁边的箭头 右箭头图标 ,然后在打开的列表中选择一种颜色。

    要配置自定义颜色,请点击 自定义

  5. 要编辑颜色,请点击 颜色 列中与所需作用域对应的单元格,并在列表中选择新的颜色。

  6. 要通过 VCS 共享 颜色,请在 通过VCS 共享 列的相应行中选中该复选框。 如果清除了该复选框,则该颜色将在 本地 使用。

  7. 应用更改并关闭对话框。

如果某个文件包含在多个作用域中,作用域的顺序就变得很重要:PyCharm 会从上到下处理作用域,并从本地作用域开始。 这意味着 IDE 会将列表中最后一个作用域的颜色应用于此类文件。

如果您希望 PyCharm 以不同的顺序处理颜色关联,可以更改作用域的顺序。

更改作用域的顺序

  1. Ctrl+Alt+S 打开设置,然后选择 外观与行为 | 作用域

  2. 选择要移动的作用域,然后点击 上移上移按钮 )或 下移下移按钮 )按钮。 或者,按 Alt+UpAlt+Down

  3. 应用更改并关闭对话框。

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