# 通知設計書 80-warnBareExcept

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ「warnBareExcept」（ベア例外警告）に関する通知設計書である。try-except文で型指定のない「ベア」except節が使用された場合に、開発者に警告を発する機能について記載する。

### 本通知の処理概要

この通知は、Nimコンパイラがtry-except文を解析する際に、特定の例外型を指定しない「ベア」except節（`except:`のみの形式）を検出した場合に発行される警告メッセージである。

**業務上の目的・背景**：Nimの例外処理では、`except:`のみでは全ての例外をキャッチするが、これはDefect（プログラムのバグを示す例外）も含めてすべての例外をキャッチしてしまう。これは多くの場合意図しない動作であり、適切なエラーハンドリングを妨げる。本警告は、より具体的な例外型（CatchableErrorやDefect）を指定することを促し、堅牢なエラーハンドリングを実現することを目的とする。

**通知の送信タイミング**：コンパイル時、セマンティック解析フェーズ（semstmts）において、try-except文のexcept節が型指定なしである場合に発行される。また、例外型が直接Exceptionを継承している場合も警告が発行される。

**通知の受信者**：Nimコンパイラを使用してコードをコンパイルしている開発者。警告メッセージは標準エラー出力またはコンパイラの設定に応じた出力先に送信される。

**通知内容の概要**：警告メッセージには、問題のあるexcept節と「catch a more precise Exception deriving from CatchableError or Defect」という対処方法が含まれる。

**期待されるアクション**：開発者は警告を確認し、`except CatchableError:`のような具体的な例外型を指定するか、意図的にすべての例外をキャッチする場合は警告を認識した上で適切に処理することが期待される。

## 通知種別

コンパイラ警告メッセージ（標準エラー出力/構造化出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル時） |
| 優先度 | 中（Warning） |
| リトライ | なし |

### 送信先決定ロジック

コンパイラの標準エラー出力、または`--stdout`オプション指定時は標準出力に送信。`structuredErrorHook`が設定されている場合はフック関数を通じて送信される。

## 通知テンプレート

### コンパイラ警告出力の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ |
| 形式 | テキスト |
| 重大度 | Warning |

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Warning: {メッセージ} [BareExcept]
```

#### ケース1：ベアexcept節

```
{ファイルパス}({行番号}, {列番号}) Warning: catch a more precise Exception deriving from CatchableError or Defect. [BareExcept]
```

#### ケース2：非推奨のベアexcept節（レガシーフィーチャー使用時）

```
{ファイルパス}({行番号}, {列番号}) Warning: The bare except clause is deprecated; use `except CatchableError:` instead [BareExcept]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 警告メッセージ | semstmts.nimで構築 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル時 | except節解析 | 型指定なしまたはException直接継承 | semstmts.nimで検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:BareExcept:off | コマンドラインで明示的に無効化された場合 |
| {.warning[BareExcept]:off.} | プラグマで無効化された場合 |
| デフォルトで無効 | NotesVerbosity[3]から除外されている |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[try-except文解析] --> B{except節あり?}
    B -->|No| I[終了]
    B -->|Yes| C{except節の型チェック}
    C --> D{型指定なし?}
    D -->|Yes| E{noPanicOnExcept?}
    E -->|Yes| F[非推奨警告発行]
    E -->|No| G[直接継承チェック警告発行]
    D -->|No| H{isDefectOrCatchableError?}
    H -->|Yes| I
    H -->|No| G
    F --> I
    G --> I
```

## データベース参照・更新仕様

### 参照テーブル一覧

コンパイラはデータベースを使用せず、メモリ上のAST（抽象構文木）と型階層情報を参照する。

### 内部データ構造

| 構造体 | 用途 | 備考 |
|--------|------|------|
| PType | 型情報 | 例外型の継承関係を確認 |
| TLineInfo | 位置情報 | ファイル/行/列を保持 |
| ConfigRef | 設定 | legacyFeatures, warningフラグを保持 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 警告の昇格 | --warningAsError:BareExcept指定時 | エラーとして扱いコンパイル中断 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | なし |
| リトライ対象エラー | なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | なし |
| 1日あたり上限 | なし |

### 配信時間帯

コンパイル実行時に即時発行

## セキュリティ考慮事項

- ファイルパスが出力に含まれるため、センシティブなパス情報が漏洩する可能性がある
- 適切でない例外処理はセキュリティ脆弱性の原因となり得る（例：情報漏洩、サービス拒否）

## 備考

- デフォルトでは無効化されている（NotesVerbosity[3]から除外）
- noPanicOnExceptレガシーフィーチャーによって挙動が変わる
- CatchableErrorまたはDefectの使用が推奨される

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

警告の定義と例外型の階層を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | 93行目: warnBareExceptの定義を確認 |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | 202行目: メッセージテンプレート「$1」を確認 |
| 1-3 | lineinfos.nim | `compiler/lineinfos.nim` | 265行目: NotesVerbosityからの除外を確認 |

**読解のコツ**: warnBareExceptはデフォルトで無効化されている（NotesVerbosity[3]から除外）。

#### Step 2: エントリーポイントを理解する

警告発行の起点となるtry-except文解析処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | semstmts.nim | `compiler/semstmts.nim` | 343-414行目: semTry関数の実装 |
| 2-2 | semstmts.nim | `compiler/semstmts.nim` | 354行目: isDefectOrCatchableErrorチェックと警告発行 |
| 2-3 | semstmts.nim | `compiler/semstmts.nim` | 394-399行目: ベアexcept節の処理と警告発行 |

**主要処理フロー**:
1. **354行目**: isDefectOrCatchableError判定と警告発行（型指定ありの場合）
2. **394行目**: a.len == 1（型指定なしexcept節）の検出
3. **397-399行目**: noPanicOnExceptフラグによる警告メッセージの分岐

#### Step 3: isDefectOrCatchableErrorを理解する

例外型の継承関係チェックを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | semstmts.nim | `compiler/semstmts.nim` | isDefectOrCatchableError関数の定義 |

**読解のコツ**: この関数はCatchableErrorまたはDefectから派生した例外型かどうかを判定する。

### プログラム呼び出し階層図

```
semTry (semstmts.nim:343)
    │
    ├─ semExceptBranchType
    │      └─ 例外型の解析
    │
    ├─ isDefectOrCatchableError
    │      └─ 継承関係チェック
    │
    ├─ message (msgs.nim:641)
    │      └─ warnBareExcept
    │
    └─ noPanicOnExcept判定
           └─ legacyFeaturesフラグ
```

### データフロー図

```
[入力]               [処理]                    [出力]

try-except AST ───▶ semTry関数 ───▶ 警告メッセージ
   │                   │                    │
   │                   ├─ except節解析      ├─ 標準エラー出力
   │                   │                    │
   └─ 例外型           └─ 継承関係チェック   └─ [BareExcept]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | メッセージ種別とテンプレートの定義 |
| semstmts.nim | `compiler/semstmts.nim` | ソース | try-except文のセマンティック解析 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力の実装 |
| types.nim | `compiler/types.nim` | ソース | 型継承関係ユーティリティ |
| options.nim | `compiler/options.nim` | ソース | legacyFeaturesフラグ管理 |
