PyCharm
 
2023.1
Shortcuts: Windows
Get PyCharm
You are viewing the documentation for an earlier version of PyCharm.
  1. Work with source code
  2. Code reference information
  3. Inlay Hints

Inlay Hints

Last modified: 08 June 2023

Inlay hints appear in the editor and provide you with additional information about your code to make it easier to read and navigate.

Inlay hints example

Enable or disable inlay hints

  • Open the Settings dialog (CtrlAlt0S), go to Editor | Inlay Hints, expand the groups of inlay hints, and clear the checkboxes next to the hints that you want to hide or show.

    Settings | Inlay Hints

  • In the editor, right-click a hint and select whether you want to disable the specific type of hints or all hints in this cagetogy.

Code vision

Code vision hints display in the editor the number of usages for a symbol, show who authored it, and mark symbols that are new or contain uncommitted changes.

When you hover over a hint, it turns into a link. By clicking the link you can navigate to usages or implementations of the class as well as open Version Control annotations.

  • Usages show how many times a class or a method is used in your project. Click the hint to jump to the usage or to select the relevant one from the list. Learn more from Finding usages of a symbol in a project.

    Inlay hints, code vision: jump to usages

    By default, the Usages hints are enabled. To disable them, clear the Usages checkbox in Settings | Editor | Inlay Hints | Code Vision.

    Alternatively, in the editor, hover over a hint and select Hide 'Code Vision: Usages' Inlay Hints or Hide All 'Code Vision' Inlay Hints from the context menu.

  • Code author shows the person who wrote/edited most code lines in a given code element. The hint also indicates if the element is new, modified in the current revision, or has several contributors who considerably committed to it. Click the hint to open the Git annotations in the gutter. Learn more from Locate code author.

    Inlay hints, code vision: code author

In inlay hints settings, you can configure which types of information you want to get in hints.

note

The list of available languages, contexts, and hint types depends on the installed/enabled plugins.

Change inlay hints appearance

  1. In the Settings dialog (CtrlAlt0S), go to Editor | Color Scheme | Language Defaults, then select Inline hints.

  2. Select the inlay hint type and state, and configure the font color and effects as required.