Python - ドキュメント(ドキュメンテーション文字列を参照する方法(__doc__属性))

初めてのPython 第3版
Mark Lutz (著)

開発環境

• OS X Lion - Apple(OS)
• TextWrangler(Text Editor) (BBEditの無料機能制限版、light版)
• Script言語: Python

『初めてのPython 第3版』(Mark Lutz 著、夏目 大 訳、オライリー・ジャパン、2009年、ISBN978-4-87311-393-7) のIII部(ステートメント)14章(Pythonのドキュメント)の練習問題1を解いてみる。

その他参考書籍

• Pythonチュートリアル 第2版
• Python クックブック 第2版

1.

ドキュメンテーション文字列を参照する方法としては、

1. __doc__属性にアクセスする
2. PyDocのhelpというビルトイン関すを利用する
3. PyDocのGUIインタフェースを使用する

という3つの方法がある。

コード(TextWrangler)

sample.py

#!/usr/bin/env python3.3
#-*- coding: utf-8 -*-

"""
Hello, World!を出力する単純なプログラム
"""
print("Hello, World!")

入出力結果(Terminal)

$ python
Python 3.3.0 (default, Sep 29 2012, 08:16:08) 
[GCC 4.2.1 Compatible Apple Clang 3.1 (tags/Apple/clang-318.0.58)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import sample
Hello, World!
>>> print(sample.__doc__)

Hello, World!を出力する単純なプログラム

>>> help(sample)
(ここから)
Help on module sample:

NAME
    sample - Hello, World!を出力する単純なプログラム

FILE
    /Users/kamimura/Documents/python/sample.py

(END) 
(ここまではqキーで終了)
>>> quit()

PyDocのGUIは私の環境(MacPortsでPython3.3をインストールした)では見つからなかったので省略。。