記錄類屬性

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