PyCharm 2024.1 Help

Inlay Hints

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 (Ctrl+Alt+S) , 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 category.

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

Parameter names

Show the names of parameters in function and method calls. These hints provide assistance with passing correct arguments to functions and methods.

Select or clear the checkboxes to enable or disable inlay hints in specific language and syntax contexts. Use the interactive preview to the right to check whether the result meets your expectation.

Inlay hints: parameter names

For a number of methods and functions, parameter names are not shown by default: such methods and functions are on the default Exclude List. To re-enable the excluded parameter name hints, or add more excluded methods or functions, click Exclude list and edit the list.

Settings | Inlay Hints

To disable parameter names hints for a method or a function, use one of the following patterns:

  • (*info, status)—all functions with two parameters, where the first parameter name ends with info, and the second one is status

  • (a, b)—all functions with parameters a and b

  • *.put(self, key, value)—all put methods with parameters key and value

  •, a, b)—method bar of class Foo with parameters a and b

  • foo(<star><star>kwargs)—function foo with parameter **kwargs

The names of placeholders must be provided for all parameters, including the optional ones. Qualified method names must include class names or placeholders for them. Use the Do not show hints for current method intention action Alt+Enter to add patterns from the editor.

Learn more from Parameter hints in JavaScript and Parameter hints in TypeScript.

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

Change inlay hints appearance

  1. In the Settings dialog (Ctrl+Alt+S) , 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.

Last modified: 26 May 2024