はじめに
申請書などの入力フォーム付き PDF を pypdf で自動記入したところ、プルダウン(コンボボックス)だけ Acrobat で空欄になるという現象に遭遇しました。
困ったのは、Chrome や Edge の PDF ビューアで開くと正しく表示されることです。プレビューでは問題が見えないため、そのまま提出してしまうところでした。
原因は、プルダウンの「選択中の値」を表す情報が PDF の中に2つあることでした。
結論
- プルダウンには、値そのもの(
/V)と、何番目の選択肢を選んでいるか(/I)の2つの情報がある -
Acrobat は
/Iを見て表示する。Chrome や Edge(pdfium)は/Vを見て表示する -
/Vだけを書き換えて/Iが古いままだと、ビューアによって表示が食い違う - pypdf の
update_page_form_field_values()を使う場合は、pypdf が/Iを削除してくれるので問題は起きない(6.19.0 で確認) - 問題が起きるのは、
/Vを自分で直接書き換えたとき。その場合は/Iも一緒に更新する
検証環境
- Windows 11
- Python 3.14 / pypdf 6.19.0
- Adobe Acrobat(64-bit)
- pypdfium2(Chrome と同じ PDF 描画エンジン pdfium の Python バインディング)
背景:プルダウンは値を2か所に持っている
PDF のフォームのプルダウンは、だいたい次のような辞書になっています。
/FT /Ch ← 選択式のフィールド
/Ff 131072 ← コンボボックス(プルダウン)であることを示すフラグ
/Opt [ ( ) (Apple) (Cherry) ] ← 選択肢の一覧
/V ( ) ← 現在の値
/I [ 0 ] ← 現在選ばれている選択肢の番号(0始まり)
/I は、PDF の仕様では複数選択のリストボックス向けの補助的な情報という位置づけです。ところが Acrobat は、コンボボックスでも /I を優先して表示に使います。
再現
検証用の PDF を作る
選択肢が「(空白)/Apple/Cherry」で、初期状態が空白(/I [0])のプルダウンを1つ持つ PDF を作ります。
検証用 PDF を作るコード(make_blank.py)
from pypdf import PdfWriter
from pypdf.generic import (DictionaryObject, NameObject, ArrayObject,
TextStringObject, NumberObject, FloatObject)
w = PdfWriter()
page = w.add_blank_page(400, 200)
field = DictionaryObject({
NameObject("/FT"): NameObject("/Ch"),
NameObject("/Ff"): NumberObject(1 << 17), # Combo
NameObject("/T"): TextStringObject("fruit"),
NameObject("/Opt"): ArrayObject([TextStringObject(s) for s in [" ", "Apple", "Cherry"]]),
NameObject("/V"): TextStringObject(" "),
NameObject("/I"): ArrayObject([NumberObject(0)]),
NameObject("/Type"): NameObject("/Annot"),
NameObject("/Subtype"): NameObject("/Widget"),
NameObject("/Rect"): ArrayObject([FloatObject(v) for v in (50, 100, 250, 125)]),
NameObject("/DA"): TextStringObject("/Helv 12 Tf 0 g"),
NameObject("/F"): NumberObject(4),
NameObject("/P"): page.indirect_reference,
})
ref = w._add_object(field)
page[NameObject("/Annots")] = ArrayObject([ref])
helv = w._add_object(DictionaryObject({
NameObject("/Type"): NameObject("/Font"),
NameObject("/Subtype"): NameObject("/Type1"),
NameObject("/BaseFont"): NameObject("/Helvetica"),
}))
w._root_object[NameObject("/AcroForm")] = DictionaryObject({
NameObject("/Fields"): ArrayObject([ref]),
NameObject("/DA"): TextStringObject("/Helv 0 Tf 0 g"),
NameObject("/DR"): DictionaryObject({
NameObject("/Font"): DictionaryObject({NameObject("/Helv"): helv})}),
})
w.write("blank.pdf")
/V だけを直接書き換える
from pypdf import PdfReader, PdfWriter
from pypdf.generic import NameObject, BooleanObject
w = PdfWriter(clone_from=PdfReader("blank.pdf"))
field = w.pages[0]["/Annots"][0].get_object()
field[NameObject("/V")] = field["/Opt"][2] # "Cherry" を直接代入(/I は [0] のまま)
w._root_object["/AcroForm"][NameObject("/NeedAppearances")] = BooleanObject(True)
w.write("v_only.pdf")
結果:ビューアによって表示が違う
| ビューア | 表示 |
|---|---|
| pdfium(Chrome / Edge と同じエンジン) | Cherry |
| Acrobat |
空欄(/I [0] が指す「(空白)」) |
Acrobat の JavaScript でフィールドを調べると、内部でも食い違っていることがわかります。
value = Cherry ← /V の値
currentValueIndices = 0 ← /I の値(空白の選択肢)
さらに、この状態のまま Acrobat で保存すると、空欄の外観(/AP)が書き込まれます。そのため、保存後は Chrome などで開いても空欄に見えるようになります。「さっきまで入っていたのに消えた」ように見えるのはこのためです。
初期状態の選択肢が空白ではない様式なら、空欄ではなく元の選択肢がそのまま表示されます。たとえば初期値が「Apple」なら、/V を Cherry にしても Acrobat には Apple と表示されます。空欄より気づきにくいので要注意です。
pypdf の標準 API なら起きない
pypdf の update_page_form_field_values() で値を入れた場合は、問題は起きません。
w.update_page_form_field_values(w.pages[0], {"fruit": "Cherry"}, auto_regenerate=False)
| 方法 | 書き込み後の /I
|
Acrobat の表示 |
|---|---|---|
update_page_form_field_values() |
削除される | Cherry |
/V を直接代入 |
[0] のまま |
空欄 |
/V を直接代入 + /I も更新 |
[2] |
Cherry |
pypdf 6.19.0 では、選択式フィールドの値を更新するときに /I を削除する処理が入っていました。/I がなければ、Acrobat は /V を使って表示します。
なぜ直接書き換えることになるのか
「標準 API を使えばいい」で済めばよいのですが、実際の様式では /V を直接書きたくなる場面があります。私の場合は、日本の官公庁系の様式 PDF で、選択肢(/Opt)が Shift_JIS(CP932)のバイト列で入っていたのがきっかけでした。
pypdf では、こうした選択肢が latin-1 の文字列に見えます。日本語の文字列を API に渡しても選択肢と一致しないため、/Opt の要素オブジェクトをそのまま /V に代入する方法を取りました。そこで /I を更新し忘れて、この問題を踏みました。
pypdf 以外のライブラリでも、低レベルの操作で /V だけを書き換えれば同じことが起きるはずです(本記事では pypdf のみ検証しています)。
対処:/V と /I をそろえて書く
/V を直接書き換えるときは、/I も同じ選択肢の番号にそろえます。古い外観(/AP)も削除し、NeedAppearances を立ててビューアに外観を作り直させます。
from pypdf import PdfReader, PdfWriter
from pypdf.generic import NameObject, ArrayObject, NumberObject, BooleanObject
def set_choice(field, wanted, decode=lambda s: s):
"""コンボボックスの /V と /I をそろえて設定する"""
for i, opt in enumerate(field["/Opt"]):
opt = opt.get_object()
# /Opt の要素は「表示文字列」か「[書き出し値, 表示文字列]」のどちらか
export = opt[0] if isinstance(opt, ArrayObject) else opt
if decode(str(export)) == wanted:
field[NameObject("/V")] = export # 元のオブジェクトをそのまま使う
field[NameObject("/I")] = ArrayObject([NumberObject(i)])
if "/AP" in field:
del field["/AP"] # 古い外観を捨てる
return i
raise ValueError(f"選択肢にありません: {wanted}")
w = PdfWriter(clone_from=PdfReader("blank.pdf"))
field = w.pages[0]["/Annots"][0].get_object()
set_choice(field, "Cherry")
w._root_object["/AcroForm"][NameObject("/NeedAppearances")] = BooleanObject(True)
w.write("fixed.pdf")
選択肢が CP932 のバイト列で入っている様式では、decode に変換関数を渡して日本語で照合します。
set_choice(field, "選択肢の文字列", decode=lambda s: s.encode("latin-1").decode("cp932"))
修正後は Acrobat でも currentValueIndices = 2 になり、「Cherry」と表示されました。
確認方法:Acrobat で /I を確かめる
Acrobat Pro の JavaScript コンソール(Ctrl + J)で、フィールドの値と選択番号を確認できます。
var f = this.getField("fruit");
console.println(f.value + " / " + f.currentValueIndices);
value と currentValueIndices が指す選択肢が一致していれば大丈夫です。
まとめ
- プルダウンの値は
/V(値)と/I(選択番号)の2か所にある -
Acrobat は
/I、Chrome / Edge は/Vを見て表示するので、片方だけ書き換えるとビューアで食い違う - pypdf の
update_page_form_field_values()を使えば/Iは自動で消える -
/Vを直接書き換えるときは、/Iもそろえて、/APを消してNeedAppearancesを立てる - 提出先が Acrobat で開く前提なら、ブラウザのプレビューだけで確認を済ませない
同じように「ブラウザでは入っているのに Acrobat では空欄」で困っている方の参考になれば幸いです。