PyCharm 2020.2 Help

Code completion

This section covers various techniques of context-aware code completion that allow you to speed up your coding process.

Basic completion

Basic code completion helps you complete the names of classes, methods, and keywords within the visibility scope. When you invoke code completion, PyCharm analyses the context and suggests the choices that are reachable from the current caret position (suggestions also include Live templates).

If basic code completion is applied to a part of a field, parameter, or variable declaration, PyCharm suggests a list of possible names depending on the item type.

Invoking Basic code completion for the second time shows the names of classes, functions, modules, and variables.

Invoke basic completion

  1. Start typing a name.

  2. Press Ctrl+Space or choose Code | Code Completion | Basic from the main menu.

    The images below show basic code completion for the following cases:

    • Methods:

      Completing Method

    • Dictionaries:

      Completing Dicts

    • Django templates:

      Completing Filter

    • File paths completion in Python string literals:

      Path completion
      Path completion

  3. If necessary, press Ctrl+Space for the second time (or press Ctrl+Alt+Space).

    This shows the names of classes, functions, modules, and variables.

    Class name completion

Smart completion

Smart code completion filters the suggestions list and shows only the types applicable to the current context.

Invoke smart completion

  1. Start typing. By default, PyCharm displays the code completion popup automatically as you type. If automatic completion is disabled, press Ctrl+Shift+Space or choose Code | Code Completion | SmartType from the main menu.

  2. Press Ctrl+Shift+Space or choose Code | Code Completion | SmartType from the main menu.

    The most suitable suggestion for the current context is highlighted.

    Smart type completion
  3. If necessary, press Ctrl+Shift+Space once again.

Statement completion

You can create syntactically correct code constructs by using statement completionCtrl+Shift+Enter. It inserts the necessary syntax elements and gets you in a position where you can start typing the next statement.

Complete a method declaration

  • Start typing a method declaration and press Ctrl+Shift+Enter after the opening parenthesis.

    PyCharm automatically completes a method declaration with the mandatory parameter self. Start typing a method declaration in a Python class, and PyCharm will insert self after the opening bracket of the parameters list. This behavior is configurable in the Smart Keys page of the editor settings.

    Statement completion for a method

Complete a code construct

  • Start typing a code construct and press Ctrl+Shift+Enter.

    PyCharm automatically completes the construct and adds the required punctuation. The caret is placed at the next editing position.

    Completing code construct

Complete statements in collections

  • PyCharm automatically inserts a trailing comma before a line break in multiline collection literals. In dict literals, it inserts a colon between a key and a value. Press Ctrl+Shift+Enter to invode statement completion:

    Completing a current statement in collections

    Note that because of the language ambiguity regarding syntax of some incomplete collection literals, a colon is inserted neither after the first key of a dict literal nor after the first item of a parenthesized tuple.

Hippie completion

Hippie completion is a completion engine that analyses your text in the visible scope and generates suggestions from the current context. It helps you complete any word from any of the currently opened files.

Expand a string at caret to an existing word

  1. Type the initial string and do one of the following:

    • Press Alt+/ or choose Code | Code Completion | Cyclic Expand Word to search for matching words before the caret.

    • Press Alt+Shift+/ or choose Code | Code Completion | Cyclic Expand Word (Backward) to search for matching words after the caret and in other open files.

    The first suggested value appears, and the prototype is highlighted in the source code.

    Expand word
  2. Accept the suggestion, or hold the Alt key and keep pressing / until the desired word is found.

    Hippie completion

Postfix code completion

Postfix code completion helps you reduce backward caret jumps as you write code. You can transform an already-typed expression to a different one based on a postfix you type after the dot, the type of expression, and its context.

  • To view a full list of available postfix templates, in the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | General | Postfix Completion.

  • Select Tab, Space, or Enter to expand postfix templates.

Transform a statement with a postfix

  • Type an expression and then type a postfix after a dot, for example, .if:

    function m(arg) { arg.if }

    The initial expression gets wrapped with an if statement:

    function m(arg) { if (arg) { } }

To disable certain postfix completion templates, in the Settings/Preferences dialog Ctrl+Alt+S select Editor | General | Postfix Completion.

You can selectTab, Space, or Enter to expand postfix templates.

You can edit the predefined postfix templates, for example, to replace a long key with a shorter one, or to expand the list of applicable expression types.

F-string completion

Whenever you open a curly brace in an ordinary string literal, PyCharm provides the same completion suggestions as for an f-string. When you select one of the suggested options, the IDE automatically converts the literal into an f-string by adding a missing f prefix and a closing curly brace.

F-string completion

Configure code completion settings

To configure code completion options, In the Settings/Preferences dialog Ctrl+Alt+S go to Editor | General | Code Completion.

You can choose the following settings:

Item

Description

Match caseSelect if you want letter case to be taken into account for completion suggestions. Choose whether you want to match case for the first letter or for all letters.
Automatically insert single suggestions for Select if you want to automatically complete code if there's just one suggestion for basic and/or smart completion.
Sort suggestions alphabetically

Select if you want to sort items in the suggestions list in the alphabetical order instead of sorting them by relevance.

You can change this behavior at any time by clicking icons.actions.more.png in the suggestion list and toggling the Sort by Name option.

Show suggestions as you type Select if you want the suggestions list to be invoked automatically, without having to call completion explicitly. This option is enabled by default.
Insert selected suggestion by pressing space, dot, or other context-dependent keysSelect if you want to insert the selected suggestion by typing certain keys that depend on the language, your context, and so on.
Show the documentation popup in

Select to automatically show a popup for each item in the suggestions list with the documentation for the class, method, or field currently highlighted in the lookup list.

In the field to the right, specify the delay (in milliseconds), after which the popup should appear.

Completion tips and tricks

Narrow down the suggestions list

  • You can narrow down the suggestions list by typing any part of a word (even characters from somewhere in the middle) or invoking code completion after a dot separator . PyCharm will show suggestions that include the characters you've entered in any positions.

    This makes the use of wildcards unnecessary:

    codeCompletionWildcard.png

    In case of CamelCase or snake_case names, type the initial letters only. PyCharm automatically recognizes and matches the initial letters.

Accept a suggestion

You can accept a suggestion from the list in one of the following ways:

  • Press Enter or double-click a list item to insert it to the left of the caret.

  • Press Tab to replace the characters to the right from the caret.

  • Use Ctrl+Shift+Enter to make the current code construct syntactically correct (balance parentheses, add missing braces and semicolons, and so on).

You can also use specific keys to insert the selected completion suggestion: in the Settings/Preferences dialog Ctrl+Alt+S choose Editor | General | Code Completion and select the Insert selected suggestion by pressing space, dot, or other context-dependent keys option. These keys depend on the language, your context, and so on.

View reference

  • You can use the Definitions by pressing Ctrl+Shift+I when you select an entry in the suggestions list:

    Quick definition
  • You can use the Quick Information view by pressing Ctrl+Q when you select an entry in the suggestions list:

    Quick documentation

View code hierarchy

You can view code hierarchy when you've selected an entry from the suggestions list:

  • Ctrl+H - view type hierarchy

  • Ctrl+Shift+H - view method hierarchy.

Use machine-learning-assisted code completion

You can utilize machine learning models to rank most suitable items higher in the suggestions list.

To do this, in the Settings/Preferences dialog Ctrl+Alt+S go to Editor | General | Code Completion and enable the Rank completion suggestions based on Machine Learning option under Machine Learning-Assisted Completion.

    Troubleshooting

    If code completion doesn't work, this may be due to one of the following reasons:

    • The Power Save Mode is on (File | Power Save Mode). Turning it on minimizes power consumption of your laptop by eliminating the background operations, including error highlighting, on-the-fly inspections, and code completion.

    • Your file doesn't reside in a content root , so it doesn't get the required class definitions and resources needed for code completion.

      Refer to Configuring folders within a content root for more details.

    • A file containing classes and functions that you want to appear in completion suggestions list is marked as a plain text file.

    • External libraries that contain functions that you want to appear in the completion suggestions list are not added as dependencies or global libraries .

    Last modified: 23 July 2020