web-dev-qa-db-ja.com

Pythonでは、pydocは何をしますか？

プログラミングの新機能とpythonまとめて。私が学んでいる本の中で、著者はPydocの目的を見つけることを提案しました。

私はそれをグーグル検索して、（Gnomeターミナルから）一致を見つけましたが、私にはあまり意味がありませんでした。誰かが少し単純化することを気にしますか？ありがとう。

pythonterminalpydoc
12
logan beaupre

Pydocは、Pythonのヘルプ/ドキュメントモジュールです。

Windows端末でこれを使用して、pythonの関数が何をするかを理解します。

python -m pydoc <function>

例えば。

python -m pydoc raw_input

特定の関数のドキュメントが非常に長い場合は、「q」を使用してその関数から抜け出します。

例えばの場合には

python -m pydoc Tkinter
10
Kapil Marwaha

これはpythonスタイルのドキュメントを生成するツールです http://docs.python.org/2/library/pydoc.html を参照してください

Sphinxもご覧ください。

5
Eric B.

Pydocは、Python用のドキュメント生成システムです。たとえば、Pydoc標準を使用して関数を文書化し、それを使用してコード内に文書を生成できるとします。

2
pampasman

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

モジュール、クラス、関数、メソッドの場合、表示されるドキュメントは、オブジェクトのdocstring（つまりdoc属性）から派生し、再帰的にドキュメント化可能ですメンバー。 docstringがない場合、pydocは、ソースファイル内のクラス、関数、またはメソッドの定義のすぐ上、またはモジュールの上部にあるコメント行のブロックから説明を取得しようとします。

それぞれの詳細については、Pythonバージョン- Python 2.7 - Python 3.5 - Python 3.6

1
Anilkumar

PythonのPydocモジュールを使用して、HTMLページの形式で、またはコンソールでドキュメントを生成できます。

python -m pydoc

このコマンドは、ファイルのpydocを表示する、-kでさまざまなライブラリを検索する、-pでWebブラウザでページを開いて表示するpythonパッケージを表示する、-gでグラフィカルインターフェイスを提供するなどのオプションを提供します。ドキュメントを見ると、-wはhtml出力を書き込みます。以下は、テストのために起動できるサンプルコマンドです。

python -m pydoc yourpythonfile
python -m pydoc -k ftplib
python -m pydoc -p 314
python -m pydoc -w file

2行のサンプルファイルをディレクトリfile1.pyとfile2.pyに作成しました。このファイルには、1行のコメントが付いた単純なコードが含まれています。

def f2m(ft):
    """ Return the number of meters eq to feet """
    return 0.30 * ft

ファイルのコメントを確認する1つの方法は、同じファイルに以下のように書き込むだけです。python file.pyを実行すると、コメントが表示されます。

help(f2m)

これを確認する別の方法は、コマンドを記述することです

python -m pydoc file1

このコマンドを入力してhtmlにエクスポートすることにより、htmlページのコメントを表示するもう1つの方法

python -m pydoc -w <dir>

複数のpython=ファイルがあり、HTMLを別のフォルダに生成する場合は、単純なシェルコマンドで処理できます。以下のコードは、フォルダ「htmldocs」を生成し、htmlを生成してそれらをこの新しいフォルダです。右上隅にあるフォルダを開くと、他のページに移動できるインデックスオプションが表示されます。

mkdir -p htmldocs
pydoc -w `find . -name '*.py'`
mv *.html htmldocs
1
developer

ウィキペディアに提供された簡潔な説明：「Pydocにより、PythonプログラマーはPythonのドキュメントヘルプファイルにアクセスし、ドキュメントの詳細を含むテキストおよびHTMLページを生成し、特定のジョブに適切なモジュールを見つけることができます。」

0
Nigel

私自身Python学習者として、pydocを説明する最も簡単な方法は、それがさまざまなコマンドについて学習するために使用されるコマンドであるということです。構文は次のようになります。

> python -m pydoc 'function'

例：

> python -m pydoc open

モジュールで開いている組み込み関数のヘルプbuiltin：

open（...）open（name [、mode [、buffering]]）->ファイルオブジェクト

Open a file using the file() type, returns a file object.  This is the
preferred way to open a file.  See file.__doc__ for further information. <<<

お役に立てば幸いです。

0
Yoko Koko