PyCharm 2017.2 Help

Configuring Ignored Files


Sometimes you may need to leave files of certain types unversioned. These can be VCS administration files, artifacts of utilities, backup copies, etc. You can create a global ignore list that will be stored in the workspace file and applied to all supported version control systems.

The files you want to ignore can be appointed explicitly by their names of through name patterns with wildcards. To ignore a directory, you need to specify the full path to it relative to the project root.

Use the Ignored Files settings page to list files that must be excluded from version control operations.

Note that once you've added a file to a version control system, ignoring it will have no effect. You need to remove it from your VCS first.

Defining a list of ignored files

  1. Open the Ignored Files settings page by doing one of the following: The Ignored Files dialog box opens.
  2. Click /help/img/idea/2017.2/new.png (Alt+Insert) to create a new entry, or select an existing entry and click /help/img/idea/2017.2/edit1.png (Enter). The Ignore Unversioned Files dialog box opens.
  3. Explicitly specify the files/directories to be ignored or define file name patterns. Do one of the following:
    • Choose the Ignore specified file option and specify the file name relative to the project root, for example, my_folder/my_subfolder1/my_subfolder2/my_file. Type the name manually or click the Browse button /help/img/idea/2017.2/browseButton.png and select the desired file in the Select File to Ignore dialog box.
    • Choose the Ignore all files under option and specify the directory whose contents should be ignored. Type the directory name relative to the project root, for example, my_folder/my_subfolder1/, or click Browse button /help/img/idea/2017.2/browseButton.png and select the desired folder in the Select Directory to Ignore dialog box.

      The rule is applied recursively to all subdirectories of the specified directory. If a directory has several subdirectories and you want only one of them ignored, specify the required directory explicitly, for example, my_folder/my_subfolder1/my_subfolder2/.

    • Select the Ignore all files matching option and type the pattern that defines the names of files to be ignored.

      Patterns that define files to ignore, make use of two wildcards.

  4. Create as many entries as you need and close the dialog box.

Two characters can be used as wildcards:

  • *: to replace any string.
  • ?: to replace a single character.

For example, *.iml will ignore all files with the iml extension; *.?ml will ignore all files whose extension ends with ml.

See Also

Last modified: 9 August 2017