0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

最初にやっときゃ良かったPythonプロジェクトでのCLAUDE.md

0
Posted at

はじめに

システムプロンプトについての備忘録的な記事です。

失敗のAIコーディング

めんどくさがって、最初は何もシステムプロンプトを設定していませんでした。
ユーザプロンプトだけでも割とコーディングは進みます。修正を繰り返し、ふと気付きます。「コードをまともに読んでないな」と。
とりあえずめぼしいファイルを開いてみます。すると驚愕の光景が...

import os
from △△△ imort □□□

def hogehoge():
    from △△△ imort □□□
    処理
    
def hogefuga():
    import os
    from △△△ imort ✕✕✕
    処理
    
 def hogefuga():
    from △△△ imort ✕✕✕
    処理   

メゾットと毎にimport、重複importなんでもありの状態でした。。。
調べてみると、AIコーディングではよくありがち。とのこと。
対策はシステムプロンプト(またはLinter)ということでした。...最初からやっておけば!!

Python全般としての指示

では具体的なプロンプトです。(後ろに解説もつけてます)

### 0. 前提
- 合理的な範囲でKISS,DRY原則に従うこと。
### 1. Imports(最重要)
- すべてのimportはファイルの最上部(モジュールdocstringの直後)に書く。
- importの順序は必ず以下:
  1. Standard library(stdlib)
  2. Third-party packages(pipで入れるもの)
  3. Local modules(同じプロジェクト内の自作モジュール)
- 各グループの間は**空白行1行**で区切る(PEP 8準拠)。
- 関数内・メソッド内・if文内でのimport(local import)は**絶対に禁止**。
### 2. PEP 8 厳守
- 命名規則:変数・関数・メソッド → `snake_case`、クラス → `CamelCase`
### 3. Type Hints(必須)
- すべての関数・メソッドには型ヒントを必ず付ける(`def func(x: int) -> str:` の形式)
- Python 3.9以降のbuilt-in型(list, dictなど)はそのまま使用
- 必要に応じて `from typing import ...` をstdlib importに含める
### 4. Docstring(必須)
- モジュール、クラス、関数・メソッドには必ずGoogleスタイルのdocstringを書く
- 最低限含める項目:概要、Args、Returns、Raises(該当する場合)
- 1行docstringではなく、複数行で詳細に記述
- 適切な行コメントを記載すること。ただやっていることを書くのではなく、実装意図を中心にコメントを行うこと。わかりやすい部分はコメントしなくても良い。
### 5. Tests
- テストは正常系。異常系、境界ケースで適切に作成すること。
- 2ファイル以上で使うような共通モジュールはtests¥support¥配下に作成すること。
- 共通モジュールは適切に多すぎず少なすぎずファイル分割すること。
- 共通モジュールのファイル名はファイル名から内容を推測しやすいこと。
- 共通的な処理と考えられる場合はtests¥support¥配下のファイイル名を確認し、すでに共通モジュールがないか確認すること。
- pytest実行時は --disable-warnings -qを積極的に活用してください。
### 6. コーディング方針
- 既存テストを維持するための不合理なコード変更は行わないでください(ラッパー地獄など)。テストを含めたコード変更を厭わないでください。
- コーディングのための簡易的な調査や、試験、トライ、生成は`¥scripts`フォルダに配置、実行してください。
- 開発者向けメモを適宜docs/developer.mdに追記すること。
### 7. コマンド実行
- コマンド実行時は必要に応じて、先頭 N 行 ... | Select-Object -First Nや、末尾 N 行 ... | Select-Object -Last Nを指定してください。

解説

0. 前提
個人の好みですが、KISS,DRY派です。おまじない程度ですが、体感では結構効いてる気がします。

1. Imports
最も重要な指示です。このルールを指示しなかったのでdef内でimport、コード途中でimport、あらゆるところでimportして、とても大変なことになりました。(早く気づけばよかった)
これでも無視されることはあります。諦めましょう。
Linterなどでガードしたほうが良いのですが、構築が面倒なのでシステムプロンプトで対応です。

2. PEP 8 厳守、3. Type Hints、4. Docstring
SOTAモデルではルールにしなくても、そのようにコーディングしてくれる傾向がありますが、確実性はないので念のため記載しましょう。
こちらもLinterなどでガードしたほうが良いはず。

5. Tests
ここはお好みで編集しましょう。
「テストは正常系。異常系、境界ケースで適切に作成すること。」と書いていますが、ふわっとした指示なので良くないですね。軽いプロジェクトや個人のコーディングならこの程度でも大丈夫だと思います。
ここではコンテキスト消費を抑えるために--disable-warnings -qを積極的に使うよう指示しています。これはオススメです。

6. コーディング方針
既存のコードの互換を気にする傾向があります。リリース後であれば適切ですが、開発段階ではコードが汚れていくばかりです。
docs/developer.mdうんぬんは私の好みです。あとで俯瞰しやすいのでオススメではあります。

7. コマンド実行
コマンド実行でのコンテキスト消費を抑えるために、Head先頭◯行などの指定は有効です。
WindowsなのでPowershellの例です。

プロジェクトに対する指示

言語:Python
仮想環境:UV

- 〇〇の△△ツールです。□□ライブラリで動作します。
       ~
   色々なプロジェクトに対する説明と注意事項。(守ってほしいこと)
       ~
- 今回の修正に関わらない部分で改善が必要な部分があればユーザに通知してください。また、コード中のTODO:などで記載をしておいてください。
- 原則として旧互換やマイグレーションは不要です。ユーザから明確に依頼があった場合のみ行ってください。またプランには〇〇の互換は行わないなどユーザが判断しやすいように明記してください。
- uv runで実行が可能です。例:uv run pytest △△△/tests/test_????.py -s --disable-warnings -q

解説

  • 簡単なプロジェクト解説は行ったほうが良いです。体感そのほうが取っ掛かりがスムーズです
  • チャットで修正点を教えてくれることもありますが、自分はスルーしてしまうことが多いので、とりあえずコード中にTODO書いとけと指示してます
  • 環境を明記しておかないと、AIはコマンドを試行錯誤します。コンテキストリセットごとに忘れるのでコマンド実行例は記載して損はないです

おわりに

システムプロンプトは強力な機能ですが、あまりにボリュームが多いと、コンテキストの圧迫や指示内容が衝突など、色々な問題も発生します。あまり書き足し過ぎないのも大事だと思います。
まずはLinterなどガードレールで対処して、残りをシステムプロンプトで対処するのが正攻法だと思います。ただガードレールの構築も面倒なので、構築コストが見合わなければ、システムプロンプトというのもアリだと思います。

最小限な内容なので、これをスタートラインとして各々でプロンプト育てて頂ければ幸いです。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?