记录类属性

Question

下面的示例取自“潜入python”一书。

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

此示例显示记录MP3FileInfo，但是如何向MP3FileInfo添加帮助。 tagDataMap地图

Answer 1

将其更改为属性方法。

Answer 2

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

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 = ...