Copilot無償版

Pythonのコーディング結果を実行するために、Python+Flaskが必要です。
こちらのサイトを参考にローカル環境へのインストールを実施しておきましょう。
https://flask.palletsprojects.com/en/stable/installation/

演習シナリオ

Pythonで顧客管理を行うWebアプリケーションを作成したいと考えています。
ひとことでPythonと言っても、所属する業態や法人により記述作法が定義されています。
この演習では PEP 8（Style Guide for Python Code） を
サンプルとして、作法にのっとったコードの生成を試してみます。

演習手順

①作法を認識させます。
この演習では、作法の文書化からとりかかります。
組織内に文書化されているものがあればそちらを流用してください。
次のプロンプトを実行してください。

PEP8にのっとったコーディング作法について生成してください。
このあとPythonのコーディングをしてもらいたいので、
AIに作法を網羅させることができるような粒度でお願いします。

次のような出力を得ることができます。

PEP8（Python Enhancement Proposal 8）は、Pythonコードの可読性と一貫性を高めるためのスタイルガイドです。コーディング作法に移る前に、AIが「作法を網羅できる粒度」でPEP8の要点を整理します。

🧠 PEP8に基づくPythonコーディング作法（網羅的な粒度）

1. インデント

スペース4つを使用（タブは使用しない）

def func():
    if True:
        print("Hello")

2. 最大行長

1行は79文字以内（コメントは72文字以内が推奨）

3. 空白の使い方

演算子の前後にスペース

x = a + b

コンマの後にスペース

items = [1, 2, 3]

関数の引数の前後にスペースを入れない

func(a, b)  # OK
func( a, b )  # NG

4. 空行

トップレベルの関数やクラスの間には2行の空行
クラス内のメソッド間には1行の空行

5. インポートの順序

標準ライブラリ
サードパーティライブラリ
自作モジュール

import os
import sys

import numpy as np

from mymodule import myfunc

6. 命名規則

種類	スタイル	例
変数名	小文字＋アンダースコア	`user_name`
関数名	小文字＋アンダースコア	`get_data()`
クラス名	キャメルケース	`UserProfile`
定数	全大文字＋アンダースコア	`MAX_SIZE`

7. コメント

コードの意図を明確にする
英語が推奨（日本語でもOKだが統一する）
Docstring（関数やクラスの説明）は三重引用符で記述

def add(a, b):
    """2つの数値を加算して返す"""
    return a + b

8. 不要なコードの削除

未使用の変数、インポート、関数は削除する

9. 例外処理

明示的に例外をキャッチし、適切に処理する

try:
    result = 10 / 0
except ZeroDivisionError:
    print("ゼロ除算エラー")
---
### 10. **可読性のための改行**
- 複雑な式は適切に改行する
```python
total = (first_variable
         + second_variable
         - third_variable)

11. ファイル末尾の改行

ファイルの最後には1つの改行を入れる

12. 型ヒント（Python 3.5以降）

def greet(name: str) -> str:
    return f"Hello, {name}"
---
## ✅補足：PEP8チェックツール
- `flake8`
- `black`（自動整形）
- `pylint`
---

②　作法にのっとってコーディングを実施します。
最初に、先に生成された作法定義またはあなたの組織で準備されている作法定義を認識させます。
次のプロンプトを実施してください。

# 背景
あなたはPythonのコーディングを実施するプロフェッショナルです。
入力に記載された処理のコードを生成してください。
 
# 命令
先に生成した作法の定義を遵守してコードを生成してください。
定義から外れる場合は、外れた個所を明記し、外れた理由を記載してください。
 
# 入力
"""
タイ料理メニューのデータを登録、修正、削除できる。
カラムは、料理名、種類、写真（画像アップロード）、辛さ（5段階）、カロリー
データはSQLiteに格納する。
データ登録、修正、検索、削除機能をもったWeb画面を表示できる。
画面イメージは、白背景に青系コントロール、文字は濃いグレーにする。
"""
# 出力
先頭に内容が見て取れる簡潔なプログラム名の案を記載してください。
Flaskですぐに実行できるコードとして生成してください。
SQLiteのDB作成および初期化処理コードを独立して生成してください。
インターフェイスとして必要なhtml文もすべて生成してください。
Jingerテンプレートルールを厳守してhtml文を生成してください。
ルートディレクトリをc:\workとし、ファイル格納構造を示してください。

生成結果を確認してください。

③ AIに自己診断させてみる
生成されたコードに落ち度がないか自己診断させてみます。
次のプロンプトを実行してください。

# 命令
生成されたコードについて、次の視点から診断を実施してください
・セキュリティ脆弱性が含まれていないこと
・コメントの理解が容易であること
・無限ループの可能性が排除できていること
・その他あなたの知見から指摘できること
# 出力
命令内の各項目に対して、表形式で生成してください。
次の5列でお願いします。
診断日時（JST）、診断項目、診断結果、その理由、解消案、その他指摘事項

命令に従って生成されたコードが診断されたことを確認してださい。

自己診断プロンプトは人間が書いたコードの診断にも流用可能です。

④　AIにコードを修正させてみる
診断結果を取り入れてコードの改善を実施してみます。
次のプロンプトを実行してください。

診断結果に基づいて、以前生成したコードを改善してください。
どこが改善されたのか、改善前後の差分がわかるようにコメントも追記してください。

生成結果を確認してください。

⓹　生成結果をファイルとしてダウンロードする。
ファイルとして出力できる環境の場合は、すべての生成結果を圧縮してダウンロードすることができます。

最後に全生成結果をzipファイルとして出力してください。

この演習はこれで終了です。
みなさまの業務にご活用ください。