PyCharm 2021.1 Help

Indexing

Indexing in PyCharm is responsible for the core features of the IDE: code completion, inspections, finding usages, navigation, syntax highlighting, and refactorings.

It starts when you open your project, switch between branches, after you load or unload plugins, and after large external file updates. For example, this can happen if multiple files in your project are created or generated after you build your project.

Indexing is in progress

Indexing examines the code of your project to create a virtual map of classes, methods, objects, and other code elements that make up your application. This is necessary to provide the coding assistance functionality, search, and navigation instantaneously. After indexing, the IDE is aware of your code. That is why, actions like finding usages or smart completion are performed immediately.

While indexing is in progress, the above-mentioned coding assistance features are unavailable or partially available. Nevertheless, you can still work with the IDE: you can type code, work with VCS features, configure settings, and perform other code unrelated actions.

The amount of time required for indexing vary depending on your project: the more complex your project is, the more files it comprises, the more time it takes to index it. You can decrease the indexing time by excluding files and folders and by unloading modules.

Note that if indexing is already in progress, you cannot speed it up. Wait for the process to finish and then you can temporarily simplify your project. The next time, indexing will finish sooner.

Exclude files and folders

Marking dynamically generated files as excluded can speed up the indexing and overall IDE performance. Excluded files remain a part of a project, but are ignored by code completion, navigation, indexing, and inspections.

To exclude a file, right-click it in the Project tool window and select Mark as Plain Text. Plain text files are marked with the the Plain Text icon icon.

To exclude a folder, right-click it in the Project tool window and select Mark Directory as | Excluded. Excluded folders are marked with the the Excluded root icon icon.

Last modified: 19 May 2021