PyCharm 2016.1 Help

Creating Imports

In this topic:

Overview

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 adds to the imports section, but the cursor does not move from the current position, and your current editing session does not interrupt. This feature is known as the Import Assistant.

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

Importing packages on the fly

To import packages on-the-fly, follow these steps:

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

    If the pop-up annoys you, change this behavior for the current file. Just click Hector hector.gif in the Status bar, and clear the check box Import Pop-up:

    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.
    python_import1. choose imported classes

Importing an XML Namespace

To import an XML namespace, follow these steps:

  1. Open the desired file for editing, and start typing a tag. If a namespace is not bound, the following prompt appears:
    unboundNameSpace1.png
  2. Press Alt+Enter. If there are multiple choices, select the desired namespace from the list.
    unboundNameSpace2.png

Importing TypeScript Symbols

In the TypeScript context, PyCharm can generate import statements for modules, classes, and any other symbol that can be exported and called as a type. Open the desired file in the editor and do one of the following:

  • Start typing the short name of a symbol. From the suggested variants for completion, select the relevant symbol name:
    ws_import_on_the_fly_1.png
  • Position the cursor at the unresolved symbol, which is displayed in red, and press Alt+Enter:
    ws_import_alt_enter_1.png
    On the context menu, select Add import statement and press Enter.
  • Configure PyCharm to show a pop-up every time you hover the mouse pointer over an unresolved reference which required import:
    1. Open the Settings / Preferences Dialog by choosing File | Settings for Windows and Linux or PyCharm | Preferences for OS X. Expand the Editor node, and then click Auto Import under General.
    2. On the Auto Import page that opens, select the Show import pop-up check box in the TypeScript area.
    Every time you hover the mouse pointer over an unresolved symbol, PyCharm will display the following pop-up message:
    ws_import_pop_up.png
    Press Alt+Enter to have an import statement generated and inserted automatically.

In either case, PyCharm inserts an import statement:

ws_import_on_the_fly_1.png

See Also

Last modified: 20 April 2016