# バッチ設計書 34-export_filters

## 概要

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

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

export_filtersは、InvenTreeで利用可能な全てのDjangoテンプレートフィルター情報をYAML形式でファイルにエクスポートするDjango管理コマンドである。

**業務上の目的・背景**：InvenTreeはDjangoテンプレートエンジンを使用しており、レポート生成やラベル印刷などの機能でカスタムテンプレートフィルターを提供している。テンプレートフィルターは、テンプレート内で変数の値を変換・整形するために使用される重要な機能である。これらのフィルター情報をドキュメント化することで、ユーザーがカスタムテンプレートを作成する際の参考資料として活用できる。本バッチは、システムに登録されている全テンプレートフィルター（ビルトインフィルターおよびカスタムフィルター）の情報を自動的に収集し、YAML形式でエクスポートすることで、ドキュメンテーションの自動生成を支援する。

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

**主要な処理内容**：
1. Djangoテンプレートエンジンのデフォルトエンジンを取得
2. ビルトインテンプレートライブラリからフィルターを抽出
3. アプリケーション固有のテンプレートライブラリからフィルターを抽出
4. 各フィルターのドキュメント文字列（docstring）を解析
5. YAML形式で指定ファイルにエクスポート

**前後の処理との関連**：
- 前提：Django環境が初期化されていること
- 後続：ドキュメンテーションビルドでフィルター情報が利用される

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

## バッチ種別

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

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Django環境 | Django環境が正しく設定されていること |
| テンプレートエンジン | Djangoテンプレートエンジンが設定されていること |
| ファイル書き込み権限 | 出力先ディレクトリへの書き込み権限があること |

### 実行可否判定

特別な判定ロジックなし。テンプレートエンジンの設定が不正な場合（ImproperlyConfigured）は空のリストを返す。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Engine.get_default() | Djangoオブジェクト | デフォルトテンプレートエンジン |
| engine.template_libraries | Python辞書 | アプリ定義のテンプレートライブラリ |
| engine.template_builtins | リスト | ビルトインテンプレートライブラリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 指定ファイル | YAML | テンプレートフィルター情報 |

### 出力ファイル仕様

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

### 出力YAMLスキーマ

```yaml
- name: <フィルター名>
  title: <タイトル（docstringの最初の行）>
  body: <本文（docstringの詳細説明）>
  meta: <メタデータ>
  library: <所属ライブラリ名>
```

## 処理フロー

### 処理シーケンス

```
1. コマンド引数からファイル名を取得
   └─ filenameパラメータを取得
2. discover_filters()関数を呼び出し
   └─ Djangoテンプレートエンジンを取得
   └─ ビルトインライブラリをループ処理
   └─ アプリライブラリをループ処理（ソート済み）
   └─ 各フィルターのdocstringを解析
3. YAMLファイル出力
   └─ UTF-8エンコードでファイルに書き込み
4. 完了メッセージ出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[ファイル名引数取得]
    B --> C[discover_filters呼び出し]
    C --> D[デフォルトエンジン取得]
    D --> E{エンジン取得成功?}
    E -->|No| F[空リスト返却]
    E -->|Yes| G[ビルトインライブラリ処理]
    G --> H[アプリライブラリ処理]
    H --> I[各フィルターのdocstring解析]
    I --> J[フィルター情報をリストに追加]
    J --> K{全ライブラリ完了?}
    K -->|No| H
    K -->|Yes| L[フィルターリスト返却]
    F --> M[YAMLファイルに書き込み]
    L --> M
    M --> N[完了メッセージ出力]
    N --> O[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | 本バッチはDBを操作しない |

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

本バッチはデータベースへのアクセスは行わない。テンプレートエンジンの設定情報のみを使用する。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ImproperlyConfigured | テンプレートエンジンが設定されていない | Django設定を確認 |
| - | FileNotFoundError | 出力先ディレクトリが存在しない | ディレクトリを作成して再実行 |
| - | PermissionError | 出力先への書き込み権限がない | 権限を確認して再実行 |

### リトライ仕様

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

### 障害時対応

1. エラーログを確認
2. 原因（設定、権限、パスなど）を特定
3. 問題解決後に再実行

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十〜数百件のテンプレートフィルター |
| 目標処理時間 | 1秒未満 |
| メモリ使用量上限 | 最小限（リストデータのみ） |

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 完了ログ | 処理完了時 | "Exported InvenTree filter definitions to '{filename}'" |

## 監視・アラート

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

## 備考

- 本コマンドは `invoke export_definitions` から呼び出される
- 出力されたYAMLファイルはInvenTreeのドキュメンテーションシステムで利用される
- docstring解析にはDjango admindocsのutils.parse_docstring関数を使用
- テンプレートエンジンが設定されていない場合は空のフィルターリストが出力される
- ビルトインフィルターとアプリ固有フィルターの両方が収集される
- export_tagsと同様の構造だが、library.filtersを参照する点が異なる
