Pythonは「書きやすさ」だけでなく「読みやすさ・美しさ」まで含めて価値がある言語です。
その根底にあるのが Zen of Python(PEP 20) と PEP 8(スタイルガイド)。
本ガイドでは、単なる試験合格ではなく Pythonエンジニアとして一生使える「お作法」 を体系的に学べるようにまとめました。
第1章:Pythonエンジニアに求められる「お作法」
- 1-1. コード規約とは何か?
- 1-2. お作法が開発チームにもたらすメリット
- 1-3. Python文化における「読みやすさ」の重視
- 1-4. Zen of Python と PEP 8 の位置づけ
- 1-5. 本ガイドの使い方(学習ロードマップ)
第2章:Zen of Python(PEP 20)の思想
- 2-1. Zen of Python とは?(import this の紹介)
- 2-2. 格言リストと全体像(19の原則)
- 2-3. 代表的な格言の解説と実例
- 美は醜に勝る
- 明示は暗黙に勝る
- 単純さは複雑さに勝る
- 特殊ケースもルールを破る理由にならない
- 2-4. Zenが実務で活きる場面(レビュー/設計判断)
- 2-5. Zenの限界と柔軟な適用
第3章:PEP 8 スタイルガイド入門
- 3-1. PEP 8 とは何か?
- 3-2. インデントと空白のルール
- 3-3. 命名規則(変数・関数・クラス・定数)
- 3-4. 行の長さと改行スタイル
- 3-5. コメントとDocstringの書き方
- 3-6. インポート文の並べ方と順序
- 3-7. 良い例/悪い例コードの比較
第4章:PEP 8 実践編
- 4-1. コードチェックツールの活用
- flake8 / pycodestyle
- 4-2. 自動整形ツールの活用
- black / isort
- 4-3. pyproject.toml でプロジェクト設定を統一
- 4-4. チーム開発でのスタイル統一の工夫
- 4-5. PEP 8 を守れない場面と例外対応
第5章:お作法が効く実例集
- 5-1. 関数設計:引数と戻り値の美学
- 5-2. クラス設計と一貫した命名
- 5-3. 例外処理の美しい書き方
- 5-4. テストコードにおけるスタイルの応用
- 5-5. ドメイン固有コードへの応用
第6章:アンチパターンと改善事例
- 6-1. ネストが深すぎるコードの改善
- 6-2. 意味不明な変数名を改善する
- 6-3. 空白や改行の乱れによる可読性低下
- 6-4. 複雑な条件式をシンプルにする
- 6-5. リファクタリングの基本プロセス
第7章:習慣化と継続の工夫
- 7-1. 毎日のお作法トレーニング(Zen 1日1つ)
- 7-2. 自動整形ツールを活用した習慣化
- 7-3. コードレビューでのチェックリスト活用
- 7-4. チームで文化を育てる工夫
- 7-5. 「試験合格」ではなく「自然に身につく学習」へ
付録
- A-1. Zen of Python 原文・日本語訳
- A-2. PEP 8 公式リソースリンク集
- A-3. お作法チェックツール早見表
- A-4. チェックリストPDF/Notionテンプレート
このTOPページの使い方
- 章ごとリンク:章の概要ページを用意し、そこから小見出しごとの詳細記事にリンク
- 学習者タイプ別導線:
- 初心者 → 第1章から順に通読
- 実務者 → 第3章・第4章だけ拾い読み
- 振り返り → 第6章アンチパターン、付録のチェックリスト