如何使用numpy文档字符串记录类实例的类型

时间:2019-08-31 03:46:29

标签: python numpy documentation docstring

我有一个要使用Numpy文档字符串格式记录的类。对于类的属性,我们必须给出属性的名称及其类型,例如:

my_attribute : str
   Description of the attribute goes here.

当属性是str,list,dict或int时,命名属性的类型没有问题,但是当文档的属性是类的实例时,我不知道用什么正确的方式命名它,例如:

my_attribute = SomeClass(param)

到目前为止,我一直在想的只是以这种方式在实例的起源处命名类:

class wtforms.fields.PasswordField

这是我要记录的代码。这是在flask应用程序中使用的Web表单。

from flask_wtf import FlaskForm
from wtforms import PasswordField
from wtforms.validators import DataRequired


class RegistrationForm(FlaskForm):
    """The form used on the /register page.

    Attributes
    ----------
    pass_field : class wtforms.fields.PasswordField
        Form field accepting a string user input that will be used as a 
        password.
    """

    pass_field = PasswordField('Enter password...',
                                render_kw={'class': 'form-control'},
                                validators=[DataRequired()]
                                )

是正确的方法还是有更合适的方法?

0 个答案:

没有答案