[Python][お勉強] Python入門(23) - ドキュメンテーション文字列

今日もPythonのお勉強。

ドキュメンテーション文字列をやろうと思う。


ドキュメンテーション文字列とは
プログラム実行時にPythonインタプリターが内容を記録し、特定のオブジェクトに関連付けられる文字列。
関連づけられたオブジェクトの__doc__属性の値になる。

何がうれしいか
恐らくPyDocというツールで該当ドキュメントを読み出すことができたりすることがうれしいのかもしれない。

ドキュメンテーション文字列の書き方
とりあえずaaa.pyというファイルを作成する。
aaa.pyの先頭には、

"""
hello,hello,hello
aaaaaaaaaaaaaaaa
bbbbbbbbbbbbbbb
"""

なんていう文字列を書いておきます。
で、pythonからimportしてhelp関数を呼ぶ。

$ python
Python 2.4.4 (#2, Apr  5 2007, 20:11:18)
[GCC 4.1.2 20061115 (prerelease) (Debian 4.1.1-21)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import aaa
>>> help(aaa)


Help on module aaa:

NAME
   aaa

FILE
   /work/python/aaa.py

DESCRIPTION
   hello,hello,hello
   aaaaaaaaaaaaaaaa
   bbbbbbbbbbbbbbb

help関数を呼ぶと、aaa.pyの先頭に適当に書いた文字列がマニュアルのようにきれいにフォーマットされて出力されます。


さらに、aaa.pyに次のような感じでいろいろと付け加えてみます。

def bbb(x):
 """
 nanika no kansu desu.
 hee. iikoto kiita.
 """
 return x

class aaa_class:
 "class no documento de su."
 pass

print bbb(10)
print bbb.__doc__

でimportしてみる。

$ python
Python 2.4.4 (#2, Apr  5 2007, 20:11:18)
[GCC 4.1.2 20061115 (prerelease) (Debian 4.1.1-21)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import aaa
10

 nanika no kansu desu.
 hee. iikoto kiita.

>>>

__doc__属性の値が出力されました。
で、

>>> aaa.__doc__
'\nhello,hello,hello\naaaaaaaaaaaaaaaa\nbbbbbbbbbbbbbbb\n'
>>> aaa.aaa_class.__doc__
'class no documento de su.'
>>>

と、それぞれの__doc__属性も取得できる。




ごちそうさまでした。
.