コンテンツにスキップ

Pythonの標準クラスの見やすいドキュメント

[質問]

Pythonで、公式配布に含まれる既存クラスのプロパティやメソッドの一覧を見やすくまとめたドキュメントはありませんか。サードパーティが作るライブラリは、そういうドキュメントが完備していることが多いですが、公式の https://docs.python.org は、あまり見やすくありません。

[回答] Gemini

おっしゃる通り、Pythonの公式ドキュメントは「網羅性」と「正確性」には非常に優れていますが、サードパーティ製のライブラリ(PandasやScikit-learnなど)が提供する「APIリファレンス」のような一覧性には欠ける部分がありますよね。

公式が少し読みづらいと感じる場合に、「見やすさ・引きやすさ」に特化したリソースや方法をいくつかご紹介します。


1. 外部のおすすめリファレンスサイト

公式よりも構造化されており、メソッド一覧がパッと見でわかるサイトです。

DevDocs

個人的に最もおすすめです。左側にクラスや関数のサイドバーが常駐し、インクリメンタル検索(打ち込んだ瞬間に候補が出る)が可能です。

  • メリット: 動作が非常に軽く、複数のバージョンを切り替えて保持できます。オフラインでも動作します。
  • 見やすさ: 無駄な装飾がなく、メソッド一覧をスクロールで追うのに最適です。

Python Cheatsheet

クラス単体というよりは、主要な組み込み型(List, Dict, Stringなど)のメソッドを「やりたいこと別」にまとめたサイトです。

  • メリット: 「文字列を分割したい」「リストの末尾に追加したい」といった目的から逆引きできます。

2. 実行環境で「一覧」を生成する(コードで解決)

ドキュメントを探すよりも、Pythonの機能を使ってその場で「見やすいリスト」を作る方が早い場合もあります。

help() 関数と dir() 関数

対話モード(REPL)やJupyter Notebookで以下を叩くと、そのクラスが持っているものを確認できます。

# 文字列クラス(str)のメソッド一覧を表示
print(dir(str))

# より詳細な説明付きで表示
help(str)

pydoc をブラウザで起動する

実はPythonには、標準でローカルドキュメントサーバーを立てる機能があります。 ターミナルで以下のコマンドを打ってみてください。

python -m pydoc -p 8080

これを実行してブラウザで http://localhost:8080 を開くと、あなたのPCにインストールされている全モジュールのリファレンスを、公式とは少し違う構成(よりシンプルなリスト形式)で閲覧できます。


3. IDE(VS Code / PyCharm)の機能をフル活用する

ドキュメントサイトを見に行く手間を省くのが、現代的な「見やすさ」の解決策かもしれません。

  • アウトライン表示: VS Codeなら左側の「アウトライン」パネルを開くと、今開いているクラスやインポートしたクラスのメソッド一覧がツリー形式で表示されます。
  • ホバー表示: メソッド名にカーソルを合わせるだけで、型ヒントと説明がポップアップします。

結論:どれを使うべき?

目的 推奨ツール
素早く検索・一覧したい DevDocs
目的から逆引きしたい Python Cheatsheet
オフライン・手元で確認 pydoc サーバー

「公式ドキュメントのあの長いテキストを読み解くのが苦痛」という場合は、まず DevDocs をブックマークしておくのが一番の近道だと思います。

もし特定のモジュール(例:datetimepathlib など)について、「もっとこういう形式でまとまったものが欲しい」という具体的な希望があれば、それらをまとめた表を作成することも可能です。いかがいたしましょうか?