未知 class 属性的文档字符串样式？

Question

我有一个 class 将解析数据库并创建 n 个属性，其中每个属性都是数据库中数据的 NumPy 数组，该属性的名称是变量数据库中的名称。 class 有一个参数 (srqs)，它是一个字符串列表，其中每个字符串都是要从数据库中提取的变量名。

我应该如何做我的文档字符串来表示 srqs 中的有效变量名称将成为 class 实例的属性？

class DataBase(object):
    """Creates an instance of the database and the requested srqs
    Attributes:
        dbname (str): Database filename to use.
        ???
    """

    def __init__(self, dbname=None, srqs=None):
        self.dbname = dbname
        self.extract_data()

    def extract_data(self):
        with OpenDB(self.dbname) as db:
            for srq in srqs:
                db.__dict__[srq] = db.GetData(srq)

>>>foo = DataBase('/usr/bin/testdb.bar', ['s1', 's2', 'T'])
>>>foo.__dict__
{'dbname': '/usr/bin/testdb.bar', 's1': np.array([0,0,0]), ...}

Answer 1

这个怎么样（基本上就是你问题的最后一句，我觉得你说的很好）：

class DataBase(object):
    """Creates an instance of the database and the requested srqs
    Attributes:
        dbname (str): Database filename in use.
    """

    def __init__(self, dbname=None, srqs=None):
        """
            Arguments:
            dbname (str): Database filename to use.
            srqs (sequence): Valid variable names in srqs will become attributes of an instance of the class
        """
        self.dbname = dbname
        self.extract_data()

未知 class 属性的文档字符串样式？

Docstring style for unknown class attribute?

python

docstring