PyCharm
 
2023.1
Shortcuts: Windows
Get PyCharm
You are viewing the documentation for an earlier version of PyCharm.
  1. Reference
  2. Settings
  3. Editor
  4. General
  5. Auto Import

Auto Import

Last modified: 02 March 2023

XML

Show auto-import tooltip

Automatically show an auto-import tooltip when typing the name of an unbound namespace. See importing unbound namespaces for details.

Python

Show import popup

Automatically display an import popup dialog when typing the name of a class that lacks an import statement.

Preferred import style

Select the style of import statement to be generated. The possible options are:

  • from <module> import <name>

  • import <module>.<name>

TypeScript/JavaScript

note

Auto-import works only for the ECMAScript 6 language level, see Choosing the JavaScript language version for details.

Add ES6 imports on code completion

  • If this checkbox is selected, PyCharm automatically inserts an import statement in JavaScript code when you complete a symbol exported using ES6 exports in another project file:

    https://resources.jetbrains.com/help/img/idea/2023.1/ws_es6_auto-import_1200.png
    Gif

  • When the checkbox is cleared, on pressing AltEnter PyCharm shows a popup that suggests to import the symbol:

    Add ES6 imports on code completion disabled

  • Completion and auto-import also work for React components, including stateless components. PyCharm properly detects them, provides code completion, and adds import statements automatically:

    https://resources.jetbrains.com/help/img/idea/2023.1/ws_import-react-stateless.png
    Gif

Add TypeScript imports automatically

Select this checkbox if you want PyCharm to generate import statements in TypeScript code. Use the checkboxes below to choose when import generation will be invoked.

  • On code completion If this checkbox is selected, PyCharm automatically inserts an import statement in TypeScript code when you complete a symbol exported in another project file.

  • With auto-import tooltip If this checkbox is selected, PyCharm shows a tooltip with an import suggestion when you position the caret at an unresolved symbol that can be imported. When the checkbox is cleared, you can invoke import generation only be pressing AltEnter.

  • Unambiguous imports on the fly With this checkbox selected, PyCharm adds import statements when you type your code or paste a fragment with a symbol that is not yet imported if there is only one source to import the symbol from.

When you are using ES6 modules in a browser that requires full file names, for example, in Chrome, it is important that the names of ES6 modules in import statements have the .js extensions.

  • To add the extension automatically in the JavaScript context, select the Use file extension checkbox on the Imports tab of the Code Style: JavaScript page.

  • To add the extension automatically in the TypeScript context, select the Use file extension checkbox on the Imports tab of the Code Style: TypeScript page.

Dart

tip

PyCharm shows this area only when the Dart repository plugin is installed and enabled on the Plugins page as described in Install plugins.

Update imports on paste

Select how PyCharm should process references to missing symbols in pasted blocks of Dart code:

  • All — PyCharm will insert import statements automatically for all missing symbols in pasted code.

  • Ask — you will be prompted to select the symbol to import.

  • None — PyCharm will not add any import statements automatically, you can invoke import generation by pressing AltEnter at the unresolved reference and choosing Import <symbol name> from the list.