IntelliJ IDEA 2020.1 Help

Use Docstrings to specify types

On this page:

Introduction

You debug your code permanently, and now in the course of debugging you can also collect type information and specify these types in docstrings.

IntelliJ IDEA provides an intention action that makes it possible to collect type information at runtime, and define type specifications.

However, it is quite possible to specify the types of parameters manually, without the debugger.

Parameter type specification

To specify the parameter types, follow these general steps

  1. Press Ctrl+Alt+S and go to Editor | General |Smart Keys.

    Select the Insert type placeholders checkbox in the Smart Keys page of the editor settings.

  2. Place the caret at the function name, and pressAlt+Enter.

  3. In the list of intention actions that opens, choose Insert documentation string stub. IntelliJ IDEA creates a documentation stub, according to the selected docstring format, with the type specification, collected during the debugger session.

Note that reStructuredText is used for all the subsequent examples, but it is possible to use any of the supported formats of the documentation strings, whether it is plain text, Epytext, Google or NumPy. Refer to the description of the page Python Integrated Tools for details.

Last modified: 7 July 2020