Pythonのオフィシャルなドキュメント活用

はじめに

Pythonにはオフィシャルなドキュメントがあります。
Python 言語リファレンス — Python 3.13.2 ドキュメント
Python 標準ライブラリ — Python 3.13.2 ドキュメント

私、というよりこれまで書いた記事にも当てはまるのですが以下のような事柄について詳細な説明が記述されています。
・Pythonの文法
・Pythonのデータ型
・Pythonの組み込み関数
・Pythonの各データ型の関数

基本的には何かPythonの書き方で知りたいことがあれば言語リファレンスを、組み込み関数やデータ型の説明や関数を探したいなら標準ライブラリのドキュメントを参照すれば知ることができます。
このドキュメントの情報はいわゆる一次情報というもので詳細で最も信頼できる除法ソースになります。

知りたい情報の探し方

時間が許すなら先頭から順番に読んでいくだけでもそれなりに勉強になります。ただ、最初はどう読んだら良いのか困るし、先頭から読んでも全ての内容を理解して覚えることはきっと難しいだろうと思います。
そのため、目的に合ったドキュメントを都度読んでいくことから始めることをオススメします。
ただ、ドキュメントは目的ベースで書かれていないため、書きたい内容からその処理にあったドキュメントを見つけることは難しいです。
私の場合、以下の順番で検索することで知りたいドキュメントを見つけています。

1. 目的を達成できる組み込み型、関数または標準ライブラリを見つける
2. 見つけた組み込み型、関数、標準ライブラリの公式ドキュメントを見る

目的を達成できる組み込み型、関数または標準ライブラリを見つける

これは普通にGoogle検索するだけです。
例えば、リストを照準に並び替えたい時にpyhonでどのように処理を書けば良いのかわからないとします。この場合は「python list 並び替え」で検索します。
そうすると大抵はコピペブログみたいなものが引っかかります。コピペブログはSEO対策がきっちりしていて、目的に合った関数の使い方を説明してくれていることが多いです。その代わりに、情報が古かったり、内容が薄かったりします。
もし、目的が達成できるならここまでで構いません。

見つけた組み込み型、関数、ライブラリの公式ドキュメントを見る

先にGoogle検索をして、知った組み込み型、関数、標準ライブラリを知ることができたと思います。
もし、さらに詳細な情報を知りたい場合「python 〇〇 reference」と検索します。〇〇には調べた結果出てきた組み込み型や関数、ライブラリの名前を入れます。
先の例の場合、「python sorted reference」「python list sort reference」で検索することになります。
このように検索すると大抵はPythonの標準ドキュメントのページやライブラリをメンテナンスしている団体のページが検索結果の上位にきます。
一時情報だけあり、詳細な内容でほぼ誤った情報が記述されることはありません。
最新の情報はこのオフィシャルなドキュメントを読みましょう。

さいごに

Pythonのオフィシャルなドキュメントの存在と探し方について解説しました。
中には日本語で書かれていなかったり、日本語の文章が難しいドキュメントも少なくないため、読み慣れるまでが大変ではあります。
ただ、誤りが少なく、最新のバージョンにも対応しているのはこのオフィシャルなドキュメントです。組み込み関数の名前やデータ型の名前を覚えてくると、だんだんとドキュメントを探しやすくなります。そうなれば、一気に読むのが楽になって調べ物をする時間が減ります。自然と目的を達成するためのコードに集中しやすくなります。ぜひ、活用してみてください。

ケン

ヨワモンのパートナー

ヨワモンのパートナー