(2026年10月29日 追記:記事どおりに再現できるよう、必要なコードと手順を追加しました)
前回(第6回)では、AI・OCRで読み取った部屋名を人が図面と見比べて確認・修正し、確認済みの一覧だけを確定させる画面を作りました。いよいよ、その一覧をExcelへ書き込みます。
第7回は、確認済みの部屋名を、既存のExcelフォーマット(テンプレート)の決まった欄へ自動で転記する処理を作ります。Pythonでの Excel 自動転記は openpyxl(Excelファイルを読み書きするPythonライブラリ)で行います。結論から言うと、ポイントは次の3つです。
- テンプレートを開いてセルの値だけを書き込み、書式・数式・罫線には触れない
- 元のテンプレートは上書きせず、別名で保存する
- 結合セル・既に値がある欄・数式の欄・不正な部屋名は、書き込む前にまとめて確認し、1件でも問題があれば何も保存しない
今回作る機能と完成イメージ
メイン画面の「6. 実行」ボタンが、ようやく動くようになります。
- 「5.」で確定した部屋名を、テンプレートのシート「部屋一覧」のC5から下へ順に書き込む
- 保存先はテンプレートと同じフォルダの
<テンプレート名>_転記_<日時>.xlsx(元のファイルは変更しない) - 書き込んだセルと保存先を完了メッセージで表示する。確認画面で確定していなければ書き込まない
部屋名とセル位置の対応は、今回は「C5から下へ順に最大10行」というコード内の簡単な規則にしています。取引先ごとに違う様式へ対応できるよう設定ファイルに外出しするのは、次回(第8回)です。
仕組みの説明:「開いて、値だけ書いて、別名で保存」
要件は「決まっている様式への転記」なので、openpyxl の load_workbook() でテンプレートを開き、決まったセルに値を入れて保存します。値だけを差し替えれば、そのセルの罫線・フォント・表示形式は残ります。ただし実際の様式には、機械的に書き込むと事故につながる要素があるため、次のように扱いを決めました。
| 状況 | 扱い | 理由 |
|---|---|---|
| 書き込み先が結合セルの左上 | 書き込む | 結合セルの値は左上のセルが持つため |
| 書き込み先が結合セルの途中 | エラー(何も保存しない) | openpyxlでは読み取り専用のセルのため |
| 書き込み先に数式がある | エラー(上書きの了承があっても書かない) | テンプレートの計算を壊さないため |
| 書き込み先に既に値がある | 上書きしてよいか画面で確認 | 消し忘れか様式の変更かを人が判断するため |
| 部屋名の先頭が「= + – @」 | エラー | 数式として扱われうるため(二重チェック) |
| 部屋数が欄の数(10行)を超える | エラー | 合計行などを上書きしないため |
| 出力先がテンプレート自身・既存のファイル | エラー | 原本や前回の結果を上書きしないため |
実装
ファイル構成(第7回時点の差分)
madori-ocr/
├ app/
│ ├ core/
│ │ └ excel_writer.py …【今回追加】テンプレートへの転記・別名保存・各種チェック
│ └ ui/
│ └ main_window.py …【今回変更】「6. 実行」を確認済みリスト→Excel出力につないだ
├ samples/
│ └ room_list_template.xlsx …【今回追加】架空の「部屋一覧」テンプレート
├ tests/
│ └ test_excel_writer.py …【今回追加】pytest 51件
├ tools/
│ └ make_sample_template.py …【今回追加】架空テンプレートの生成
├ requirements.txt …【今回変更】openpyxl==3.1.5 を追加
└ .gitignore …【今回変更】転記結果のファイル(*_転記_*.xlsx)を追跡しない
使うパッケージは openpyxl 3.1.5(2024年6月公開・MIT License)です。
📰 出典:openpyxl 3.1.5(PyPI)
架空の「部屋一覧」テンプレートを用意する(tools/make_sample_template.py)
実務の様式にありがちな要素を詰め込んだ架空のテンプレートを作り、samples/room_list_template.xlsx として置きました。結合セル・背景色・罫線・表示形式・合計の数式・入力規則・列幅・印刷範囲を含みます。Excelファイルそのものは載せず、作るスクリプト(全文は後述)と、それを動かすコマンドを示します。
# tools/make_sample_template.py(抜粋)
for row in range(FIRST_ROW, LAST_ROW + 1): # 5〜14行目が記入欄
ws[f"A{row}"] = row - FIRST_ROW + 1
ws[f"D{row}"].number_format = "0.00"
for col in "ABCDE":
ws[f"{col}{row}"].border = _BORDER
ws[f"A{TOTAL_ROW}"] = "合計面積"
ws.merge_cells(f"A{TOTAL_ROW}:C{TOTAL_ROW}")
ws[f"D{TOTAL_ROW}"] = f"=SUM(D{FIRST_ROW}:D{LAST_ROW})"
ws[f"A{COUNT_ROW}"] = "部屋数"
ws.merge_cells(f"A{COUNT_ROW}:C{COUNT_ROW}")
ws[f"D{COUNT_ROW}"] = f"=COUNTA(C{FIRST_ROW}:C{LAST_ROW})"
書き込み先を決める:C5から下へ順に(app/core/excel_writer.py)
確定した一覧は図面を読む順に並んでいるので、その順にC5・C6・C7…と割り当てます。欄の数を超える場合はエラーにします。
# app/core/excel_writer.py(抜粋)
DEFAULT_SHEET_NAME = "部屋一覧"
DEFAULT_START_CELL = "C5"
DEFAULT_MAX_ROWS = 10
def assign_cells(names, *, start_cell=DEFAULT_START_CELL, max_rows=DEFAULT_MAX_ROWS) -> list[CellAssignment]:
try:
column, first_row = coordinate_from_string(start_cell.upper())
except (CellCoordinatesException, ValueError):
raise ExcelWriteError(f"書き込み開始セルの指定が不正です: {start_cell}") from None
if len(names) > max_rows:
raise ExcelWriteError(
f"部屋名が{len(names)}件あり、テンプレートの記入欄({column}{first_row}から{max_rows}行)に収まりません。"
)
return [CellAssignment(cell=f"{column}{first_row + i}", name=name) for i, name in enumerate(names)]
この関数は次回、設定ファイルを読む処理に置き換えます。書き込み本体は「どのセルに何を書くか」のリストを受け取るだけなので、影響は小さく済みます。
書き込む直前にも「= + – @」をチェックする
第6回の確認画面で拒否した先頭の「=」「+」「-」「@」を、書き込む直前にも同じ基準でチェックします。確認画面を通らない経路(将来の一括処理など)から呼ばれても安全側に倒すためです。全角の「=」もNFKC正規化で「=」になるため拒否します。
# app/core/excel_writer.py(抜粋)
from app.core.review_model import FORMULA_PREFIXES, MAX_NAME_LENGTH, ReviewedRoom
def check_cell_text(text: str) -> str:
normalized = unicodedata.normalize("NFKC", text).strip()
if not normalized:
raise ExcelWriteError("空の部屋名は書き込めません。")
if len(normalized) > MAX_NAME_LENGTH:
raise ExcelWriteError(f"部屋名が{MAX_NAME_LENGTH}文字を超えています: {normalized[:MAX_NAME_LENGTH]}…")
if any(unicodedata.category(ch).startswith("C") for ch in text):
raise ExcelWriteError(f"部屋名に改行・タブなどの制御文字が含まれています: {text!r}")
if text.lstrip().startswith(FORMULA_PREFIXES) or normalized.startswith(FORMULA_PREFIXES):
raise ExcelWriteError(
f"部屋名「{text}」は先頭が「=」「+」「-」「@」のため書き込めません(Excelで数式として扱われうるため)。"
)
return text
openpyxl 3.1.5で試すと、数式(data_type が f)になるのは先頭が「=」の文字列だけで、「+1」「@A1」などは文字列のまま保存されました。それでも4文字とも拒否するのは、CSVへの書き出しや人による再編集で数式として解釈されうるためです。
書き込み先のセルを全件確認してから書く
結合セル・数式・既存の値は、書き込みを始める前に全件確認し、「半分だけ書いたファイル」ができるのを防ぎます。
# app/core/excel_writer.py(抜粋)
def _check_targets(worksheet, assignments, *, overwrite: bool) -> list[str]:
not_empty: list[str] = []
for assignment in assignments:
cell = worksheet[assignment.cell]
if isinstance(cell, MergedCell): # 結合セルの左上以外
merged = _merged_range_of(worksheet, assignment.cell) or "不明"
top_left = merged.split(":")[0]
raise ExcelWriteError(
f"{assignment.cell} は結合セル({merged})の途中のため書き込めません。"
f"結合の左上({top_left})を指定するか、テンプレートの結合を見直してください。"
)
if cell.data_type == "f" or (isinstance(cell.value, str) and cell.value.startswith("=")):
raise ExcelWriteError(f"{assignment.cell} には数式が入っているため書き込みません(テンプレートの数式を守るため)。")
if cell.value is not None and cell.value != "":
not_empty.append(assignment.cell)
if not_empty and not overwrite:
raise CellNotEmptyError(f"書き込み先のセルに既に値が入っています: {'、'.join(not_empty)}", cells=not_empty)
return not_empty
openpyxlでは結合セルの左上以外は読み取り専用の MergedCell で、代入すると英語のエラーになります。事前に見分けて、原因の結合範囲を日本語で伝えます。
テンプレートの開き方と、別名での保存
書き込み本体は、パスの確認→部屋名のチェック→セルの割り当て→テンプレートを開く→書き込み先の確認→書き込み→保存、の順です。
# app/core/excel_writer.py(抜粋)
def write_rooms_to_excel(template_path, rooms, *, output_path=None, sheet_name=DEFAULT_SHEET_NAME,
start_cell=DEFAULT_START_CELL, max_rows=DEFAULT_MAX_ROWS,
overwrite=False) -> ExcelWriteResult:
template = Path(template_path)
output = Path(output_path) if output_path is not None else default_output_path(template)
_check_paths(template, output) # 原本と同じパス・既存ファイル・拡張子違いを拒否
names = [check_cell_text(room.name) for room in rooms]
if not names:
raise ExcelWriteError("書き込む部屋名がありません。")
assignments = assign_cells(names, start_cell=start_cell, max_rows=max_rows)
workbook = _load_template(template)
try:
worksheet = _get_sheet(workbook, sheet_name)
overwritten = _check_targets(worksheet, assignments, overwrite=overwrite)
for assignment in assignments:
cell = worksheet[assignment.cell]
cell.value = assignment.name
if cell.data_type != "s":
raise ExcelWriteError(f"{assignment.cell} が文字列として書き込まれませんでした。")
_save_atomically(workbook, output) # 一時ファイルに保存してから名前を変える
finally:
workbook.close()
return ExcelWriteResult(template_path=template, output_path=output, sheet_name=sheet_name,
assignments=assignments, overwritten=overwritten)
テンプレートの開き方には、openpyxlの既定のままだと様式を壊す落とし穴が3つあります。
# app/core/excel_writer.py(抜粋)
def _load_template(template: Path) -> Workbook:
# - data_only=False(既定)で開く。Trueにすると数式の代わりに前回の計算結果が読み込まれ、
# そのまま保存すると数式が消える(計算結果の値、または結果が無ければ空欄になる)。
# - rich_text=True で開く。既定(False)では、セル内の一部だけ太字・色付きにした文字が
# 保存時にただの文字列になってしまう(openpyxl 3.1.5で確認)。
# - .xlsm は keep_vba=True で開く。既定ではマクロ(vbaProject.bin)が保存時に消える。
keep_vba = template.suffix.lower() == MACRO_ENABLED_SUFFIX
try:
return load_workbook(template, keep_vba=keep_vba, rich_text=True)
except (InvalidFileException, zipfile.BadZipFile, KeyError, OSError) as exc:
raise ExcelWriteError(f"Excelテンプレートを開けません(壊れているか、Excel形式ではありません): {template.name}") from exc
3つとも、既定のままだと消えることを実際に保存・読み戻して確かめました(引数の意味は load_workbook() の説明文で確認)。
出力ファイル名は日時入りの別名で、同名があれば _2、_3 と番号を付けます。拡張子はテンプレートにそろえます(.xlsmの中身を .xlsx の名前で保存すると食い違うため)。
# app/core/excel_writer.py(抜粋)
def default_output_path(template_path, *, now: datetime | None = None) -> Path:
template = Path(template_path)
stamp = (now or datetime.now()).strftime("%Y%m%d-%H%M%S")
base = f"{template.stem}_{OUTPUT_LABEL}_{stamp}" # OUTPUT_LABEL = "転記"
candidate = template.with_name(f"{base}{template.suffix}")
counter = 2
while candidate.exists():
candidate = template.with_name(f"{base}_{counter}{template.suffix}")
counter += 1
return candidate
「6. 実行」ボタンを転記につなぐ(app/ui/main_window.py)
画面側は、確定済みかを確かめてコア処理を呼び、結果を表示するだけです。記入欄に値が残っていた場合だけ上書きしてよいかを聞きます(既定は「いいえ」)。
# app/ui/main_window.py(抜粋)
def _on_run(self) -> None:
template = self.selected.excel_path
if template is None:
return
if self.reviewed_rooms is None:
messagebox.showwarning(
"部屋名の確認が済んでいません",
"先に「4.」で部屋名候補を絞り込み、「5.」の確認画面で確定してください。",
detail="AI・OCRの読み取り結果を、人の確認を通さずにExcelへ書き込まないためです。",
)
return
try:
result = write_rooms_to_excel(template, self.reviewed_rooms)
except CellNotEmptyError as exc:
if not messagebox.askyesno("記入欄に値が入っています", str(exc),
detail="上書きして転記しますか?(元のテンプレートは変更しません。数式の欄は上書きしません)",
icon="warning", default="no"):
self.status_var.set("転記を取りやめました(ファイルは作成していません)。")
return
result = self._write_excel(template, overwrite=True)
except ExcelWriteError as exc:
messagebox.showerror("Excel転記エラー", str(exc))
return
if result is None:
return
messagebox.showinfo("Excelへ転記しました",
f"{len(result.assignments)}件の部屋名を書き込み、別名で保存しました。",
detail=describe_result(result))
この回で追加・変更するファイル
Excelの読み書きにopenpyxlを追加します。
requirements.txt に次の変更を加えます(+ が追加、- が削除)。
--- a/requirements.txt
+++ b/requirements.txt
@@ -26,3 +26,7 @@ Pillow==12.1.0
# 読む(.env.example 参照。実際のキーはリポジトリに含めない)。外部AIは画面で明示的に
# 選んだときだけ使い、既定はローカル完結。
anthropic==0.77.0
+
+# 第7回〜:Excelテンプレート(既存の様式)を開き、決まったセルへ部屋名を書き込む(import openpyxl。
+# 3.1.5は2024-06-28公開・MIT License)。書式・数式はそのまま残し、値だけを書き込んで別名で保存する。
+openpyxl==3.1.5
pip install openpyxl==3.1.5
架空の「部屋一覧」テンプレートを作るスクリプトです。samples フォルダは自動で作られます。
tools/make_sample_template.py を新しく作ります(全文)。
tools/make_sample_template.py の全文(116行)
# tools/make_sample_template.py
"""架空の「部屋一覧」Excelテンプレート(第7回の転記先)を生成するスクリプト。
実在の取引先・社内の様式ではなく、連載の動作確認用に作った架空の様式。
「既存の指定フォーマットへ転記する」ことを確かめるため、実務の様式に
ありがちな要素をひととおり入れてある。
- 見出し(結合セル・太字・背景色)と、記入欄の罫線
- 物件名などの手入力欄(結合セル)
- 面積の列の表示形式(小数2桁)と、合計・部屋数の数式(`=SUM()`・`=COUNTA()`)
- 列幅・行の高さ・印刷範囲(横1ページに収める)・ウィンドウ枠の固定
- 入力規則(「階」の列はリストから選ぶ)
転記先は「部屋名」の列(C5〜C14の10行)。第7回ではこの位置をコード内で
上から順に割り当てる(`app/core/excel_writer.py`)。
使い方:
python3 tools/make_sample_template.py [<出力先.xlsx>]
(省略時は samples/room_list_template.xlsx)
"""
from __future__ import annotations
import sys
from pathlib import Path
from openpyxl import Workbook
from openpyxl.styles import Alignment, Border, Font, PatternFill, Side
from openpyxl.worksheet.datavalidation import DataValidation
SHEET_NAME = "部屋一覧"
FIRST_ROW = 5
ROW_COUNT = 10
LAST_ROW = FIRST_ROW + ROW_COUNT - 1 # 14
TOTAL_ROW = LAST_ROW + 1 # 15
COUNT_ROW = LAST_ROW + 2 # 16
DEFAULT_OUTPUT = Path(__file__).resolve().parents[1] / "samples" / "room_list_template.xlsx"
_THIN = Side(style="thin", color="000000")
_BORDER = Border(left=_THIN, right=_THIN, top=_THIN, bottom=_THIN)
_HEADER_FILL = PatternFill(fill_type="solid", start_color="DDEBF7", end_color="DDEBF7")
_TOTAL_FILL = PatternFill(fill_type="solid", start_color="F2F2F2", end_color="F2F2F2")
def build_template() -> Workbook:
"""架空の「部屋一覧」テンプレートのブックを作って返す(保存はしない)。"""
wb = Workbook()
ws = wb.active
ws.title = SHEET_NAME
ws["A1"] = "部屋一覧表(架空の様式・連載の動作確認用)"
ws["A1"].font = Font(size=14, bold=True)
ws.merge_cells("A1:E1")
ws["A2"] = "物件名"
ws["A2"].font = Font(bold=True)
ws.merge_cells("B2:E2") # 物件名は人が手で入れる欄
for col in "ABCDE":
ws[f"{col}2"].border = _BORDER
headers = ["No.", "階", "部屋名", "面積(㎡)", "備考"]
for col, text in zip("ABCDE", headers, strict=True):
cell = ws[f"{col}4"]
cell.value = text
cell.font = Font(bold=True)
cell.fill = _HEADER_FILL
cell.border = _BORDER
cell.alignment = Alignment(horizontal="center", vertical="center")
for row in range(FIRST_ROW, LAST_ROW + 1):
ws[f"A{row}"] = row - FIRST_ROW + 1
ws[f"A{row}"].alignment = Alignment(horizontal="center")
ws[f"D{row}"].number_format = "0.00"
for col in "ABCDE":
ws[f"{col}{row}"].border = _BORDER
ws[f"A{TOTAL_ROW}"] = "合計面積"
ws.merge_cells(f"A{TOTAL_ROW}:C{TOTAL_ROW}")
ws[f"D{TOTAL_ROW}"] = f"=SUM(D{FIRST_ROW}:D{LAST_ROW})"
ws[f"D{TOTAL_ROW}"].number_format = "0.00"
ws[f"A{COUNT_ROW}"] = "部屋数"
ws.merge_cells(f"A{COUNT_ROW}:C{COUNT_ROW}")
ws[f"D{COUNT_ROW}"] = f"=COUNTA(C{FIRST_ROW}:C{LAST_ROW})"
for row in (TOTAL_ROW, COUNT_ROW):
ws[f"A{row}"].font = Font(bold=True)
ws[f"A{row}"].alignment = Alignment(horizontal="right")
for col in "ABCDE":
ws[f"{col}{row}"].border = _BORDER
ws[f"{col}{row}"].fill = _TOTAL_FILL
floors = DataValidation(type="list", formula1='"1階,2階,3階"', allow_blank=True)
floors.add(f"B{FIRST_ROW}:B{LAST_ROW}")
ws.add_data_validation(floors)
for col, width in zip("ABCDE", (6, 8, 20, 12, 16), strict=True):
ws.column_dimensions[col].width = width
ws.row_dimensions[1].height = 24
ws.freeze_panes = "A5"
ws.print_area = f"A1:E{COUNT_ROW}"
ws.page_setup.orientation = "portrait"
ws.page_setup.fitToWidth = 1
ws.page_setup.fitToHeight = 0
ws.sheet_properties.pageSetUpPr.fitToPage = True
return wb
def main(argv: list[str]) -> None:
out = Path(argv[1]) if len(argv) > 1 else DEFAULT_OUTPUT
out.parent.mkdir(parents=True, exist_ok=True)
build_template().save(out)
print(f"保存しました: {out}")
if __name__ == "__main__":
main(sys.argv)
python tools/make_sample_template.py
これで samples/room_list_template.xlsx ができます。テストもこのファイルを使います。
転記の本体(上で抜粋した app/core/excel_writer.py)の全体です。
app/core/excel_writer.py を新しく作ります(全文)。
app/core/excel_writer.py の全文(296行)
# app/core/excel_writer.py
"""確認済みの部屋名を、指定のExcelフォーマット(テンプレート)の決まった欄へ転記するコア処理。
第6回の確認画面で確定した一覧(`ReviewedRoom` のリスト)を受け取り、openpyxlで
既存のテンプレートを開いて、決まったセルへ部屋名を「値だけ」書き込み、
**元のテンプレートとは別のファイル名で**保存する。
書き込み先のセル(部屋名とセル位置の対応)は、まずは「シート『部屋一覧』のC5から
下へ順に、最大10行」という簡単な決め方にしている(`assign_cells()`)。取引先ごとに
様式が違う場合に設定ファイルで変えられるようにするのは第8回で扱う。
書き込みの前に、次のことを全件まとめて確認し、1件でも問題があれば
何も書き込まずに `ExcelWriteError` を送出する(途中まで書いたファイルを残さない)。
- 部屋名の先頭が「=」「+」「-」「@」でないか(確認画面に続く二重チェック)
- 書き込み先が結合セルの途中(左上以外)でないか
- 書き込み先に数式が入っていないか(数式は上書きしない)
- 書き込み先に既に値が入っていないか(`overwrite=True` のときだけ上書きする)
- 部屋の数がテンプレートの欄の数を超えていないか
tkinterに依存しないため、pytestで「書き込んだセル以外の値・書式・数式が
変わっていないこと」を読み戻して検証できる(`tests/test_excel_writer.py`)。
"""
from __future__ import annotations
import os
import unicodedata
import zipfile
from collections.abc import Sequence
from dataclasses import dataclass
from datetime import datetime
from pathlib import Path
from openpyxl import Workbook, load_workbook
from openpyxl.cell.cell import MergedCell
from openpyxl.utils.cell import coordinate_from_string
from openpyxl.utils.exceptions import CellCoordinatesException, InvalidFileException
from openpyxl.worksheet.worksheet import Worksheet
from app.core.review_model import FORMULA_PREFIXES, MAX_NAME_LENGTH, ReviewedRoom
#: 転記先のシート名・書き込み開始セル・記入欄の行数(架空テンプレート `samples/room_list_template.xlsx` に合わせた既定)
DEFAULT_SHEET_NAME = "部屋一覧"
DEFAULT_START_CELL = "C5"
DEFAULT_MAX_ROWS = 10
#: 既定の出力ファイル名に付ける文字(例:room_list_template_転記_20260209-100000.xlsx)
OUTPUT_LABEL = "転記"
#: マクロ付きブックの拡張子。マクロ(vbaProject.bin)を残したまま読み書きする
MACRO_ENABLED_SUFFIX = ".xlsm"
class ExcelWriteError(ValueError):
"""Excelテンプレートへの転記を行えない場合の例外(何も書き込まれていない)。"""
class CellNotEmptyError(ExcelWriteError):
"""書き込み先のセルに既に値が入っている場合の例外(上書きするかを利用者に確認する)。"""
def __init__(self, message: str, cells: list[str]) -> None:
super().__init__(message)
self.cells = cells
@dataclass(frozen=True)
class CellAssignment:
"""部屋名1件の書き込み先(セル番地と書き込む値)。"""
cell: str
name: str
@dataclass(frozen=True)
class ExcelWriteResult:
"""転記の結果(完了メッセージ・作業記録に使う)。"""
template_path: Path
output_path: Path
sheet_name: str
assignments: list[CellAssignment]
#: 既に値が入っていて上書きしたセル(`overwrite=True` のときだけ)
overwritten: list[str]
def check_cell_text(text: str) -> str:
"""セルへ書き込む直前の部屋名チェック(確認画面の `validate_name()` との二重チェック)。
確認画面を通らない経路(将来の一括処理やテストコード等)から呼ばれても、
数式として扱われうる文字列や制御文字を書き込まないよう、ここでも同じ基準で拒否する。
全角の「=」などもNFKC正規化すると「=」になるため、正規化後の文字列でも確認する。
"""
if not isinstance(text, str):
raise ExcelWriteError(f"部屋名が文字列ではありません: {text!r}")
normalized = unicodedata.normalize("NFKC", text).strip()
if not normalized:
raise ExcelWriteError("空の部屋名は書き込めません。")
if len(normalized) > MAX_NAME_LENGTH:
raise ExcelWriteError(f"部屋名が{MAX_NAME_LENGTH}文字を超えています: {normalized[:MAX_NAME_LENGTH]}…")
if any(unicodedata.category(ch).startswith("C") for ch in text):
raise ExcelWriteError(f"部屋名に改行・タブなどの制御文字が含まれています: {text!r}")
if text.lstrip().startswith(FORMULA_PREFIXES) or normalized.startswith(FORMULA_PREFIXES):
raise ExcelWriteError(
f"部屋名「{text}」は先頭が「=」「+」「-」「@」のため書き込めません(Excelで数式として扱われうるため)。"
)
return text
def assign_cells(
names: Sequence[str],
*,
start_cell: str = DEFAULT_START_CELL,
max_rows: int = DEFAULT_MAX_ROWS,
) -> list[CellAssignment]:
"""部屋名を上から順に、`start_cell` から同じ列の下方向のセルへ割り当てる。
例:`["居間", "寝室1"]` → C5=居間、C6=寝室1。確認画面で確定した一覧は図面を読む順
(上→下、左→右)に並んでいるので、その順に割り当てる。欄の数を超える場合はエラー。
この決め方は第8回で設定ファイル(YAML)に置き換える。
"""
if max_rows < 1:
raise ExcelWriteError(f"記入欄の行数が不正です: {max_rows}")
try:
column, first_row = coordinate_from_string(start_cell.upper())
except (CellCoordinatesException, ValueError):
raise ExcelWriteError(f"書き込み開始セルの指定が不正です: {start_cell}") from None
if len(names) > max_rows:
raise ExcelWriteError(
f"部屋名が{len(names)}件あり、テンプレートの記入欄({column}{first_row}から{max_rows}行)に収まりません。"
)
return [CellAssignment(cell=f"{column}{first_row + i}", name=name) for i, name in enumerate(names)]
def default_output_path(template_path: str | Path, *, now: datetime | None = None) -> Path:
"""既定の出力先。テンプレートと同じフォルダに、日時入りの別名で作る。
例:`部屋一覧.xlsx` → `部屋一覧_転記_20260209-100000.xlsx`(拡張子はテンプレートと同じ)。
同じ名前のファイルが既にあれば `_2`、`_3`…を付けて、既存のファイルを上書きしない。
"""
template = Path(template_path)
stamp = (now or datetime.now()).strftime("%Y%m%d-%H%M%S")
base = f"{template.stem}_{OUTPUT_LABEL}_{stamp}"
candidate = template.with_name(f"{base}{template.suffix}")
counter = 2
while candidate.exists():
candidate = template.with_name(f"{base}_{counter}{template.suffix}")
counter += 1
return candidate
def write_rooms_to_excel(
template_path: str | Path,
rooms: Sequence[ReviewedRoom],
*,
output_path: str | Path | None = None,
sheet_name: str = DEFAULT_SHEET_NAME,
start_cell: str = DEFAULT_START_CELL,
max_rows: int = DEFAULT_MAX_ROWS,
overwrite: bool = False,
) -> ExcelWriteResult:
"""確認済みの部屋名をテンプレートの決まった欄へ書き込み、別名で保存する。
- 書き込み先は `sheet_name` のシートの `start_cell` から下へ順に(最大 `max_rows` 行)
- `output_path` を省略すると `default_output_path()` の名前で保存する
- 元のテンプレートと同じパス・既に存在するファイルには保存しない
- 書き込むのはセルの値だけ。書式・数式・結合・列幅などには触れない
- 既に値が入っている欄があれば `CellNotEmptyError`(`overwrite=True` なら上書き。
ただし数式が入っているセルは `overwrite` に関係なく上書きしない)
"""
template = Path(template_path)
output = Path(output_path) if output_path is not None else default_output_path(template)
_check_paths(template, output)
names = [check_cell_text(room.name) for room in rooms]
if not names:
raise ExcelWriteError("書き込む部屋名がありません。")
assignments = assign_cells(names, start_cell=start_cell, max_rows=max_rows)
workbook = _load_template(template)
try:
worksheet = _get_sheet(workbook, sheet_name)
overwritten = _check_targets(worksheet, assignments, overwrite=overwrite)
for assignment in assignments:
cell = worksheet[assignment.cell]
cell.value = assignment.name
if cell.data_type != "s": # 念のため:文字列以外(数式など)として扱われていないか
raise ExcelWriteError(f"{assignment.cell} が文字列として書き込まれませんでした。")
_save_atomically(workbook, output)
finally:
workbook.close()
return ExcelWriteResult(
template_path=template,
output_path=output,
sheet_name=sheet_name,
assignments=assignments,
overwritten=overwritten,
)
def describe_result(result: ExcelWriteResult) -> str:
"""完了メッセージの本文(どのセルに何を書いたか・保存先)を組み立てる。"""
lines = [
f"保存先:{result.output_path}",
f"元のテンプレート:{result.template_path.name}(変更していません)",
f"シート:{result.sheet_name}",
"",
]
for assignment in result.assignments:
mark = "(上書き)" if assignment.cell in result.overwritten else ""
lines.append(f"{assignment.cell}:{assignment.name}{mark}")
return "\n".join(lines)
def _check_paths(template: Path, output: Path) -> None:
if not template.is_file():
raise ExcelWriteError(f"Excelテンプレートが見つかりません: {template}")
if output.suffix.lower() != template.suffix.lower():
# .xlsm(マクロ付き)を .xlsx の名前で保存すると、中身と拡張子が食い違い
# Excelで開けなくなるため、拡張子はテンプレートにそろえる
raise ExcelWriteError(
f"出力ファイルの拡張子({output.suffix})をテンプレート({template.suffix})と同じにしてください。"
)
if output.resolve() == template.resolve():
raise ExcelWriteError("元のテンプレートには上書き保存できません。別のファイル名を指定してください。")
if output.exists():
raise ExcelWriteError(f"出力先に同じ名前のファイルが既にあります: {output}")
if not output.parent.is_dir():
raise ExcelWriteError(f"出力先のフォルダが見つかりません: {output.parent}")
def _load_template(template: Path) -> Workbook:
# - data_only=False(既定)で開く。Trueにすると数式の代わりに前回の計算結果が読み込まれ、
# そのまま保存すると数式が消える(計算結果の値、または結果が無ければ空欄になる)。
# - rich_text=True で開く。既定(False)では、セル内の一部だけ太字・色付きにした文字が
# 保存時にただの文字列になってしまう(openpyxl 3.1.5で確認)。
# - .xlsm は keep_vba=True で開く。既定ではマクロ(vbaProject.bin)が保存時に消える。
keep_vba = template.suffix.lower() == MACRO_ENABLED_SUFFIX
try:
return load_workbook(template, keep_vba=keep_vba, rich_text=True)
except (InvalidFileException, zipfile.BadZipFile, KeyError, OSError) as exc:
raise ExcelWriteError(f"Excelテンプレートを開けません(壊れているか、Excel形式ではありません): {template.name}") from exc
def _get_sheet(workbook: Workbook, sheet_name: str) -> Worksheet:
if sheet_name not in workbook.sheetnames:
available = "、".join(workbook.sheetnames)
raise ExcelWriteError(f"シート「{sheet_name}」がテンプレートにありません(あるシート:{available})。")
return workbook[sheet_name]
def _merged_range_of(worksheet: Worksheet, coordinate: str) -> str | None:
for merged in worksheet.merged_cells.ranges:
if coordinate in merged:
return merged.coord
return None
def _check_targets(worksheet: Worksheet, assignments: list[CellAssignment], *, overwrite: bool) -> list[str]:
"""書き込み先を全件確認し、上書きになるセルの番地を返す(問題があれば例外。まだ何も書かない)。"""
not_empty: list[str] = []
for assignment in assignments:
cell = worksheet[assignment.cell]
if isinstance(cell, MergedCell):
merged = _merged_range_of(worksheet, assignment.cell) or "不明"
top_left = merged.split(":")[0]
raise ExcelWriteError(
f"{assignment.cell} は結合セル({merged})の途中のため書き込めません。"
f"結合の左上({top_left})を指定するか、テンプレートの結合を見直してください。"
)
if cell.data_type == "f" or (isinstance(cell.value, str) and cell.value.startswith("=")):
raise ExcelWriteError(f"{assignment.cell} には数式が入っているため書き込みません(テンプレートの数式を守るため)。")
if cell.value is not None and cell.value != "":
not_empty.append(assignment.cell)
if not_empty and not overwrite:
raise CellNotEmptyError(
f"書き込み先のセルに既に値が入っています: {'、'.join(not_empty)}",
cells=not_empty,
)
return not_empty
def _save_atomically(workbook: Workbook, output: Path) -> None:
"""一時ファイルに保存してから名前を変える(途中で失敗しても壊れたファイルを残さない)。"""
temp = output.with_name(f"~{output.stem}.tmp{output.suffix}")
try:
workbook.save(temp)
os.replace(temp, output)
except PermissionError as exc:
raise ExcelWriteError(
f"保存できませんでした(同じ名前のファイルをExcelで開いていないか確認してください): {output}"
) from exc
except OSError as exc:
raise ExcelWriteError(f"保存できませんでした: {output}({exc})") from exc
finally:
if temp.exists():
temp.unlink()
メイン画面の「6. 実行」を、確認済みの一覧からExcelへの転記につなぎます。
app/ui/main_window.py に次の変更を加えます(+ が追加、- が削除)。
app/ui/main_window.py の差分(110行)
--- a/app/ui/main_window.py
+++ b/app/ui/main_window.py
@@ -24,13 +24,25 @@ AI(Anthropic Claude)へ送り、部屋名だけをJSONで受け取る。送
部屋名候補を `app/core/review_model.py` の確認用一覧に変換し、
`app/ui/review_dialog.py` の確認画面で人が1件ずつ確認・修正する。確定した
一覧(確認済みリスト)は `self.reviewed_rooms` に保持する。
+第7回では、「6. 実行」ボタンを `app/core/excel_writer.py` につないだ。確認済みリストを
+選んだExcelテンプレートの決まった欄(シート「部屋一覧」のC5から下へ順に)へ書き込み、
+元のテンプレートは変えずに、同じフォルダへ日時入りの別名で保存する。確認画面で
+確定していない場合は書き込まない(AI・OCRの結果を人の確認なしに転記しないため)。
"""
from __future__ import annotations
import tkinter as tk
+from pathlib import Path
from tkinter import filedialog, messagebox, ttk
+from app.core.excel_writer import (
+ CellNotEmptyError,
+ ExcelWriteError,
+ ExcelWriteResult,
+ describe_result,
+ write_rooms_to_excel,
+)
from app.core.file_selection import FileSelectionError, SelectedFiles, validate_excel_path, validate_pdf_path
from app.core.ocr_ai import (
SEND_CONFIRMATION_TITLE,
@@ -155,7 +167,7 @@ class MainWindow(ttk.Frame):
self.review_button.grid(row=7, column=0, columnspan=2, sticky="ew", pady=(4, 4))
self.run_button = ttk.Button(
- self, text="6. 実行(Excelへの転記は次回実装します)", command=self._on_run, state="disabled"
+ self, text="6. 実行(確認済みの部屋名をExcelへ転記し、別名で保存)", command=self._on_run, state="disabled"
)
self.run_button.grid(row=8, column=0, columnspan=2, sticky="ew", pady=(4, 12))
@@ -204,7 +216,7 @@ class MainWindow(ttk.Frame):
def _refresh_run_button(self) -> None:
if self.selected.is_ready():
self.run_button.configure(state="normal")
- self.status_var.set("PDFとExcelを選択しました。「4.」で部屋名候補を絞り込み、「5.」で確認してください。")
+ self.status_var.set("PDFとExcelを選択しました。「4.」「5.」で部屋名を確認してから「6.」で転記します。")
else:
self.run_button.configure(state="disabled")
@@ -393,17 +405,58 @@ class MainWindow(ttk.Frame):
return
self.reviewed_rooms = rooms
names = "、".join(room.name for room in rooms) or "なし"
- self.status_var.set(f"確認済みの部屋名 {len(rooms)}件:{names}(Excelへの転記は第7回で実装します)")
+ self.status_var.set(f"確認済みの部屋名 {len(rooms)}件:{names}(「6.」でExcelへ転記できます)")
def _on_run(self) -> None:
- """実行ボタン。確認済みの部屋名をExcelへ転記する処理は第7回で実装する。"""
+ """確認済みの部屋名を、選んだExcelテンプレートの決まった欄へ転記する(第7回)。
+
+ 1. 「5.」の確認画面で確定していなければ書き込まない
+ 2. `write_rooms_to_excel()` で書き込み、テンプレートと同じフォルダへ別名で保存する
+ 3. 記入欄に既に値があった場合だけ、上書きしてよいかを確認してからやり直す
+ (数式が入った欄はコア処理側で常に拒否される)
+ """
+ template = self.selected.excel_path
+ if template is None:
+ return
if self.reviewed_rooms is None:
- messagebox.showinfo("実行", "先に「4.」で部屋名候補を絞り込み、「5.」の確認画面で確定してください。")
+ messagebox.showwarning(
+ "部屋名の確認が済んでいません",
+ "先に「4.」で部屋名候補を絞り込み、「5.」の確認画面で確定してください。",
+ detail="AI・OCRの読み取り結果を、人の確認を通さずにExcelへ書き込まないためです。",
+ )
+ return
+ try:
+ result = write_rooms_to_excel(template, self.reviewed_rooms)
+ except CellNotEmptyError as exc:
+ if not messagebox.askyesno(
+ "記入欄に値が入っています",
+ str(exc),
+ detail="上書きして転記しますか?(元のテンプレートは変更しません。数式の欄は上書きしません)",
+ icon="warning",
+ default="no",
+ ):
+ self.status_var.set("転記を取りやめました(ファイルは作成していません)。")
+ return
+ result = self._write_excel(template, overwrite=True)
+ except ExcelWriteError as exc:
+ messagebox.showerror("Excel転記エラー", str(exc))
+ return
+ if result is None:
return
- names = "、".join(room.name for room in self.reviewed_rooms) or "なし"
messagebox.showinfo(
- "実行", f"確認済みの部屋名:{names}", detail="Excelテンプレートへの転記は次回(第7回)で実装します。"
+ "Excelへ転記しました",
+ f"{len(result.assignments)}件の部屋名を書き込み、別名で保存しました。",
+ detail=describe_result(result),
)
+ self.status_var.set(f"Excelへ転記しました:{result.output_path.name}(元のテンプレートは変更していません)")
+
+ def _write_excel(self, template: Path, *, overwrite: bool) -> ExcelWriteResult | None:
+ """書き込みを実行し、失敗したらエラーダイアログを出して `None` を返す。"""
+ try:
+ return write_rooms_to_excel(template, self.reviewed_rooms or [], overwrite=overwrite)
+ except ExcelWriteError as exc:
+ messagebox.showerror("Excel転記エラー", str(exc))
+ return None
def build_main_window(master: tk.Tk) -> MainWindow:
転記の結果として作られるファイルをGitで追跡しないようにします。
.gitignore に次の変更を加えます(+ が追加、- が削除)。
--- a/.gitignore
+++ b/.gitignore
@@ -13,6 +13,9 @@ __pycache__/
# 転記結果として生成されるExcelファイル(原本テンプレートは残し、出力先は追跡しない)
output/
*.out.xlsx
+# 第7回の既定の出力ファイル名(<テンプレート名>_転記_<日時>.xlsx / .xlsm)
+*_転記_*.xlsx
+*_転記_*.xlsm
# ローカル設定・秘密情報(APIキー等はkeyring経由で保存し、.envに実値を書かない)
.env
転記のテストです。テンプレートを一時フォルダへ作って書き込み、読み戻して「書いたセル以外の値・書式・数式が変わっていないこと」「元のテンプレートが1バイトも変わっていないこと」などを確かめます。
tests/test_excel_writer.py を新しく作ります(全文)。
tests/test_excel_writer.py の全文(474行)
# tests/test_excel_writer.py
"""`app.core.excel_writer` のテスト(tkinter非依存)。
架空の「部屋一覧」テンプレート(`tools/make_sample_template.py` と同じもの)を
テストごとに一時フォルダへ作り、確認済みの部屋名を書き込んだあと、出力ファイルを
openpyxlで読み戻して次のことを検証する。
- 決まったセル(C5から下へ順に)に部屋名が入ること
- それ以外のセルの値・書式・数式、結合セル・列幅・入力規則などが変わっていないこと
- 元のテンプレートのファイルが1バイトも変わっていないこと(別名で保存していること)
- 不正な部屋名・結合セルの途中・既に値のある欄・数式の欄などでは、何も保存しないこと
"""
from __future__ import annotations
import hashlib
import zipfile
from copy import copy
from datetime import datetime
from pathlib import Path
import pytest
from openpyxl import Workbook, load_workbook
from openpyxl.cell.rich_text import CellRichText, TextBlock
from openpyxl.cell.text import InlineFont
from openpyxl.drawing.image import Image as XLImage
from openpyxl.worksheet.worksheet import Worksheet
from PIL import Image
from app.core.excel_writer import (
DEFAULT_MAX_ROWS,
DEFAULT_SHEET_NAME,
CellAssignment,
CellNotEmptyError,
ExcelWriteError,
assign_cells,
check_cell_text,
default_output_path,
describe_result,
write_rooms_to_excel,
)
from app.core.review_model import SOURCE_EMBEDDED, ReviewedRoom, ReviewList
from app.core.room_matcher import RoomCandidate
from app.core.text_extractor import ExtractedWord
from tools.make_sample_template import build_template
SAMPLE_TEMPLATE = Path(__file__).resolve().parents[1] / "samples" / "room_list_template.xlsx"
NAMES = ["居間", "寝室1", "キッチン", "洗面脱衣室"]
TARGETS = {"C5", "C6", "C7", "C8"}
def _rooms(names: list[str]) -> list[ReviewedRoom]:
return [
ReviewedRoom(name=n, canonical_name=None, page_number=0, bbox=None, source=SOURCE_EMBEDDED, edited=False)
for n in names
]
def _save(wb: Workbook, path: Path) -> Path:
wb.save(path)
return path
@pytest.fixture
def template(tmp_path: Path) -> Path:
return _save(build_template(), tmp_path / "部屋一覧.xlsx")
def _sha256(path: Path) -> str:
return hashlib.sha256(path.read_bytes()).hexdigest()
def _cell_snapshot(ws: Worksheet, skip: set[str]) -> dict[str, tuple]:
"""セルごとの値・種類・表示形式・フォント・塗り・罫線・配置・保護をまとめる。
`cell.font` などはopenpyxlの `StyleProxy`(比較すると常に不一致になる)のため、
`copy()` で実体のスタイルオブジェクトにしてから比較する。
"""
snapshot: dict[str, tuple] = {}
for row in ws.iter_rows(min_row=1, max_row=max(ws.max_row, 20), min_col=1, max_col=max(ws.max_column, 8)):
for cell in row:
if cell.coordinate in skip:
continue
snapshot[cell.coordinate] = (
cell.value,
cell.data_type,
cell.number_format,
copy(cell.font),
copy(cell.fill),
copy(cell.border),
copy(cell.alignment),
copy(cell.protection),
)
return snapshot
def _sheet_settings(ws: Worksheet) -> dict[str, object]:
return {
"merged": sorted(r.coord for r in ws.merged_cells.ranges),
"widths": {k: v.width for k, v in ws.column_dimensions.items()},
"heights": {k: v.height for k, v in ws.row_dimensions.items()},
"validations": [(str(dv.sqref), dv.formula1, dv.type) for dv in ws.data_validations.dataValidation],
"freeze": ws.freeze_panes,
"print_area": ws.print_area,
"fit_to_width": ws.page_setup.fitToWidth,
}
# --- 部屋名の二重チェック ---------------------------------------------------
@pytest.mark.parametrize("name", ["=1+1", "+81", "-1", "@SUM(A1)", "=1+1", " =1", "+1"])
def test_check_cell_text_rejects_formula_prefixes(name: str) -> None:
with pytest.raises(ExcelWriteError, match="数式"):
check_cell_text(name)
@pytest.mark.parametrize("name", ["", " ", "居\n間", "居\t間", "あ" * 31])
def test_check_cell_text_rejects_empty_control_and_long(name: str) -> None:
with pytest.raises(ExcelWriteError):
check_cell_text(name)
def test_check_cell_text_accepts_normal_names() -> None:
assert check_cell_text("寝室1") == "寝室1"
assert check_cell_text("LDK") == "LDK"
# --- セルの割り当て・出力ファイル名 -------------------------------------------
def test_assign_cells_goes_down_from_c5() -> None:
assert assign_cells(["居間", "寝室1", "キッチン"]) == [
CellAssignment("C5", "居間"),
CellAssignment("C6", "寝室1"),
CellAssignment("C7", "キッチン"),
]
def test_assign_cells_accepts_other_start_cell() -> None:
assert [a.cell for a in assign_cells(["a", "b"], start_cell="e10")] == ["E10", "E11"]
def test_assign_cells_rejects_more_rooms_than_rows() -> None:
assign_cells(["x"] * DEFAULT_MAX_ROWS) # ちょうど10件は収まる
with pytest.raises(ExcelWriteError, match="収まりません"):
assign_cells(["x"] * (DEFAULT_MAX_ROWS + 1))
@pytest.mark.parametrize("start", ["", "5C", "C0", "セル"])
def test_assign_cells_rejects_invalid_start_cell(start: str) -> None:
with pytest.raises(ExcelWriteError, match="開始セル"):
assign_cells(["居間"], start_cell=start)
def test_default_output_path_is_next_to_template_with_timestamp(tmp_path: Path) -> None:
template = tmp_path / "部屋一覧.xlsx"
path = default_output_path(template, now=datetime(2026, 2, 9, 10, 0, 0))
assert path == tmp_path / "部屋一覧_転記_20260209-100000.xlsx"
def test_default_output_path_does_not_reuse_existing_name(tmp_path: Path) -> None:
now = datetime(2026, 2, 9, 10, 0, 0)
(tmp_path / "部屋一覧_転記_20260209-100000.xlsx").write_bytes(b"")
(tmp_path / "部屋一覧_転記_20260209-100000_2.xlsx").write_bytes(b"")
assert default_output_path(tmp_path / "部屋一覧.xlsx", now=now).name == "部屋一覧_転記_20260209-100000_3.xlsx"
def test_default_output_path_keeps_xlsm_suffix(tmp_path: Path) -> None:
path = default_output_path(tmp_path / "様式.xlsm", now=datetime(2026, 2, 9))
assert path.suffix == ".xlsm"
# --- 書き込みと読み戻し -------------------------------------------------------
def test_write_puts_names_from_c5_downward(template: Path) -> None:
result = write_rooms_to_excel(template, _rooms(NAMES))
assert result.output_path.parent == template.parent
assert result.output_path.name.startswith("部屋一覧_転記_")
assert [(a.cell, a.name) for a in result.assignments] == list(zip(sorted(TARGETS), NAMES, strict=True))
ws = load_workbook(result.output_path)[DEFAULT_SHEET_NAME]
assert [ws[f"C{r}"].value for r in range(5, 10)] == [*NAMES, None]
assert all(ws[c].data_type == "s" for c in TARGETS)
def test_write_does_not_touch_the_template_file(template: Path) -> None:
before = _sha256(template)
write_rooms_to_excel(template, _rooms(NAMES))
assert _sha256(template) == before
def test_write_keeps_all_other_cells_and_sheet_settings(template: Path, tmp_path: Path) -> None:
original = load_workbook(template)[DEFAULT_SHEET_NAME]
result = write_rooms_to_excel(template, _rooms(NAMES), output_path=tmp_path / "out.xlsx")
written = load_workbook(result.output_path)[DEFAULT_SHEET_NAME]
assert _cell_snapshot(written, TARGETS) == _cell_snapshot(original, TARGETS)
assert _sheet_settings(written) == _sheet_settings(original)
def test_write_keeps_formulas_as_formulas(template: Path) -> None:
result = write_rooms_to_excel(template, _rooms(NAMES))
ws = load_workbook(result.output_path)[DEFAULT_SHEET_NAME]
assert (ws["D15"].value, ws["D15"].data_type) == ("=SUM(D5:D14)", "f")
assert (ws["D16"].value, ws["D16"].data_type) == ("=COUNTA(C5:C14)", "f")
def test_rich_text_in_other_cells_is_kept(tmp_path: Path) -> None:
"""セル内の一部だけ太字・赤字にした注記(リッチテキスト)が、ただの文字列にならない。"""
wb = build_template()
wb[DEFAULT_SHEET_NAME]["E5"] = CellRichText(["面積は", TextBlock(InlineFont(b=True, color="FF0000"), "壁芯")])
template = _save(wb, tmp_path / "部屋一覧.xlsx")
result = write_rooms_to_excel(template, _rooms(NAMES))
value = load_workbook(result.output_path, rich_text=True)[DEFAULT_SHEET_NAME]["E5"].value
assert isinstance(value, CellRichText)
assert value[1].text == "壁芯" and value[1].font.b is True
def test_written_cells_keep_their_template_style(template: Path) -> None:
original = load_workbook(template)[DEFAULT_SHEET_NAME]
result = write_rooms_to_excel(template, _rooms(NAMES))
written = load_workbook(result.output_path)[DEFAULT_SHEET_NAME]
for coord in TARGETS:
# 値だけを書き換え、記入欄の罫線・フォントはテンプレートのまま
assert copy(written[coord].border) == copy(original[coord].border)
assert copy(written[coord].font) == copy(original[coord].font)
def test_write_accepts_finalized_review_list(template: Path) -> None:
"""第6回の確認画面で確定した一覧(表示順)が、そのままの順でC5から入る。"""
words = [
ExtractedWord("寝室1", (320, 114, 360, 130), 16.0, 0),
ExtractedWord("居間", (100, 114, 132, 130), 16.0, 0),
]
review = ReviewList.from_candidates(
[RoomCandidate(word=w, canonical_name=w.text, matched_alias=w.text) for w in words], source=SOURCE_EMBEDDED
)
for item in review.items:
review.set_confirmed(item.item_id)
result = write_rooms_to_excel(template, review.finalize())
ws = load_workbook(result.output_path)[DEFAULT_SHEET_NAME]
assert (ws["C5"].value, ws["C6"].value) == ("居間", "寝室1")
def test_describe_result_lists_cells_and_paths(template: Path) -> None:
result = write_rooms_to_excel(template, _rooms(["居間", "寝室1"]))
text = describe_result(result)
assert f"保存先:{result.output_path}" in text
assert "部屋一覧.xlsx(変更していません)" in text
assert "C5:居間\nC6:寝室1" in text
# --- 書き込めない場合(何も保存しない) ----------------------------------------
def _outputs(folder: Path) -> list[Path]:
return sorted(p for p in folder.iterdir() if "_転記_" in p.name or p.name.startswith("~"))
@pytest.mark.parametrize("bad", ["=HYPERLINK(\"x\")", "+1", "-1", "@A1"])
def test_formula_like_name_is_rejected_before_saving(template: Path, bad: str) -> None:
before = _sha256(template)
with pytest.raises(ExcelWriteError, match="数式"):
write_rooms_to_excel(template, _rooms(["居間", bad]))
assert _outputs(template.parent) == []
assert _sha256(template) == before
def test_target_inside_merged_cell_is_rejected(tmp_path: Path) -> None:
wb = build_template()
wb[DEFAULT_SHEET_NAME].merge_cells("B6:C6") # C6 は結合セルの途中(左上はB6)
template = _save(wb, tmp_path / "部屋一覧.xlsx")
with pytest.raises(ExcelWriteError, match=r"C6 は結合セル(B6:C6)の途中") as exc_info:
write_rooms_to_excel(template, _rooms(NAMES))
assert "左上(B6)" in str(exc_info.value)
assert _outputs(tmp_path) == []
def test_target_at_top_left_of_merged_cell_is_written(tmp_path: Path) -> None:
wb = build_template()
wb[DEFAULT_SHEET_NAME].merge_cells("C6:D6") # C6 は結合セルの左上なので書き込める
template = _save(wb, tmp_path / "部屋一覧.xlsx")
result = write_rooms_to_excel(template, _rooms(NAMES))
ws = load_workbook(result.output_path)[DEFAULT_SHEET_NAME]
assert ws["C6"].value == "寝室1"
assert "C6:D6" in {r.coord for r in ws.merged_cells.ranges}
def test_existing_value_stops_without_overwrite(tmp_path: Path) -> None:
wb = build_template()
wb[DEFAULT_SHEET_NAME]["C6"] = "既存の部屋名"
template = _save(wb, tmp_path / "部屋一覧.xlsx")
with pytest.raises(CellNotEmptyError) as exc_info:
write_rooms_to_excel(template, _rooms(NAMES))
assert exc_info.value.cells == ["C6"]
assert _outputs(tmp_path) == []
def test_existing_value_is_overwritten_only_when_allowed(tmp_path: Path) -> None:
wb = build_template()
wb[DEFAULT_SHEET_NAME]["C6"] = "既存の部屋名"
template = _save(wb, tmp_path / "部屋一覧.xlsx")
result = write_rooms_to_excel(template, _rooms(NAMES), overwrite=True)
assert result.overwritten == ["C6"]
assert "C6:寝室1(上書き)" in describe_result(result)
assert load_workbook(result.output_path)[DEFAULT_SHEET_NAME]["C6"].value == "寝室1"
assert load_workbook(template)[DEFAULT_SHEET_NAME]["C6"].value == "既存の部屋名" # 元は変わらない
def test_formula_in_target_is_never_overwritten(tmp_path: Path) -> None:
wb = build_template()
wb[DEFAULT_SHEET_NAME]["C7"] = "=B7&\"室\""
template = _save(wb, tmp_path / "部屋一覧.xlsx")
with pytest.raises(ExcelWriteError, match="C7 には数式"):
write_rooms_to_excel(template, _rooms(NAMES), overwrite=True)
assert _outputs(tmp_path) == []
def test_too_many_rooms_are_rejected(template: Path) -> None:
with pytest.raises(ExcelWriteError, match="収まりません"):
write_rooms_to_excel(template, _rooms([f"洋室{i}" for i in range(1, 12)]))
assert _outputs(template.parent) == []
def test_empty_room_list_is_rejected(template: Path) -> None:
with pytest.raises(ExcelWriteError, match="ありません"):
write_rooms_to_excel(template, [])
def test_refuses_to_save_over_the_template(template: Path) -> None:
before = _sha256(template)
with pytest.raises(ExcelWriteError, match="上書き保存できません"):
write_rooms_to_excel(template, _rooms(NAMES), output_path=template)
assert _sha256(template) == before
def test_refuses_to_replace_an_existing_output(template: Path, tmp_path: Path) -> None:
existing = tmp_path / "前回の結果.xlsx"
existing.write_bytes(b"previous")
with pytest.raises(ExcelWriteError, match="既にあります"):
write_rooms_to_excel(template, _rooms(NAMES), output_path=existing)
assert existing.read_bytes() == b"previous"
def test_output_suffix_must_match_template(template: Path, tmp_path: Path) -> None:
with pytest.raises(ExcelWriteError, match="拡張子"):
write_rooms_to_excel(template, _rooms(NAMES), output_path=tmp_path / "out.xlsm")
def test_missing_sheet_is_reported_with_available_names(tmp_path: Path) -> None:
wb = build_template()
wb[DEFAULT_SHEET_NAME].title = "Sheet1"
template = _save(wb, tmp_path / "別様式.xlsx")
with pytest.raises(ExcelWriteError, match="シート「部屋一覧」がテンプレートにありません(あるシート:Sheet1)"):
write_rooms_to_excel(template, _rooms(NAMES))
def test_broken_or_missing_template_is_reported(tmp_path: Path) -> None:
broken = tmp_path / "壊れた.xlsx"
broken.write_text("これはExcelではない", encoding="utf-8")
with pytest.raises(ExcelWriteError, match="開けません"):
write_rooms_to_excel(broken, _rooms(NAMES))
with pytest.raises(ExcelWriteError, match="見つかりません"):
write_rooms_to_excel(tmp_path / "無い.xlsx", _rooms(NAMES))
assert _outputs(tmp_path) == []
# --- openpyxl 3.1.5 で扱いにくいもの(記事の「つまずきやすい点」の根拠) -------
def _make_xlsm(source: Path, dest: Path, vba_bytes: bytes) -> None:
"""xlsxに、マクロ本体の代わりのダミーの vbaProject.bin を足して .xlsm の形にする。"""
with zipfile.ZipFile(source) as src, zipfile.ZipFile(dest, "w", zipfile.ZIP_DEFLATED) as out:
for name in src.namelist():
data = src.read(name)
if name == "[Content_Types].xml":
text = data.decode().replace(
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml",
"application/vnd.ms-excel.sheet.macroEnabled.main+xml",
)
data = text.replace(
"</Types>", '<Default Extension="bin" ContentType="application/vnd.ms-office.vbaProject"/></Types>'
).encode()
if name == "xl/_rels/workbook.xml.rels":
data = data.decode().replace(
"</Relationships>",
'<Relationship Id="rIdVBA" Type="http://schemas.microsoft.com/office/2006/relationships/vbaProject"'
' Target="vbaProject.bin"/></Relationships>',
).encode()
out.writestr(name, data)
out.writestr("xl/vbaProject.bin", vba_bytes)
def test_xlsm_keeps_macro_part_and_macro_enabled_type(template: Path, tmp_path: Path) -> None:
vba = b"DUMMY-VBA-PROJECT-FOR-TEST"
xlsm = tmp_path / "様式.xlsm"
_make_xlsm(template, xlsm, vba)
result = write_rooms_to_excel(xlsm, _rooms(NAMES))
assert result.output_path.suffix == ".xlsm"
with zipfile.ZipFile(result.output_path) as z:
assert z.read("xl/vbaProject.bin") == vba # マクロの中身(バイナリ)はそのまま
assert "macroEnabled" in z.read("[Content_Types].xml").decode()
assert load_workbook(result.output_path, keep_vba=True)[DEFAULT_SHEET_NAME]["C5"].value == "居間"
def test_xlsm_macro_is_lost_without_keep_vba(template: Path, tmp_path: Path) -> None:
"""(比較用)openpyxlを keep_vba=False(既定)で使うと、マクロが黙って消える。"""
xlsm = tmp_path / "様式.xlsm"
_make_xlsm(template, xlsm, b"DUMMY")
wb = load_workbook(xlsm)
wb.save(tmp_path / "消える.xlsm")
with zipfile.ZipFile(tmp_path / "消える.xlsm") as z:
assert "xl/vbaProject.bin" not in z.namelist()
def test_picture_is_kept_but_drawn_shapes_are_lost(tmp_path: Path) -> None:
"""画像(ロゴ等)は残るが、図形・テキストボックスは openpyxl 3.1.5 では保存時に消える。"""
Image.new("RGB", (40, 20), "red").save(tmp_path / "logo.png")
wb = build_template()
wb[DEFAULT_SHEET_NAME].add_image(XLImage(str(tmp_path / "logo.png")), "G1")
with_image = _save(wb, tmp_path / "画像付き.xlsx")
# 画像の入った描画パーツに、Excelの「図形(四角形+文字)」と同じ形式の要素を足す
shape = (
"<twoCellAnchor><from><col>7</col><colOff>0</colOff><row>20</row><rowOff>0</rowOff></from>"
"<to><col>9</col><colOff>0</colOff><row>23</row><rowOff>0</rowOff></to>"
'<sp macro="" textlink=""><nvSpPr><cNvPr id="99" name="Rect 1"/><cNvSpPr/></nvSpPr>'
'<spPr><a:prstGeom prst="rect"><a:avLst/></a:prstGeom></spPr>'
"<txBody><a:bodyPr/><a:lstStyle/><a:p><a:r><a:t>SHAPE-TEXT</a:t></a:r></a:p></txBody></sp>"
"<clientData/></twoCellAnchor>"
)
template = tmp_path / "図形付き.xlsx"
with zipfile.ZipFile(with_image) as src, zipfile.ZipFile(template, "w", zipfile.ZIP_DEFLATED) as out:
for name in src.namelist():
data = src.read(name)
if name == "xl/drawings/drawing1.xml":
data = data.decode().replace("</wsDr>", shape + "</wsDr>").encode()
out.writestr(name, data)
result = write_rooms_to_excel(template, _rooms(NAMES))
assert len(load_workbook(result.output_path)[DEFAULT_SHEET_NAME]._images) == 1
with zipfile.ZipFile(result.output_path) as z:
assert b"SHAPE-TEXT" not in z.read("xl/drawings/drawing1.xml")
# --- リポジトリに置いた架空サンプル ---------------------------------------------
def test_sample_template_in_repository_matches_defaults() -> None:
ws = load_workbook(SAMPLE_TEMPLATE)[DEFAULT_SHEET_NAME]
assert ws["C4"].value == "部屋名"
assert all(ws[f"C{r}"].value is None for r in range(5, 5 + DEFAULT_MAX_ROWS))
merged = [r for r in ws.merged_cells.ranges if any(f"C{row}" in r for row in range(5, 15))]
assert merged == []
動かしてみる
pytest
ruff check .
python -m app.main
pytest で「195 passed」と表示されれば完了です(Python 3.13では、openpyxlの内部でZIPファイルが閉じられないことについての警告が1件表示されることがありますが、テストの結果には影響しません)。アプリでは、Excelテンプレートに samples/room_list_template.xlsx を選び、「4.」→「5.」で確定してから「6.」を押すと、同じフォルダに room_list_template_転記_(日時).xlsx ができます。
動作確認の方法
Linux開発環境で確認できたこと
pytest:合計195件が成功(うちtests/test_excel_writer.pyが新規51件。Tesseract 5.3.4+日本語データの環境)ruff check .:エラーなし
テストの中心は「書き込んだ後に読み戻して比べる」ことです。書き込んだ4セル以外の値・数式・表示形式・フォント・塗り・罫線・配置を1セルずつ比べ、結合セル・列幅・入力規則・印刷範囲なども比べます。元のテンプレートのファイルが1バイトも変わっていないこと(ハッシュ値)も確かめています。
# tests/test_excel_writer.py(抜粋)
def test_write_keeps_all_other_cells_and_sheet_settings(template: Path, tmp_path: Path) -> None:
original = load_workbook(template)[DEFAULT_SHEET_NAME]
result = write_rooms_to_excel(template, _rooms(NAMES), output_path=tmp_path / "out.xlsx")
written = load_workbook(result.output_path)[DEFAULT_SHEET_NAME]
assert _cell_snapshot(written, TARGETS) == _cell_snapshot(original, TARGETS)
assert _sheet_settings(written) == _sheet_settings(original)
なお cell.font などが返す StyleProxy は、中身が同じでも == で一致しないため、copy() してから比べます(最初はこれで比較が失敗しました)。ほかに、不正な部屋名・結合セルの途中・既存の値(上書きの了承あり/なし)・数式の欄・11部屋以上・壊れたファイル・原本や既存ファイルへの保存を、ファイルを作らずに止められることも検証しています。
次は、架空のサンプル図面で「4.」「5.」を実行し(「洗面所」を「洗面脱衣室」に修正)、「6. 実行」を押したときの完了メッセージです。開発環境(Linux/Xvfb上・Ubuntu標準のTkテーマ)での画面で、Windows実機では見た目が異なります。ファイル名の日時は撮影スクリプトで固定しています。

出力ファイルをLibreOffice Calc 24.2(Linux)でPDFに変換して切り出したものです(Excel実機の表示ではありません)。罫線・見出しの色・結合セルが残り、部屋数の数式が4を返しています。

openpyxlで読み戻した内容は次のとおりです(5〜14行目のうち5〜9行目と、合計の行)。
| セル | 読み戻した値 | 種類 |
|---|---|---|
| C5〜C8 | 居間/寝室1/キッチン/洗面脱衣室 | 文字列 |
| C9 | (空) | ― |
| D15 | =SUM(D5:D14) | 数式 |
| D16 | =COUNTA(C5:C14) | 数式 |
画面からも、未確定なら警告だけで書かないこと、値のある欄で「いいえ」ならファイルを作らないことを確認しました。
確認できていないこと
- Windows実機のExcelで出力ファイルを開いたときの表示・再計算(今回はLibreOfficeとopenpyxlの読み戻しで確認)
- 実在の取引先の様式(複雑な結合・保護されたシート・外部参照を含むもの)での動作
- 本物のマクロ入り .xlsm での動作(ダミーのマクロ部品が保存後も同じ中身で残ることまでは確認)
つまずきやすい点・セキュリティ上の注意
openpyxl 3.1.5で、実際に保存して読み戻して確かめた範囲をまとめます。
| テンプレートに含まれるもの | 結果 | 対応 |
|---|---|---|
| 罫線・フォント・塗り・表示形式・結合セル・列幅・入力規則 | 残った | そのまま |
| 数式 | 残った(data_only=True で開くと消えた) | 既定の data_only=False で開く |
| セル内の一部だけ太字・色付きの文字 | 既定ではただの文字列になった | rich_text=True で開く |
| マクロ(.xlsm) | 既定では消えた | keep_vba=True で開き、拡張子も .xlsm のまま保存 |
| 貼り付けた画像(ロゴ等) | 残った | そのまま |
| 図形・テキストボックス | 消えた | 様式から外すか、別の方法を検討(下記) |
- 図形・テキストボックスは消える:吹き出しや押印欄の枠を図形で描いた様式は要注意です。罫線で描き直すなどを様式の持ち主と相談します
- マクロは「残す」だけ:
keep_vba=Trueは部品を持ち運ぶだけで、docstringにも「使えるという意味ではない」とあります。本物の .xlsm はExcel実機で確認が必要です - グラフは確認しきれていない:openpyxlで作った棒グラフは保存後も残りましたが、Excelで作り込んだグラフの見た目が保たれるかは未確認です
- 数式の計算結果は保存されない:openpyxlは数式を計算しないため、別のプログラムで出力の計算結果を読むと空になります(
data_only=Trueで読み戻すとNone)。Excelで開けば再計算されます - 出力ファイルにも顧客情報が入る:サンプルでは
*_転記_*.xlsxをgitの追跡対象外にしています。保存場所のアクセス権は原本と同じ範囲に絞ります
発注者向けメモ
この回で確認しておきたいこと・工数の勘所
「テンプレートの書式・数式を壊さない」ことは、業務で使うための前提条件です。崩れたファイルに気付かず取引先へ出すと、信頼を損ねます。開発会社には、値だけを書き込む実装か、書き込み後に「他のセルが変わっていないこと」をどう確かめているかを聞いてみてください。読み戻して比べるテストがあれば、様式を変えたときも同じ確認を繰り返せます。
工数とリスクを左右するのは様式の作りです。次の点を棚卸しし、様式の実物(顧客情報を消したもの)を渡すと見積もりの精度が上がります。
| 様式の特徴 | 影響 |
|---|---|
| 図形・テキストボックス・グラフがある | 消える・変わるおそれ。様式の見直しか別の方式の検討が必要になり、費用や動作条件が変わりうる |
| マクロ付き(.xlsm) | マクロを残す設定と、実機での動作確認が必要 |
| 記入欄に結合セルが多い | どのセルに書くかの指定が複雑になる |
| 記入欄の数が決まっている | 欄が足りない物件の扱い(エラー/2枚目/行の追加)を決める必要がある |
| シートの保護・パスワード | 今回は未対応。対応の要否を確認する |
「原本や前回の結果を上書きしない」は小さな配慮ですが、事故防止の効果は大きい部分です。出力ファイルの名前の付け方や置き場所は、社内のファイル管理ルールに合わせて早めに決めておきます。
- ☐ 転記先の様式の実物(顧客情報を消したもの)を用意したか
- ☐ 様式に図形・グラフ・マクロ・シート保護があるかを確認したか
- ☐ 記入欄が足りない物件(部屋数が多い場合)の扱いを決めたか
- ☐ 出力ファイルの名前の付け方と保存場所のルールを決めたか
- ☐ 記入欄に前回の値が残っていた場合に、上書きしてよいかを誰が判断するか決めたか
開発会社への質問例
- 「値だけを書き込む実装ですか?書式・数式・結合セルが変わっていないことを、どのように確認していますか?」
- 「元のテンプレートを上書きしてしまうことはありますか?出力ファイルの名前はどう決まりますか?」
- 「うちの様式に含まれる図形・グラフ・マクロは、転記後も残りますか?実物で試してもらえますか?」
- 「記入欄に既に値が入っていた場合や、欄が足りない場合はどうなりますか?」
まとめと次回予告
第7回では、確認済みの部屋名をExcelテンプレートの決まった欄へ転記する app/core/excel_writer.py を実装し、「6. 実行」ボタンにつなぎました。値だけを書く、原本は別名で残す、問題があれば書く前に止める、の3点がポイントです。openpyxlの既定のままだと数式・セル内の書式・マクロが消えうるため、開き方にも注意が必要でした。
次回(第8回)は「部屋名とExcelの欄の対応付けを設定ファイルで変えられるようにする」です。今回コード内に書いた「C5から下へ順に」という規則をYAMLの設定ファイルに移し、様式が違う取引先にもコードを変えずに対応できるようにします。
この連載の記事一覧
この記事は連載「CAD図面PDFをExcelへ自動転記するツール開発」の1回です。連載のほかの回は次のとおりです(連載の一覧ページ)。
- 【CAD図面PDFをExcelへ自動転記するツール開発 第0回】要件整理とPython開発環境、tkinterの最初の画面を作る
- 【CAD図面PDFをExcelへ自動転記するツール開発 第1回】PyMuPDFで図面PDFを画面にプレビュー表示する
- 【CAD図面PDFをExcelへ自動転記するツール開発 第2回】PyMuPDFで図面の文字を座標付きで抽出し、プレビューにハイライト表示する
- 【CAD図面PDFをExcelへ自動転記するツール開発 第3回】部屋名辞書とヒューリスティックで「部屋名らしき文字列」だけを絞り込む
- 【CAD図面PDFをExcelへ自動転記するツール開発 第4回】スキャン図面・画像PDFの部屋名をローカルOCR(Tesseract)で読み取る
- 【CAD図面PDFをExcelへ自動転記するツール開発 第5回】外部AI(Claude)の画像解析で図面の部屋名を読み取り、精度を底上げする
- 【CAD図面PDFをExcelへ自動転記するツール開発 第6回】AI・OCRの読み取り結果を人が確認・修正する画面を作る
- 【CAD図面PDFをExcelへ自動転記するツール開発 第7回】確認済みの部屋名を指定のExcelフォーマットの決まった欄へ転記する(この記事)
- 【CAD図面PDFをExcelへ自動転記するツール開発 第8回】部屋名とExcelの欄の対応付けを設定ファイル(YAML)で変えられるようにする
- 【CAD図面PDFをExcelへ自動転記するツール開発 第9回】複数の図面PDFをフォルダごとまとめて処理する(進捗表示・中止・失敗しても止まらない一括処理)
- 【CAD図面PDFをExcelへ自動転記するツール開発 第10回】ローカル完結モードと外部AIモードを切り替え、APIキーをWindowsの資格情報マネージャーに保存する
- 【CAD図面PDFをExcelへ自動転記するツール開発 第11回(最終回)】PyInstallerでWindows向けexeにまとめて配布し、精度の限界と確認のルールを整理する


コメント
コメント一覧 (1件)
[…] 前回(第7回)では、確認済みの部屋名をExcelテンプレートの決まった欄へ、書式や数式を壊さずに書き込めるようにしました。ただし書き込み先は「C5から下へ順に」というコード内の決め打ちでした。 […]