python - ドキュメンテーション クラス属性

Question

次のサンプルは、「Dive into python」本からの引用です。

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

このサンプルは MP3FileInfo の文書化を示していますが、MP3FileInfo にヘルプを追加するにはどうすればよいですか。タグデータマップ

Answer 1

属性 docstringの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.

        """
        ...

ただし、属性の説明が 1 行しかない場合は、別個の docstring を作成しないでください。代わりに、

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

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

    """

    tagDataMap = ...