PyCharm 2021.1 Help

Auto import

When you reference a class that has not been imported, PyCharm helps you locate this file and add it to the list of imports. You can import a single class or an entire package, depending on your settings.

The import statement is added to the imports section, but the caret does not move from the current position, and your current editing session does not suspend. This feature is known as the Import Assistant.

The same possibility applies to XML files. When you type a tag with an unbound namespace, the import assistant suggests to create a namespace and offers a list of appropriate choices.

Creating imports on the fly

Import packages on-the-fly

  1. Start typing a name in the editor. If the name references a class that has not been imported, the following prompt appears:

    the Import popup

    The unresolved references will be underlined, and you will have to invoke intention action   Add import  explicitly.

  2. Press Alt+Enter. If there are multiple choices, select the desired import from the list.

    choose a class to import

You can define your preferred import style for Python code by using the following options available on the Auto Import page of the project settings (Settings/Preferences | Editor | General | Auto Import):

from <module> import <name>import <module>.<name>
the from <module> import <name> style
the import <module>.<name> style

Optimizing imports

Sooner or later, some of the imported classes or packages become redundant to the code. PyCharm provides the Optimize Imports feature, which enables you, whenever it is convenient, to remove unused imports from your current file, or from all files in the current directory at once. This helps you avoid unused, excessive and duplicating imports in your project. One can remove unused import statements in the entire project or in the current file only.

Besides cleaning the code from the unused imports, PyCharm formats the existing import statements according to the Style Guide for Python Code. In doing so, PyCharm splits import statements into separate lines, and sorts them into groups (refer to the Imports section for details).

Also, imports are sorted alphabetically and case-sensitively within the respective groups:

the Optimize imports intention action

You can modify the sorting policy in the Import tab of the Python code style settings (Settings/Preferences | Editor | Code Style | Python). See Python Code Style Settings for more information.

Optimize imports in the entire project

  1. Switch the focus to the Project tool window and do one of the following:

    • From the main menu, choose Code | Optimize Imports.

    • Press Ctrl+Alt+O.

    The Optimize Imports dialog opens.

  2. If your project is under version control, the option Only VCS changed files is enabled. Select or clear this option as required.

  3. Click Run.

One way of dealing with unused import is to use the quick-fix that appears when you set the caret at the highlighted unused import. However, you can optimize imports in a larger scope as described below.

Optimize imports in the current file

  1. From the main menu, choose Code | Optimize Imports.

  2. Press Ctrl+Alt+O.

  3. Place the caret at the import statements, click the Intention action button, and choose Remove unused import.

  4. Open the Reformat File dialog Ctrl+Alt+Shift+L and select the Optimize imports checkbox.

Toggling relative and absolute imports

PyCharm helps you organize relative and absolute imports within a source root. With the specific intention, you can convert absolute imports into relative and relative imports into absolute.

Converting an absolute import into relative

If your code contains any relative import statement, PyCharm will add relative imports when fixing the missing imports.

Fixing a missing import with the relative import statement

Note that relative imports work only within the current source root: you cannot relatively import a package from another source root.

The intentions prompting you to convert imports are enabled by default. To disable them, open project Settings/Preferences(Ctrl+Alt+S), select Editor | Intentions, and deselect the Convert absolute import to relative and Convert relative import to absolute.

Intentions for converting imports

Adding import statements on code completion

PyCharm automatically adds an import statement when you refer any module member or package in the Python code and invoke code completion. Auto-import on code completion is also applied to some popular package name aliases, such as np for numpy or pd for pandas.

Auto-import on code completion

PyCharm also adds import statements when you complete exported JavaScript or TypeScript symbols.

Add ES6 imports on code completion

Configure auto-import on completion

You can disable auto-import on completion and use quick-fixes instead:

Add ES6 imports on code completion

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | General | Auto Import.

  2. On the Auto Import page that opens, use the checkboxes in the TypeScript/JavaScript area to enable or disable import generation on code completion.

Ignoring missing import statements

If you use a module in your code that doesn't have any corresponding stub, PyCharm might show a missing statement error. To suppress this error message, use the # type: ignore comment:

Ignore a missing import statement
Last modified: 30 June 2021