Pythonでpydocモジュールを使用したドキュメントの生成

pydoc moduleは、Pythonモジュールからドキュメントを自動的に生成します。ドキュメントは、コンソールにテキストのページとして保存したり、Webブラウザに表示したり、HTMLファイルとして表示したりすることができます。

この記事では、さまざまなケースでこれらのドキュメントを表示する方法を学び、Pythonスクリプト用の独自のドキュメントを作成するのに役立つdocstringについても学びます。

pydocの使用法がわかったので、始めましょう。

はじめに

pydocモジュールはPythonと一緒にパッケージ化されているため、個別にダウンロードしてインストールする必要はありません。

pydocにアクセスするには、最初にそれをインポートする必要があります。

import pydoc

help（）関数を使用したインタラクティブシェルへのアクセス

ヘルプ機能を使用して、pydocのインタラクティブシェルにアクセスできます。

これを行うには、ターミナルを起動し、Pythonインタラクティブシェルに入ります。

次に、pydocをインポートし、pydoc.help（）コマンドを使用してインタラクティブシェルを起動します。

例

>>>import pydoc
>>>pydoc.help()

これで、モジュールの名前、データ型、関数、クラスなどを入力して、インタラクティブスクリプトから直接ドキュメントを取得できます。

ブラウザからドキュメントを表示する

ブラウザからドキュメントを表示したい場合は、pydocを使用して簡単に表示できます。

今回は、Pythonシェルを介してコマンドを実行する必要はありません。むしろ、引数を指定して直接起動することができます。

これを行うには、ターミナルを起動して、以下のコマンドを入力します。

python −m pydoc −b

これにより、ブラウザのローカルシステムに存在するすべてのPythonモジュール、関数、オブジェクトのドキュメントが生成されます。

この方法で特定のキーワードを検索して取得することもできます。

C:\Users\vijay>python −m pydoc −b
Server ready at https://localhost:50621/
Server commands: [b]rowser, [q]uit
server> q
Server stopped

docstringの操作

def documentation():
   '''Documentation using docstrings'''
print(documentation.__doc__)
help(documentation)

Documentation using docstrings
Help on function documentation in module __main__:

documentation()
Documentation using docstrings