Inlay Hints

Code vision

Code vision hints display 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.

• Inheritors shows the number of descendants of a class or an interface. Click the hint to jump to the descendants. If there are several implementations, select the relevant one from the list. Learn more from Go to implementation.

• Usages shows 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 Search for usages in a project.

  

• LSP Code Lens - shows code lens information from LSP servers.

• Python Web Structure - click this hint to invoke the Python Web Structure actions.

  

• Generate Documentation with AI - click this hint to invoke the Write Documentation AI action.

• Component usages are shown in Vue, Svelte, and Astro files. Click the hint to quickly look for usages of a specific component anywhere in the project.

• 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.

  

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 expectations.

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.

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

• Foo.bar(self, 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 the current method intention action Alt+Enter to add patterns from the editor.

Python parameter hints

Class constructor calls: shows parameter names for arguments when instantiating a class.

Non-literal arguments: shows parameter names for variable or expression arguments.

Pytest parametrize names

Shows parameter names when using @pytest.mark.parametrize decorator to clarify which value maps to each test parameter.

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

Types

Show the types of variables, fields, parameters, and function return types in the editor.

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 expectations.

Python type hints

'reveal_type' argument type: shows the inferred type of the expression passed to reveal_type().

Function return types: shows inferred or declared return types at function definitions.

Type parameter variance: shows inferred variance for type parameters - out (covariant) and in (contravariant).

Parameter type annotations: shows the inferred or declared types for function and method parameters.

Positional arguments in class patterns

Shows attribute names for positional patterns in structural pattern matching.

Learn more about Return types in JavaScript, Type hints in JavaScript, Return type hints in TypeScript, Type hints in TypeScript.

Values

By default, this checkbox is selected and PyCharm shows inferred values for numeric enums in the TypeScript context. Clear the checkbox to hide the inferred values and show only the values of explicitly initialized constants.

Method chains

Show the return type of each method in a method chain. Hints are only displayed when methods are called at separate lines.

Other

Python

Ruff error code names: shows error names and identifiers for Ruff linter diagnostics.

Dockerfile

Docker run named stage: shows an icon to quickly build or run a specific named stage in a Dockerfile.

Markdown

Table inlays: shows horizontal and vertical bars around the table. Provides column and row actions.

SQL

Join cardinality: shows the numerical relationship between rows of one table and rows in the other.

TOML

Ruff error code names: shows descriptions for Ruff error codes when configuring Ruff in TOML files.