プログラミング学習の記録 782 14章(Pythonのドキュメント)の練習問題2(ドキュメンテーション文字列の参照方法)『初めてのPython 第3版』(Mark Lutz 著、夏目 大 訳、オライリー・ジャパン、2009年、ISBN978-4-87311-393-7)

開発環境

• OS X Lion - Apple(OS)
• TextWrangler(Text Editor) (いずれはBBEditを入手したい！)
• Script言語: Python

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

2.

ドキュメンテーション文字列を参照するには、

1. オブジェクトの__doc__属性を指定する。
2. PyDocのhelp関数を使用する、
3. PyDocのGUIインタフェースを利用する。

の3つの方法がある。

以下のコードとsysのドキュメンテーション文字列を上記の3つの方法で参照してみる。

コード(TextWrangler)

#!/usr/bin/env python #encoding: utf-8 "モジュール" # コメント1 print "Hello, World!" """ 複数行に渡る ドキュメンテーション文字列 """ #　コメント2

入出力結果(Terminal)

$ python Python 2.6.6 (r266:84374, Aug 31 2010, 11:00:51) [GCC 4.0.1 (Apple Inc. build 5493)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import python_program Hello, World! >>> python_program.__doc__ '\xe3\x83\xa2\xe3\x82\xb8\xe3\x83\xa5\xe3\x83\xbc\xe3\x83\xab' >>> print python_program.__doc__ モジュール >>> help(python_program) >>> import sys >>> print sys.__doc__ This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- pathname of this Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function >>> help(sys) >>> $

オブジェクトの__doc__属性をコマンドライン(Terminal)で出力する時は対話型コマンドラインの出力機能を使うのではなく、printステートメントによって出力するようにした方が良さそう。

PyDocのGUIバージョンを使う方法はどこにあるのか分からなかったのでとりあえず次に進むことに。GUIで調べるなら今ならブラウザでググればいいかも。