PyCharm 2018.3 Help

Scopes

File | Settings | Appearance and Behavior | Scopes for Windows and Linux
PyCharm | Preferences | Appearance and Behavior | Scopes for macOS
Ctrl+Alt+S icons general settings svg


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

Item

Tooltip

Description

Add icon

Add scope
Insert

Click this button to add a new local or shared scope.

icons general remove svg

Delete
Delete

Click this button to delete the selected scope from the list.

icons actions copy svg

Copy configuration
Ctrl+D

Click this button to create a copy of the selected scope.

icons actions menu saveall svg

Save as

Click this button to have the selected local scope saved as shared or a selected shared scope as local.

icons actions up icons actions down

Move Up/Move Down

Use these buttons to move the scopes up and down in the list.

If some file is included into several scopes, the order of the scopes becomes important: PyCharm uses the color of the uppermost scope (shown in the Scopes settings page) to highlight such file. Of course, you can change the order of the scopes, and thus the resulted highlighting.

Scope configuration controls

Item

Description

Name

In this text box, specify the scope name.

Pattern

In this field, 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 file name or file extension.

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

For more information, see Scope Language Syntax Reference.

Do one of the following:

  • Type or edit the pattern manually in the text field Pattern.

  • Click icons general expandComponent svg, or press Ctrl+NumPad Plus to type or edit in the expanded area. (Click icons vcs restoreDefaultSize or press Ctrl+NumPad - to return to a single-line area.)

  • Choose the desired files in the Project Tree View and use the buttons described below to make PyCharm generate the corresponding pattern automatically.

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[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

Click this button to have the selected element included in the scope. The corresponding expression is automatically generated and added to the expression in the Pattern text box.

Include Recursively

Click this button to have the selected folder included in the scope, together with the nested subfolders. The corresponding expression is automatically generated and added to the expression in the Pattern text box.

Exclude

Click this button to have the selected element excluded from the scope. The corresponding expression is automatically added to the Pattern. If the current element is a folder, the nested subfolders are ignored.

Exclude Recursively

Click this button to have the selected folder excluded from the scope, together with the nested subfolders. The corresponding expression is automatically added to the Pattern field.

Scope toolbar

Item

Tooltip

Description

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 message on the toolbar shows the total number of available files and the number of files included in the scope. See also the color legend below. Use the toolbar buttons described below to change the view presentation.

Group by module

Show Modules

When the button is pressed, 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 files

Show Files

If this button is pressed, 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 button is not pressed, the files are hidden.

Show included only

Show Included Only

When the button is pressed, the tree shows only the elements that are included in the scope.

Legend of the project tree view

Item

Description

green square

Folders and files included in scope.

blue square

Folders that contain both excluded and included files and subfolders.

Last modified: 14 December 2018

See Also