Python
Pythonは書きやすい言語ですが、微妙に間違ったコードになりやすい言語でもあります。ここでは、静かに失敗する落とし穴と、壊れた環境を避けるためのプロジェクト設定について説明します。
静かに失敗する落とし穴
ミュータブルなデフォルト引数は、定義時に一度だけ評価され、すべての呼び出しで共有されます。
def add(item, bucket=[]): # 誤り:bucketは呼び出し間で維持される
def add(item, bucket=None): # 正しい
bucket = [] if bucket is None else bucket
クロージャは遅延バインディングされます。ループ内で作成されたラムダは、値ではなく変数をキャプチャするため、すべてのラムダが最終的な値を見ることになります。デフォルト引数を使って明示的にバインドするか、functools.partialを使用してください。
isは同一性であり、等価性ではありません。 None、True、Falseに対しては動作しますが、それ以外では使ってはいけません。小さな整数や短い文字列ではインターンされるため動作しているように見えますが、まさにそれがテストをすり抜けるバグの原因です。
コピーはシャローコピーです。list(xs)、xs[:]、dict(d)はコンテナをコピーしますが、要素は共有されます。ネストされた構造にはcopy.deepcopyが必要です。
裸のexcept:はすべてをキャッチします。KeyboardInterruptやSystemExitも含まれます。特定の例外をキャッチし、except Exception: passと決して書かないでください。本当に無視できる例外なら、ログに記録しその理由を説明しましょう。
整数の除算と浮動小数点の等価比較。 /は常に浮動小数点数を生成します。//は負の無限方向に切り捨てられるため、-7 // 2は-4になります。浮動小数点数の比較に==は使わず、math.isclose、または金額計算にはDecimalを使用してください。
コレクションを変更しながら反復処理すると、要素がスキップされます。新しいリストを作成するか、コピーに対して反復処理を行ってください。
ジェネレータは一度しか消費できません。 同じジェネレータを2回目のパスで処理すると何も生成されず、エラーではなく空の結果のように見えます。
環境とパッケージング
システムインタプリタにインストールしてはいけません。プロジェクトごとに仮想環境を作成して有効化するか、uvに管理させてください。
uv venv && uv pip install -e ".[dev]" # または: python -m venv .venv
依存関係はpyproject.tomlに宣言し、ロックファイルをコミットして環境が再現可能になるようにします。バージョンを固定していないrequirements.txtは再現可能ではなく、将来のマシンで壊れます。
プロジェクトがサポートするPythonバージョンを固定し、pyproject.tomlに明記してください。マイナーバージョン間での動作の違いは、思っている以上に大きいものです。
ある場所ではインポートできて別の場所ではできない場合、原因はほとんどの場合コードではなくインタプリタにあります。インポートをデバッグする前に、which pythonとpython -c "import sys; print(sys.executable)"を確認してください。
型
関数シグネチャ(パラメータと戻り値)にアノテーションを付けましょう。本体にはアノテーションはほとんど必要ありませんが、境界部分には常に必要です。なぜなら、それが他のコードが依存する部分だからです。
CIで型チェッカーを実行してください。検証されないアノテーションは古くなり、誤解を招くドキュメントになります。
慣習によるオプショナルではなく、X | Noneを使用し、オプショナルであることをシグネチャで可視化してください。Anyよりも具体的な型を優先し、型が本当に不明な場合は、unknownに相当するもの(object)を使用して絞り込みを行い、チェッカーが絞り込みを強制するようにします。
構造化データにはdataclassを、外部からデータが到着する境界では検証モデルを優先してください。関数間で文字列の辞書を受け渡すと、最初のタイポですべての保証が失われます。
重要なイディオム
マッピングやフィルタリングを行う場合は内包表記を、それ以外の場合はループを使用してください。副作用や3つの節を持つ内包表記は、置き換えられたループよりも読みにくくなります。
文字列パスではなくpathlib.Pathを使用し、閉じる必要があるもの(ファイル、接続、ロック、一時ディレクトリ)にはコンテキストマネージャを使用してください。
入力が大きい場合や無制限の場合は、リストを構築する代わりにジェネレータからyieldしてください。これが、ストリーミングするスクリプトとメモリを枯渇させるスクリプトの違いです。
インデックス演算やメンバーシップチェックの代わりに、enumerate、zip、デフォルト値付きのdict.getを使用してください。これらは高速で、オフバイワンエラーの一種を排除します。
テスト
pytestを、単純なassertとともに使用します。テーブル駆動型のテストケースには、1つのテスト内でループを回すのではなく@pytest.mark.parametrizeを使用し、各ケースが個別に報告されるようにします。
共有のセットアップは、動作する最も狭いスコープを持つフィクスチャに配置します。セッションスコープのフィクスチャがミュータブルな状態を保持すると、テスト間でリークが発生し、順序依存の障害を引き起こします。
特定の例外はpytest.raisesでアサートし、必要に応じてメッセージも含めてください。
パフォーマンス(重要な場合)
最適化の前に計測してください。おおまかな数値にはtime.perf_counter、処理の内訳にはcProfileを使用します。
典型的な勝利は、インタプリタから処理を移動することです。組み込み関数、内包表記、繰り返しの連結の代わりのstr.join、リストのスキャンの代わりのset/dictルックアップ、数値処理のためのベクトル化されたライブラリ呼び出しなどです。
I/Oバウンドな並行処理にはasyncioまたはスレッドを、CPUバウンドな処理にはプロセスを使用してください。グローバルインタプリタロック(GIL)により、スレッドはCPUバウンドな処理には役に立ちません。