プロジェクトの準備
任意の場所にpython-static-analysisフォルダを作成し、Visual Studio Codeの「ファイル」→「フォルダーを開く」から、作成したpython-static-analysisフォルダを開きます。
1. フォルダの作成
任意の場所にpython-static-analysisフォルダを作成し、Visual Studio Codeの「ファイル」→「フォルダーを開く」から、作成したpython-static-analysisフォルダを開きます。
python-static-analysis ← このフォルダを作成
さらに、python-static-analysisフォルダの中にsrcフォルダを作成します。Visual Studio Codeのエクスプローラーでpython-static-analysisフォルダを右クリックし、「新しいフォルダー」を選択してsrcという名前で作成してください。
python-static-analysis
└── src ← このフォルダを作成
| 💡 ポイント |
|---|
srcフォルダには、静的解析の対象となるPythonのソースコードを配置します。解析対象のコードとプロジェクトの設定ファイル(requirements.txtなど)を分けることで、プロジェクトの構成が整理されます。 |
2. requirements.txtの作成
requirements.txtを作成します。Visual Studio Codeのエクスプローラーでpython-static-analysisフォルダを右クリックし、「新しいファイル」を選択してrequirements.txtという名前で作成してください。
python-static-analysis
├── src
└── requirements.txt ← このファイルを作成
作成したファイルに以下の内容を記述して保存します。
flake8==7.1.1
black==24.10.0
mypy==1.13.0
各パッケージの役割は以下のとおりです。
| パッケージ | 役割 |
|---|---|
| flake8 | コードスタイルのチェックツール。PEP 8(Pythonの標準スタイルガイド)に沿っているかを検出する |
| black | コードの自動フォーマットツール。スタイルの問題を検出するだけでなく、自動的に修正する |
| mypy | 型チェックツール。型アノテーションをもとに、型の不整合を検出する |
| 💡 ポイント |
|---|
requirements.txtは、Pythonプロジェクトで使用するライブラリとそのバージョンを記載するファイルです。このファイルを用意しておくことで、pip install -r requirements.txtコマンドで必要なライブラリをまとめてインストールできます。 |
3. サンプルコードの作成
静的解析の対象となるサンプルコードを作成します。あえてスタイルの問題や型の不整合を含めたコードを用意します。
src/init.pyの作成
src/__init__.pyを作成します。Visual Studio Codeのエクスプローラーでsrcフォルダを右クリックし、「新しいファイル」を選択して__init__.pyという名前で作成してください。このファイルは空ファイルとして作成します。
python-static-analysis
├── src
│ └── __init__.py ← このファイルを作成(空ファイル)
└── requirements.txt
| 💡 ポイント |
|---|
__init__.pyは、そのフォルダがPythonのパッケージ(モジュールのまとまり)であることを示すファイルです。このファイルがないと、mypyなどのツールがsrcフォルダ内のファイルをパッケージとして認識できず、正しく解析できない場合があります。 |
3.1 src/calculator.pyの作成
src/calculator.pyを作成します。Visual Studio Codeのエクスプローラーでsrcフォルダを右クリックし、「新しいファイル」を選択してcalculator.pyという名前で作成してください。
python-static-analysis
├── src
│ ├── __init__.py
│ └── calculator.py ← このファイルを作成
└── requirements.txt
作成したファイルに以下の内容を記述して保存します。
import os # 未使用のインポート
import sys # 未使用のインポート
def add(a,b): # カンマの後にスペースがない
return a+b # 演算子の前後にスペースがない
def subtract( a, b ): # カッコの内側に不要なスペース
return a - b
def multiply(a, b):
result = a * b
return result
def divide(a, b):
if b == 0:
return "error" # 他はint/floatを返すのに、ここだけstr
return a / b
unused_variable = "this is never used" # 未使用の変数
def evaluate_score(score): # 条件分岐が多く、複雑度が高い関数
if score >= 95:
return "S"
elif score >= 90:
return "A+"
elif score >= 85:
return "A"
elif score >= 80:
return "B+"
elif score >= 75:
return "B"
elif score >= 70:
return "C+"
elif score >= 65:
return "C"
elif score >= 60:
return "D+"
elif score >= 55:
return "D"
elif score >= 50:
return "E"
else:
return "F"
このコードには、以下の問題が意図的に含まれています。
- 未使用のインポート(
os,sys) - 関数の引数や演算子の前後にスペースが不足または過剰
- 関数定義の前後の空行数がPEP 8の推奨に沿っていない
- 型の不整合(
divide関数がstrとfloatの両方を返す) - 条件分岐が多すぎる関数(
evaluate_score)
3.2 src/user_service.pyの作成
src/user_service.pyを作成します。Visual Studio Codeのエクスプローラーでsrcフォルダを右クリックし、「新しいファイル」を選択してuser_service.pyという名前で作成してください。
python-static-analysis
├── src
│ ├── __init__.py
│ ├── calculator.py
│ └── user_service.py ← このファイルを作成
└── requirements.txt
作成したファイルに以下の内容を記述して保存します。
def get_user_name(user_id: int) -> str:
users = {1: "Tanaka", 2: "Suzuki", 3: "Yamada"}
return users.get(user_id, "Unknown")
def get_user_age(user_id: int) -> int: # 戻り値はintと宣言しているが…
ages = {1: 25, 2: 30, 3: 35}
return ages.get(user_id, "N/A") # デフォルト値がstr(型の不整合)
def format_user_info(name: str, age: int) -> str: # 関数の前に空行が1行しかない
return name + " (" + str(age) + "歳)"
このコードには、以下の問題が意図的に含まれています。
- 型の不整合(
get_user_age関数は戻り値をintと宣言しているが、デフォルト値として文字列"N/A"を返す可能性がある) - 関数定義の間の空行が1行しかない(PEP 8では2行が推奨)
4. ツールのインストール
requirements.txtに記載した3つのツール(flake8、black、mypy)をまとめてインストールします。Visual Studio Codeのターミナルで以下のコマンドを実行してください。
Windowsの場合:
pip install -r requirements.txt
Macの場合:
pip3 install -r requirements.txt
-r requirements.txtオプションにより、ファイルに記載されたすべてのパッケージが一括でインストールされます。
以下のようにSuccessfully installedと表示されれば、インストールは完了です。
Successfully installed black-24.10.0 flake8-7.1.1 mypy-1.13.0 ...
| ⚠️ インストールに失敗する場合 |
|---|
pip3: command not foundやpip: command not foundと表示される場合は、Pythonが正しくインストールされていない可能性があります。事前準備のPythonインストール手順を確認してください。 |