Как я могу документировать параметры типа в Python?

Question

Я бы хотел документировать, что T означает в этом классе

from typing import Generic, TypeVar

T = TypeVar('T')

class A(Generic[T]):
    pass

Я мог бы задокументировать T с помощью T.__doc__ = "Represents ...", но я мог бы захотеть использовать T в нескольких не связанных классах.

Есть ли какой-нибудь стандартный способ документировать это для данного класса / функции и т. Д.? В идеале, используя sphinx & reST.

Я думаю о том же уровне, что и у сфинкса :param:, но для типов, по типу scaladoc * @tparam

Answer 1

Вы можете задокументировать это через многострочную строку, как предложено следующим образом:

from typing import Generic, TypeVar

T = TypeVar('T')

class A(Generic[T]):
"""
Description of the class and his input T

Inputs:
    T : what is T? the type of T

Returns:
    res 

"""

И вы можете вызвать документацию как:

A.__doc__

или

help(A)