python 公式ドキュメントの読み方

公式ドキュメントの読み方を紹介します。
各章/節の概説をします。また、どのような場面で 各章/節 を見るとよいかについても記載します。
但し、全ての 章/節について記載するわけではありません。

公式ドキュメントは下記のことです。

3.10.0b2 Documentation

公式ドキュメント内では、BNF(*1)が使用されています。説明は下記をご確認ください。

1. はじめに — Python 3.10.0b2 ドキュメント

(*1)下記、BNFの一例です。

name ::= lc_letter (lc_letter | “_”)*
lc_letter ::= “a”…”z”

https://docs.python.org/ja/3/reference/introduction.html#notation、1.2. 本マニュアルにおける表記法

ドキュメント一覧

What’s new in Python 3.10?

バージョンの変更点がわかります。リリースノートです。

チュートリアル

pythonの基本的な概念、機能が説明されています。
各節では、多くのサンプルコードが使われており、基本的なコードを簡単に知ることができます。

公式ドキュメント以外のWebサイトでもpythonのコードが説明されていますが、そのコードが正しいかわからない場合があります。そのような場合、チュートリアルのコードを見ることで、正しいコードがわかります(公式ドキュメントのコードは正しいと考えている)。例えば、公式ドキュメントを見るとrange関数では、下記の書き方が可能であるとわかります。

range(5, 10)
5, 6, 7, 8, 9

range(0, 10, 3)
0, 3, 6, 9

range(-10, -100, -30)
-10, -40, -70

https://docs.python.org/ja/3/tutorial/controlflow.html#the-range-function,4.3. range() 関数

ライブラリーリファレンス

組み込み関数、組み込み型、組み込みモジュール等が説明されています。

組み込み関数、組み込み型、組み込みモジュール等 の詳細を確認したい場合に、ライブラリーリファレンスを見るとよいです。

組み込み関数

組み込み関数が一覧表示されており、関数名をクリックすることで説明を確認することができます。

https://docs.python.org/ja/3/library/functions.html、組み込み関数

組込み型

例えば、下記の型について説明されています。

  • 真理値判定
  • ブール演算 — andornot
  • 比較
  • 数値型 intfloatcomplex
  • イテレータ型
  • シーケンス型 — listtuplerange
  • テキストシーケンス型 — str
  • バイナリシーケンス型 — bytesbytearraymemoryview
  • set(集合)型 — setfrozenset
  • マッピング型 — dict
  • コンテキストマネージャ型
  • Type Annotation Types — Generic Alias, Union
  • その他の組み込み型
  • 特殊属性

組み込みモジュール

例えば、下記の組み込みモジュールについて説明されています。

  • テキスト処理サービス
    • string — 一般的な文字列操作
    • re — 正規表現操作
    • difflib — 差分の計算を助ける
    • textwrap — テキストの折り返しと詰め込み
    • unicodedata — Unicode データベース
    • stringprep — インターネットのための文字列調製
    • readline — GNU readline のインターフェース
    • rlcompleter — GNU readline向け補完関数
  • バイナリデータ処理
    • struct — バイト列をパックされたバイナリデータとして解釈する
    • codecs — codec レジストリと基底クラス

Python HOWTO

下記等のHOWTOが説明されています。

索引と表一覧

検索対象参照場面
モジュール総索引モジュールモジュール名が分かっている場合に、モジュールの仕様を知りたい時。
総合索引全般検索対象が公式ドキュメントのどこに記載されているか、見当がつかない時。
検索も同様の用途で使用出来ますが、部分一致で検索するため、場合によって(例えばinを検索する時)は検索結果が非常に多くなります(数千行)。そのため、検索の検索結果が多い場合は総合索引で調べた方がよいです。

索引にモジュールも書かれています。但し、項目が多いので、モジュールを調べる時は、モジュール総索引がよいです。
用語集全般調べたい用語がある時。
項目が少ない(約130[2021/12/29時点])ため、まずは、総合索引、検索を利用して調べた方が良いです。
検索 全般 調べたい用語がある時。 検索の検索結果が多い場合は総合索引で調べた方がよいです。
総合目次章/節
クラス
検索対象の章内の節を調べたい時。例えば、Python HOWTO章の節を知りたいときは、総合目次内で Python HOWTO で検索(*1)してください。

組み込みモジュールのクラスを調べたい時。 例えば、dequeクラス について知りたいときは、総合目次内で deque で検索(*1)してください。

(*1)ブラウザ(Chrome)上で、Ctrl+Fキーを押下して表示されるボックスを利用

コメント

タイトルとURLをコピーしました