Python モジュールのドキュメント文字列に、作成者、電子メール、バージョンなどのメタ情報を追加したいと考えています。それを行う標準的な方法はありますか?私はかなりの時間検索しましたが、ここでもウェブでも、明確な権限を持つものを見つけることができませんでした.
PEP 426 -- Metadata for Python Software Packages 2.0は、それについていくつか語っています。のように見え__author__
、他にも(V2.7)__version__
で認識されるものがあります。pydoc
また、 と がepydoc
ありsphinx-doc
ます。
そのような情報をdocstringに含める標準的な方法はありますか? それともグローバル変数として?もしそうなら、受け入れられたキーワード/変数名のリストはありますか?
例:
#########
# Parts
# <description>
#
"""Helper module for selling car parts on the web.
Author: Sue Baru
EMail: sb@carparts.com
Version: 1.0
"""
アップデート
これは実際には答えではありませんが、__author__
「キーワード」だけを使用することになりました。バージョニングは、git リポジトリーにチェックインすることによって行われます。