python - 记录类属性

Question

以下示例取自“Dive into python”一书。

class MP3FileInfo(FileInfo):
    "store ID3v1.0 MP3 tags"
    tagDataMap = ...

此示例显示记录 MP3FileInfo，但如何向 MP3FileInfo 添加帮助。标记数据映射

Answer 1

属性文档字符串上的PEP 224被拒绝（很久以前），所以这对我来说也是一个问题，有时我不知道选择类属性或实例属性——第二个可以有一个文档字符串。

Answer 2

将其更改为属性方法。

Answer 3

像这样做：

class MP3FileInfo(FileInfo):
    """Store ID3v1.0 MP3 tags."""

    @property 
    def tagDataMap(self):
        """This function computes map of tags.

        The amount of work necessary to compute is quite large, therefore
        we memoize the result.

        """
        ...

请注意，如果属性只有一行描述，您真的不应该制作单独的文档字符串。相反，使用

class MP3FileInfo(FileInfo):
    """Store ID3v1.0 MP3 tags.

    Here are the attributes:
        tagDataMap -- contains a map of tags

    """

    tagDataMap = ...