コンテンツハッシュファイルキャッシュパターン
SHA-256コンテンツハッシュをキャッシュキーとして使用し、高コストなファイル処理結果（PDF解析、テキスト抽出、画像分析など）をキャッシュします。パスベースのキャッシュとは異なり、ファイルの移動や名前変更にも対応し、コンテンツが変更された場合に自動的に無効化されます。
アクティベーション条件
- ファイル処理パイプラインを構築する場合（PDF、画像、テキスト抽出）
- 処理コストが高く、同じファイルが繰り返し処理される場合
--cache/--no-cacheCLIオプションが必要な場合- 既存の純粋関数を変更せずにキャッシュを追加したい場合
コアパターン
1. コンテンツハッシュベースのキャッシュキー
ファイルパスではなく、ファイルの内容をキャッシュキーとして使用します。
import hashlib
from pathlib import Path
_HASH_CHUNK_SIZE = 65536 # 64KB chunks for large files
def compute_file_hash(path: Path) -> str:
"""SHA-256 of file contents (chunked for large files)."""
if not path.is_file():
raise FileNotFoundError(f"File not found: {path}")
sha256 = hashlib.sha256()
with open(path, "rb") as f:
while True:
chunk = f.read(_HASH_CHUNK_SIZE)
if not chunk:
break
sha256.update(chunk)
return sha256.hexdigest()
なぜコンテンツハッシュなのか？ ファイルの名前変更/移動 = キャッシュヒット。コンテンツ変更 = 自動無効化。インデックスファイル不要。
2. 不変データクラスによるキャッシュエントリ
from dataclasses import dataclass
@dataclass(frozen=True, slots=True)
class CacheEntry:
file_hash: str
source_path: str
document: ExtractedDocument # キャッシュされた結果
3. ファイルベースのキャッシュストレージ
各キャッシュエントリは {hash}.json として保存されます — ハッシュによる O(1) ルックアップ、インデックスファイル不要。
import json
from typing import Any
def write_cache(cache_dir: Path, entry: CacheEntry) -> None:
cache_dir.mkdir(parents=True, exist_ok=True)
cache_file = cache_dir / f"{entry.file_hash}.json"
data = serialize_entry(entry)
cache_file.write_text(json.dumps(data, ensure_ascii=False), encoding="utf-8")
def read_cache(cache_dir: Path, file_hash: str) -> CacheEntry | None:
cache_file = cache_dir / f"{file_hash}.json"
if not cache_file.is_file():
return None
try:
raw = cache_file.read_text(encoding="utf-8")
data = json.loads(raw)
return deserialize_entry(data)
except (json.JSONDecodeError, ValueError, KeyError):
return None # 破損はキャッシュミスとして扱う
4. サービス層ラッパー（単一責任の原則）
処理関数を純粋なままに保ち、キャッシュは別のサービス層として追加します。
def extract_with_cache(
file_path: Path,
*,
cache_enabled: bool = True,
cache_dir: Path = Path(".cache"),
) -> ExtractedDocument:
"""サービス層: キャッシュ確認 -> 抽出 -> キャッシュ書き込み"""
if not cache_enabled:
return extract_text(file_path) # 純粋関数、キャッシュを認識しない
file_hash = compute_file_hash(file_path)
# キャッシュ確認
cached = read_cache(cache_dir, file_hash)
if cached is not None:
logger.info("Cache hit: %s (hash=%s)", file_path.name, file_hash[:12])
return cached.document
# キャッシュミス -> 抽出 -> 保存
logger.info("Cache miss: %s (hash=%s)", file_path.name, file_hash[:12])
doc = extract_text(file_path)
entry = CacheEntry(file_hash=file_hash, source_path=str(file_path), document=doc)
write_cache(cache_dir, entry)
return doc
主要な設計判断
| 判断 | 理由 |
|---|---|
| SHA-256 コンテンツハッシュ | パスに依存せず、コンテンツ変更時に自動無効化 |
{hash}.json ファイル命名 | O(1) ルックアップ、インデックスファイル不要 |
| サービス層ラッパー | 単一責任の原則: 抽出は純粋関数、キャッシュは別責務 |
| 手動 JSON シリアライズ | 不変データクラスのシリアライズを完全制御 |
破損は None を返す | グレースフルな劣化、次回実行時に再処理 |
cache_dir.mkdir(parents=True) | 初回書き込み時に遅延ディレクトリ作成 |
ベストプラクティス
- パスではなく内容をハッシュ化 — パスは変わるが、コンテンツの同一性は変わらない
- 大きなファイルのハッシュ化はチャンク単位で — ファイル全体をメモリに読み込まない
- 処理関数は純粋関数に保つ — キャッシュについて一切認識させるべきではない
- キャッシュヒット/ミスをログに記録 — デバッグのために切り詰めたハッシュを出力
- 破損をグレースフルに処理 — 無効なキャッシュエントリはミスとして扱い、決してクラッシュしない
避けるべきアンチパターン
# 悪い例: パスベースのキャッシュ（ファイル移動/名前変更で破綻する）
cache = {"/path/to/file.pdf": result}
# 悪い例: 処理関数内にキャッシュロジックを追加（単一責任の原則違反）
def extract_text(path, *, cache_enabled=False, cache_dir=None):
if cache_enabled: # この関数が2つの責務を持つことになる
...
# 悪い例: ネストした不変データクラスに dataclasses.asdict() を使用
# （複雑なネスト型で問題を引き起こす可能性がある）
data = dataclasses.asdict(entry) # 代わりに手動シリアライズを使用
使用すべき場合
- ファイル処理パイプライン（PDF解析、OCR、テキスト抽出、画像分析）
--cache/--no-cacheオプションが有用なCLIツール- 同じファイルが複数回実行されるバッチ処理
- 既存の純粋関数を変更せずにキャッシュを追加する場合
使用すべきでない場合
- 常に最新のデータが必要な場合（リアルタイムフィード）
- キャッシュエントリが非常に大きくなる場合（代わりにストリーミングを検討）
- ファイル内容以外のパラメータに依存する結果（異なる抽出設定など）