Legacy type syntax for docstrings

Specifying types of local variables

Consider adding information about the expected type of a local variable using :type or @type docstrings:

It is also possible to use isinstance to define the expected local variable type:

Specifying types of fields

You can use type hinting to specify the expected type of fields:

Alternatively, you can specify types of fields in the docstring of a class:

Specifying return types

Use docstrings :rtype or @rtype to specify the expected return type:

• :rtype: collections.Iterable[int] # return type: 'items' is of type generator or collections.Iterable, 'a' is of type int, see the following code:

  def my_iter():
      global i
      for i in range(10):
          yield i
      items = my_iter()
      for a in items:
          print a

• :rtype: list[int] for my_iter # return type: 'a' is of type int, see the following code:

  def my_iter():
      for i in range(10):
          yield i
      for a in my_iter():
          print a

Specifying parameter types

Consider adding information about the expected parameter type. This information is specified using docstrings. You can use different docstrings depending on the selected docstring format, for example, :type, @type, or Args. Use project settings to alter the docstring format (File | Settings/Preferences | Tools | Python Integrated Tools).