Pythonのドキュメントをローカルで高速に読むテクニックを知りたい

Question

Python（に限らず）言語やライブラリのドキュメントを読むときに、毎回インターネットから検索しているのが手間に感じます。
より高速にドキュメントを検索できるツールのようなものはないでしょうか？

Answer 1

英語でよければドキュメントを丸ごとダウンロードできます。

https://docs.python.jp/3.5/download.html

日本語版を手軽にダウンロードする方法は、見つかりませんでした。

たぶん翻訳チームに入ればTransifexから引っ張ってこれるんだと思いますが、さすがに邪道。

Comments

[hiroga]

なるほど。EPUB形式もあるんですね！これはありがたい。
ありがとうございます。

Answer 2

簡単な方法としてはPyCharmなどのIDEに頼るという方法もあります。
https://www.jetbrains.com/help/pycharm/viewing-inline-documentation.html

Answer 3

簡易的なものですが、IPythonを使えばメソッド等の後に?を付けることによってデータの型やDocstringを見ることができます。

$ ipython
Python 3.6.6 |Anaconda custom (64-bit)| (default, Jun 28 2018, 11:27:44) [MSC v.
1900 64 bit (AMD64)]
Type 'copyright', 'credits' or 'license' for more information
IPython 6.5.0 -- An enhanced Interactive Python. Type '?' for help.

In [1]: int
Out[1]: int

In [2]: int?
Init signature: int(self, /, *args, **kwargs)
Docstring:
int(x=0) -> integer
int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments
are given.  If x is a number, return x.__int__().  For floating point
numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string,
bytes, or bytearray instance representing an integer literal in the
given base.  The literal can be preceded by '+' or '-' and be surrounded
by whitespace.  The base defaults to 10.  Valid bases are 0 and 2-36.
Base 0 means to interpret the base from the string as an integer literal.
>>> int('0b100', base=0)
4
Type:           type

ご参考までに。

Answer 4

ちゃんと作っているPythonスクリプトであれば、ソースコード上にそのモジュールやメソッドの使い方などが載っていたりします。

とはいえ、実装の中身を見たいわけではないのでソースコードを開くのもちょっと面倒です。

Pythonの場合は、 pydoc というライブラリがついており、これを使って容易にライブラリのソースコードに記載されているドキュメントを見ることができます。

それでも情報が足りない場合は、やはりWebブラウザを経由して調べるしかないとは思いますが、その際もなるべく画像などを読み込まず、文字列だけに集中したいのであれば、CLIで動くブラウザ（ Lynx や　w3m など……）を使ってみるのも手かもしれません。

以上、参考になれば幸いです。

参考資料

• 27.2. pydoc --- ドキュメント生成とオンラインヘルプシステム — Python 3.7.0 ドキュメント
• Python pydocの使い方、書き方とhtml出力の方法 - Symfoware
• Linuxのコマンドライン(CUI)で使えるテキストベースWebブラウザを使い比べてみた | 俺的備忘録 〜なんかいろいろ〜

Answer 5

Pythonista。検索も早いし気になったら飛行機の中とかでもソースが追えるので重宝します。

Comments

[hiroga]

iPhoneアプリのですか？初めて知ってダウンロードしたんですが、これすごいですね。
ドキュメントじゃなくてソースなんですね。でも何かで使うと思います！ありがとうございます。