# バッチ設計書 35-export_report_context

## 概要

本ドキュメントは、InvenTreeシステムにおけるレポートコンテキストエクスポートバッチ（export_report_context）の設計仕様を定義する。

### 本バッチの処理概要

export_report_contextは、InvenTreeのレポートシステムで利用可能なコンテキスト情報（テンプレート変数）をJSON形式でファイルにエクスポートするDjango管理コマンドである。

**業務上の目的・背景**：InvenTreeはカスタマイズ可能なレポート・ラベル生成機能を持ち、ユーザーは独自のテンプレートを作成できる。レポートテンプレート内では、各モデルに関連するコンテキスト変数（オブジェクトの属性、関連データなど）を使用できる。本バッチは、これらのコンテキスト変数の定義情報（名前、型、説明）を自動的に抽出し、JSON形式でエクスポートする。これにより、ドキュメンテーションシステムで利用可能なコンテキスト変数を自動的にドキュメント化でき、ユーザーがカスタムテンプレートを作成する際の参考資料として活用できる。

**バッチの実行タイミング**：手動実行（CLIコマンド）。以下の場面で実行される：
- ドキュメント生成時（`invoke export_definitions` から呼び出し）
- レポートコンテキストのドキュメント更新時

**主要な処理内容**：
1. ベースコンテキスト拡張クラス（global, report, label）から共通コンテキストを抽出
2. レポート対象モデルのreport_context()メソッドからモデル固有コンテキストを抽出
3. 型ヒント情報を解析してコンテキスト変数の型情報を取得
4. docstringからコンテキスト変数の説明を抽出
5. JSON形式で指定ファイルにエクスポート

**前後の処理との関連**：
- 前提：Django環境が初期化されていること、レポートモデルが正しく設定されていること
- 後続：ドキュメンテーションビルドでコンテキスト情報が利用される

**影響範囲**：
- 指定された出力ファイル（JSONファイル）
- InvenTreeドキュメンテーション（レポートコンテキスト参照）

## バッチ種別

データエクスポート / ドキュメント生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動 / 他コマンドからの呼び出し |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Django環境 | Django環境が正しく設定されていること |
| レポートモデル | report_model_types()で取得できるモデルが定義されていること |
| 型アノテーション | report_context()メソッドに戻り値型アノテーションが定義されていること |
| ファイル書き込み権限 | 出力先ディレクトリへの書き込み権限があること |

### 実行可否判定

モデルのreport_context()に戻り値型アノテーションが無い場合、エラーメッセージを出力し、最終的にCommandErrorを発生させる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| filename | str | Yes | - | 出力ファイル名（JSON形式） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| BaseContextExtension | Pythonクラス | グローバルコンテキスト定義 |
| ReportContextExtension | Pythonクラス | レポート固有コンテキスト定義 |
| LabelContextExtension | Pythonクラス | ラベル固有コンテキスト定義 |
| report_model_types() | 関数 | レポート対象モデルのリスト |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 指定ファイル | JSON | レポートコンテキスト情報 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 引数で指定（デフォルト: inventree_report_context.json） |
| 出力先 | カレントディレクトリまたは指定パス |
| 文字コード | UTF-8 |
| フォーマット | JSON（インデント: 4スペース） |

### 出力JSONスキーマ

```json
{
  "base": {
    "global": {
      "key": "global",
      "context": {
        "<変数名>": {
          "description": "<説明>",
          "type": "<型>"
        }
      }
    },
    "report": { ... },
    "label": { ... }
  },
  "models": {
    "<モデル名>": {
      "key": "<モデル名>",
      "name": "<verbose_name>",
      "context": {
        "<変数名>": {
          "description": "<説明>",
          "type": "<型>"
        }
      }
    }
  }
}
```

## 処理フロー

### 処理シーケンス

```
1. コマンド引数からファイル名を取得
   └─ filenameパラメータを取得
2. ベースコンテキストの処理
   └─ global, report, labelの各拡張クラスを処理
   └─ 型ヒントからコンテキスト変数を抽出
   └─ docstringから説明を抽出
3. モデル固有コンテキストの処理
   └─ report_model_types()でモデル一覧を取得
   └─ 各モデルのreport_context()の戻り値型を解析
   └─ 型ヒントからコンテキスト変数を抽出
4. エラーチェック
   └─ 型アノテーション欠落時はCommandErrorを発生
5. JSONファイル出力
   └─ UTF-8エンコードでファイルに書き込み
6. 完了メッセージ出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[ファイル名引数取得]
    B --> C[ベースコンテキスト処理]
    C --> D[global/report/labelを処理]
    D --> E[型ヒント解析]
    E --> F[モデル一覧取得]
    F --> G{モデルあり?}
    G -->|Yes| H[report_contextの型取得]
    H --> I{型アノテーションあり?}
    I -->|No| J[エラーフラグ設定]
    I -->|Yes| K[コンテキスト変数抽出]
    J --> L{次のモデル?}
    K --> L
    L -->|Yes| H
    L -->|No| M{エラーあり?}
    G -->|No| M
    M -->|Yes| N[CommandError発生]
    M -->|No| O[JSONファイル出力]
    O --> P[完了メッセージ出力]
    P --> Q[バッチ終了]
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | 本バッチはDBを操作しない（モデル定義のみ参照） |

### テーブル別操作詳細

本バッチはデータベースへのアクセスは行わない。モデルクラスの定義情報のみを使用する。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| INVE-E3 | CommandError | django.db.models.QuerySetを直接使用 | report.mixins.QuerySetを使用 |
| INVE-E4 | CommandError | report_context()に戻り値型アノテーションがない | 型アノテーションを追加 |
| - | FileNotFoundError | 出力先ディレクトリが存在しない | ディレクトリを作成して再実行 |
| - | PermissionError | 出力先への書き込み権限がない | 権限を確認して再実行 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動再実行） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

1. エラーメッセージを確認（INVE-E3, INVE-E4など）
2. 該当モデルのreport_context()メソッドを修正
3. 問題解決後に再実行

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（ファイル出力のみ） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十件のモデル |
| 目標処理時間 | 数秒未満 |
| メモリ使用量上限 | 最小限（辞書データのみ） |

## 排他制御

同時実行の制御は行わない。出力ファイルの競合に注意。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | 型アノテーション欠落時 | "Error: Model {model}.report_context does not have a return type annotation" |
| 完了ログ | 処理完了時 | "Exported InvenTree report context definitions to '{filename}'" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| なし | - | - |

## 備考

- 本コマンドは `invoke export_definitions` から呼び出される
- 出力されたJSONファイルはInvenTreeのドキュメンテーションシステムで利用される
- report_context()メソッドには必ず戻り値型アノテーションが必要
- django.db.models.QuerySetの直接使用は禁止され、report.mixins.QuerySetを使用する必要がある
- 型情報はget_type_hints()とget_type_str()関数で解析される
- docstringの"Attributes:"セクションから各変数の説明が抽出される
