Question

我想记录T在此类中的意思

from typing import Generic, TypeVar

T = TypeVar('T')

class A(Generic[T]):
    pass

我可以用T来记录T.__doc__ = "Represents ..."，但是我可能想在几个不相关的类中使用T。

对于给定的类/功能等，是否有任何标准的方法来对其进行记录？理想情况下使用狮身人面像和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)

如何在Python中记录类型参数？

1 个答案: