目次
-
はじめに
1.1 目的
1.2 対象読者
1.3 事前知識 -
リーダブルコードの原則
2.1 理解しやすいコードとは？
2.2 コードの読み手を考慮する
2.3 リーダブルコードの3つの原則 -
Pythonコードの基本構造
3.1 インデント
3.2 コードの構成
3.3 コメントの書き方 -
変数と関数の命名
4.1 名前の付け方
4.2 名前の長さと詳細度
4.3 一貫性のある命名規則 -
コードのリファクタリング
5.1 リファクタリングの目的とは？
5.2 リファクタリング手法
5.3 重複コードの排除
5.4 関数の分割
5.5 コードの整理と綺麗な構造 -
エラー処理と例外
6.1 例外処理の重要性
6.2 例外の基本構造
6.3 カスタム例外の作成 -
コードのテスト
7.1 テストの重要性
7.2 単体テストの基本
7.3 テストケースの作成 -
Pythonコードのドキュメンテーション
8.1 docstringの書き方
8.2 関数とクラスのコメント
8.3 コードの可読性向上のためのヒント -
リーダブルコードの実例
9.1 よくあるコードの問題点
9.2 改善例と解説
9.3 実践編: リーダブルコードへのリファクタリング -
まとめ
10.1 学んだことの振り返り
10.2 今後の学習へのアドバイス
10.3 Pythonプログラミングのお作法への取り組み
1.はじめに
1.1 この教材の目的
Pythonを使って、なんとなく動くものは作れるかもしれませんが、本職のプログラマーが守っているお作法を知り、自分自身をレベルアップさせることは、初心者のPythonプログラマーにとって重要なことです。
この記事では、本職のお作法について調べたことをまとめて、後日自分で振り返ることも含めて、初心者Pythonistのステップアップ教材を目指しています。
1.2 対象読者
この教材は、Pythonの基本的な文法を習得している初心者から中級者のプログラマーを対象としています。リーダブルなコードの書き方や、コード品質を向上させる方法を学びたい方に適しています。
また、既にPythonでコーディング経験がある方で、コードの可読性や保守性を向上させたいと考えている方にもおすすめです。
1.3 事前知識
この教材を理解するためには、以下の事前知識が必要です。
- Pythonの基本的な文法（変数、データ型、制御構造、関数、クラスなど）
- Pythonの標準ライブラリや主要なサードパーティライブラリの使用経験
- シンプルなPythonプログラムを作成できるレベル
事前知識が足りない場合は、Pythonの基本的な文法を学ぶ教材やチュートリアルを参照してください。