Blame for code/README.md

# NDL OCR一括ダウンローダー

NDL次世代デジタルライブラリーの公式APIから、指定したPIDのOCR ZIP、全コマ連結TXT、書誌JSONを保存します。Python 3.10以降の標準ライブラリだけで動作します。多重起動防止に `fcntl` を使うため、Linux / macOS / WSL向けです。

## まず3件で試す

```bash
cd /home/kuramoto/ds
python3 ndl_download.py download --pids pids_sample.txt --limit 3
```

実行済みの3件は `corpus/` に保存してあります。同じコマンドで再開できます。

| PID | 資料 | 出版年（API書誌） | 本文文字数（改行含む） |
| --- | --- | ---: | ---: |
| 897115 | 帝国図書館一覧 | 1901 | 39,099 |
| 2541060 | 囃物語 3巻 | 1680 | 28,570 |
| 2579565 | 源氏物語 [57] | 1650 | 37,364 |

2026年10月18日（日本時間）の実行で3件とも成功。再実行で3件とも `skipped` になることを確認しました。897115は公式APIの例示資料であり、江戸時代以前の抽出対象には含めません。文字数はOCRの品質評価ではありません。

403対応の追加検証では、14491351・14491350・14491349はいずれも `This PID is not allowed` を返し、`unavailable` として保存しました。数値昇順の先頭3件では753436・753437（『論衡 30卷』）を取得でき、753435はHTTP 504が続いて失敗しました。PID順の変更は取得成功を保証しません。

## 公式の書誌データから対象PIDを作る

[NDLのオープンデータセット](https://www.ndl.go.jp/dlib/standards/opendataset)から、目的の資料種別の「ログインなしで閲覧可能」の **TSV ZIP** を取得します。資料種別はダウンロードするファイルで選びます。古典籍TSVには「資料種別」という列はありません。

2026年2月版の古典籍書誌ZIPは取得済みです。別環境で取得する場合:

```bash
mkdir -p corpus/metadata
curl --fail --location --retry 3 \
  https://dl.ndl.go.jp/static/files/dataset/dataset_202602_k_internet.zip \
  --output corpus/metadata/dataset_202602_k_internet.zip
```

保護期間満了・インターネット公開のうち、出版年1867年以前を抽出:

```bash
python3 ndl_download.py prepare \
  --input corpus/metadata/dataset_202602_k_internet.zip \
  --max-year 1867 \
  --output pids_before_1868.txt \
  --records corpus/metadata/selected_before_1868.jsonl
```

このコマンドも実行済みです。97,781行から40,160件を抽出しました（権利・公開条件の除外50行、年条件の除外57,571行）。これは**ダウンロード候補数**で、OCRの取得成功数ではありません。書誌とAPIの同期状況により取得できないPIDがあります。

年の判定には `出版日（W3CDTF）` の明示的な西暦を使い、和暦の推定変換は行いません。`1762||1763` のように複数年がある場合は全てが上限以下のものを採用します。年不明・部分年・未対応の表記は `--max-year` 指定時に除外します。`--max-year` を省略すれば年で除外しません。`--title-contains 源氏物語` のようなタイトルの絞り込みもできます。TSVを展開したファイルも入力可能です。

出版年と成立年は異なります。この抽出は日本語・古文・漢文の分類や、成立年代の確認をしません。書誌原文はZIPと選択済みJSONLに残します。

## 件数を増やして取得する

まず先頭5件に限定:

```bash
python3 ndl_download.py download --pids pids_before_1868.txt --limit 5
```

書誌一覧の先頭には、次世代デジタルライブラリーAPIが `403: This PID is not allowed` を返す資料が含まれます。これらは `unavailable` として記録して次へ進み、再実行時には問い合わせを省略します。40,160件全てにOCRが提供されるという意味ではありません。

PIDの数値が小さいものから取得する場合（収録有無を保証する条件ではなく、取得順だけを変更）:

```bash
python3 ndl_download.py download --pids pids_before_1868.txt --order pid-asc --limit 5
```

全件をこの順番で取得する場合は `--limit 5` を外してください。以前に対象外と判定された資料を、サービス更新後などに再確認するには `--retry-unavailable` を付けます。

対象全件を取得するコマンド（今回は実行していません）:

```bash
python3 ndl_download.py download --pids pids_before_1868.txt --workers 4
```

`--limit` は重複除去後の一覧の先頭件数です。取得済みのスキップも件数に含むため、繰り返して次の5件へ進む指定ではありません。段階的に進める場合は上限を増やしてください。複数の図書TSVを使う場合は、`prepare` の出力先をファイルごとに変え、PIDファイルを結合して `download` に渡せます。`download` 側で重複を除去します。

PIDを直接指定することもできます:

```bash
python3 ndl_download.py download --pid 2541060 --pid 2579565 --output corpus
```

## 保存内容と再開

```text
corpus/
├── raw/{pid}.zip                 # APIが返した元ZIP（全コマTXT・座標JSON等）
├── text/{pid}.txt                # ZIP内の全コマ連結TXT（元のバイト列を維持）
├── metadata/{pid}.json           # Book APIの書誌情報
├── metadata/selected_before_1868.jsonl  # 選択済みTSV行の原文
├── metadata/dataset_202602_k_internet.zip # 元の書誌データ
├── unavailable/{pid}.json        # APIが明示的にPID対象外と返した記録
└── logs/downloads.jsonl          # 成功・スキップ・失敗、サイズ、本文SHA-256等
```

- 通常のリクエスト間の待機はありません（`--interval 0` が既定）。`--workers N` または `-n N` でN資料を並列取得できます（既定1）。例: `--workers 4`。1資料内ではZIPと書誌を順番に取得するため、同時リクエストは最大N件です。必要なら `--interval 5` で各ワーカーのリクエスト終了から次の開始まで5秒空けられます。
- `--order` は資料の投入順を指定します。並列時の完了・ログ出力は順不同です。ログの追記と集計はメインスレッドで行います。
- ZIPのCRC、連結TXTの存在、UTF-8、空本文を検査し、検証後に `.part` から確定ファイルへ置き換えます。応答は512MiB、ZIP展開後合計は1GiBを上限にしています。全ファイルの展開は行いません。
- 取得済みのZIPも検証し、正常なら再ダウンロードしません。TXTはZIPから再生成するので、TXTだけ消えた場合も復元できます。書誌の欠損・不正JSONも再取得します。
- 破損ZIPは再取得します。中断した `.part` は次回の転送で最初から書き直します。資料単位の再開であり、HTTP Rangeによる途中バイトからの再開はしません。
- HTTP 408/429/500/502/503/504、通信障害、ZIP検証エラー等は既定で最大4回試行。指数バックオフに加えて `Retry-After` を尊重します。404等はその資料を失敗として次へ進みます。
- `403` かつ応答本文が `This PID is not allowed` の場合だけ、OCRの取得対象外を示す `unavailable` として保存します。その他の403は `blocked` として新しい資料の取得を停止し、並列で処理中の資料は完了・ログ保存まで待ちます。アクセス制限とPIDの対象外を混同せず、応答本文の先頭もログに保存します。
- 失敗はJSONLに追記し、1件でも `failed` / `blocked` があれば終了コード1。`unavailable` だけなら終了コード0ですが、OCR取得成功ではありません。Ctrl+Cは130です。書誌取得だけ失敗した場合もZIP/TXTは保持され、同じコマンドで不足分を取得できます。
- 同じ出力先への同時実行をロックで防ぎます。別の出力先で並列起動すると全体の負荷は増えるため、1プロセスで運用してください。

詳細なオプション:

```bash
python3 ndl_download.py prepare --help
python3 ndl_download.py download --help
```

## 検証

```bash
python3 -m unittest -v
```

`python3 -m unittest -v test_ndl_download` のネット接続不要の16テストで、通常時の待機なし、並列数の上限、並列時の保存・ログ・再開・403停止、CLI指定、HTTP 429の再試行と待機、404の扱い、HTML応答の排除、空本文、連結TXTの欠落、CRC破損、通信なしの再開、書誌の年・権利条件、PID対象外のキャッシュと再確認、数値順の取得を確認します。実APIでは上記3件の取得と再実行を確認済みです。今回追加した並列処理は模擬応答で検証しています。

## 公式資料

- [次世代デジタルライブラリーのAPIについて](https://lab.ndl.go.jp/service/tsugidigi/apiinfo/): `/book/fulltext/{pid}` が資料全体のOCRをZIPで提供し、連結TXTも収録。
- [オープンデータセット](https://www.ndl.go.jp/dlib/standards/opendataset): PID列と権利・公開区分、書誌TSVの配布元。

数万件の連続取得に進む前にNDLへ大量利用について相談する運用を推奨します。公式書誌ページには大量アクセス時に制限・遮断する場合があると記載されています。