PyCharm 2020.2 Help

Scopes

File | Settings | Appearance and Behavior | Scopes for Windows and Linux

PyCharm | Preferences | Appearance and Behavior | Scopes for macOS Ctrl+Alt+S the Settings/Preferences icon

A scope is a set of files to which various operations apply. Using this dialog, you can define scopes for the various PyCharm actions, for example, Find Usages or Code Inspections.

Main toolbar

ItemTooltipDescription
the Add button

Add scope

Alt+Insert
Add a new local or shared scope.
the Remove button

Delete

Alt+Delete
Delete the selected scope from the list.
the Copy configuration button

Copy configuration

Ctrl+D
Create a copy of the selected scope.
the Save as buttonSave asSave the selected local scope as shared or the selected shared scope as local.
the Move up button  the Move down buttonMove Up / Move DownMove the scopes up and down in the list.

Scope configuration controls

ItemDescription
NameSpecify the scope name.
Pattern

Specify the pattern that defines the current scope. The following elements and structures can be used:

  1. The file: modifier. The element is mandatory.

  2. The * asterisk to denote any symbol in a filename or file extension.

  3. Logical operators AND (&&), OR (||), and NOT (!).

For more information, see Scope language syntax reference.

Storing empty or incorrect patterns is not allowed. In such cases, PyCharm shows a Syntax Error warning.

Examples

  • file:*.js||file:*.coffee - include all JavaScript and CoffeeScript files.

  • file:*js&&!file:*.min.* - include all JavaScript files except those that were generated through minification, which is indicated by the min extension.

  • !file:*/.npm//* - exclude all .npm folders.

  • file[Scientific_Sample]:*.py - include all Python files from the project Scientific_Sample. Specifying the project name in the brackets is particularly helpful when you have several projects attached to the current one.

    Example of a scope created for two attached projects

Include Included the selected item. If the current item is a folder, the nested subfolders are ignored.
Include RecursivelyInclude the selected folder and all nested subfolders with their contents.
ExcludeExclude the selected item. If the current item is a folder, the nested subfolders remain in the scope.
Exclude RecursivelyExclude the selected folder and all nested subfolders with their contents.

Scope toolbar

ItemTooltipDescription
Project tree view

The tree view contains all the files available in your project. In the view, select the desired files to be included in the current scope and have the scope definition pattern generated automatically.

the Show Modules buttonShow ModulesWhen this option is enabled, items in the tree-view are shown below the corresponding module nodes. Otherwise, the project items are shown below the corresponding package (like a source path with packages).
Show filesShow Files

When this option is enabled, source files are displayed explicitly in the tree view. When the files are shown, they can be selected for exclusion/inclusion into a pattern.

If this option is not disabled, all files are hidden from the tree.

Show included onlyShow Included OnlyWhen this option is enabled, the tree shows only the elements that are included in the scope.

Legend of the project tree view

ItemDescription
the green color sampleFolders and files included in a scope are marked with green.
the dark blue color sampleFolders that contain both excluded and included files and subfolders are marked with dark blue.
Last modified: 19 August 2020