(2026年10月29日 追記:記事どおりに再現できるよう、必要なコードと手順を追加しました)
前回(第7回)では、確認済みの部屋名をExcelテンプレートの決まった欄へ、書式や数式を壊さずに書き込めるようにしました。ただし書き込み先は「C5から下へ順に」というコード内の決め打ちでした。
第8回は、部屋名とExcelの欄(セル位置)の対応付けを設定ファイル(YAML)に移し、様式が違うテンプレートにもコードを変えずに転記できるようにします。取引先ごとにExcelのフォーマットが違う、という転記ツールでよくある悩みへの対応です。結論から言うと、ポイントは次の3つです。
- 欄の決め方は「順番に並べる型」と「部屋ごとに固定の欄がある型」の2通りを用意すれば、多くの様式を表せる
- テンプレートが複数あっても、ファイル名・シート名・目印のセルで使う設定を自動で選ぶ
- 設定ファイルは人が手で書くので、書き間違いを読み込んだ時点で分かりやすく止める。YAMLは必ず
yaml.safe_load()で読む
今回作る機能と完成イメージ
メイン画面に「2-2. 転記の設定ファイル(任意)」の欄を追加します。
- 「設定を選ぶ…」でYAMLファイルを選ぶと、その場で内容を検証する
- Excelテンプレートに合う設定を探し、「使う設定:…」と表示する。「6. 実行」ではその設定の欄へ書き込む
- 設定ファイルを選ばなければ、第7回と同じ動作になる
動作確認用に、レイアウトの違う架空のテンプレート「間取り確認表」(B列に部屋種別が印字され、C列の決まった行に書き込む様式)を追加し、1つの設定ファイルで第7回の「部屋一覧」と両方に書けることを確かめます。
仕組みの説明:様式の違いを「欄の決め方」の2パターンで表す
「部屋名をどの欄に書くか」の決め方は、おおむね次の2パターンに分けられます。
| 型(layout) | 様式の例 | 設定に書くこと |
|---|---|---|
| sequential(順番に並べる) | 部屋名を上から順に書いていく一覧表 | 開始セル・方向(下へ/右へ)・欄の数 |
| fixed(部屋ごとに固定の欄) | 「居間」「寝室1」などの行が印字済みのチェック表 | 「部屋名: セル番地」の一覧 |
固定の欄の型では、図面の表記が「リビング」でも「LDK」でも、居間の欄に入ってほしいはずです。そこで、第3回で作った部屋名辞書(rooms.yaml)を再利用し、代表表記+末尾の番号にそろえてから突き合わせます。
たとえば「ベッドルーム2」は「寝室2」の欄に入ります。セルに書き込むのは確認画面で確定した名前そのもので、キーは欄を探すためだけに使います。
テンプレートが複数ある場合は、設定ファイルに様式ごとの設定を並べ、上から順に「ファイル名」「対象シートの有無」「目印のセルの文字」を調べて、最初に当てはまったものを使います。
実装
ファイル構成(第8回時点の差分)
madori-ocr/
├ app/
│ ├ core/
│ │ ├ mapping.py …【今回追加】設定ファイルの読み込み・検証・テンプレートの識別・欄の決定
│ │ └ excel_writer.py …【今回変更】書き込み先を mapping.py の設定で決めるようにした
│ ├ config/
│ │ └ mapping.example.yaml …【今回追加】設定ファイルのサンプル(2つの架空テンプレート分)
│ └ ui/
│ └ main_window.py …【今回変更】設定ファイルの選択欄を追加し、転記に配線
├ samples/
│ └ floor_plan_sheet.xlsx …【今回追加】レイアウトの違う架空テンプレート「間取り確認表」
├ tests/
│ └ test_mapping.py …【今回追加】pytest 73件
└ tools/
└ make_sample_template.py …【今回変更】--floor-plan で2つ目のテンプレートを生成
新しいパッケージは追加していません。YAMLの読み込みには、第3回で導入した PyYAML 6.0.3(2025年9月公開・MIT License)を使います。
📰 出典:PyYAML 6.0.3(PyPI)
設定ファイルの書き方(app/config/mapping.example.yaml)
2つの架空テンプレート分の設定です。1つ目は第7回の動作をそのまま設定で書いたもの、2つ目が部屋ごとに固定の欄がある様式です。
# app/config/mapping.example.yaml(抜粋。ファイル先頭に各キーの説明コメントあり)
version: 1
templates:
- id: room_list
name: 部屋一覧(上から順に並べる)
match:
file_name: ["room_list_template*.xlsx", "部屋一覧*.xlsx"]
sheet: 部屋一覧
layout: sequential
start_cell: C5
direction: down
max_count: 10
- id: floor_plan_sheet
name: 間取り確認表(部屋種別ごとの欄)
match:
file_name: "floor_plan_sheet*.xlsx"
marker:
cell: A1
contains: 間取り確認表
sheet: 間取り表
layout: fixed
cells:
居間: C4
キッチン: C5
寝室1: C6
寝室2: C7
寝室3: C8
洗面所: C9
浴室: C10
トイレ: C11
玄関: C12
バルコニー: C13
on_unmatched: error
on_unmatched は、設定に欄が無い部屋名があったときの扱いです。既定の error は転記を止め、skip はその部屋名だけ書かずに進めて完了メッセージに表示します。黙って書き漏らすことがないよう、既定は止める方にしました。
YAMLは yaml.safe_load() で読む(app/core/mapping.py)
設定ファイルはメールやチャットで受け取ることもあります。yaml.load() は指定するLoaderによっては任意のPythonオブジェクトを作れてしまうため、基本的な型だけを扱う yaml.safe_load() を使います。PyYAML 6.0.3の説明文にも「信頼できない入力に対しても安全」とあります。
# app/core/mapping.py(抜粋)
def parse_mapping_config(text, *, source=None, dictionary=None) -> MappingConfig:
where = source.name if source is not None else "設定"
try:
_check_duplicate_keys(text, where)
data = yaml.safe_load(text) # 任意のPythonオブジェクトを作らない読み込み方(yaml.loadは使わない)
except yaml.YAMLError as exc:
mark = getattr(exc, "problem_mark", None)
line = f"({mark.line + 1}行目付近)" if mark is not None else ""
raise MappingConfigError(f"{where}: YAMLとして読み込めません{line}。インデントや「:」の後の空白を確認してください。") from exc
...
ただし safe_load() には落とし穴が1つあります。同じキーを2回書いても、黙って後の値で上書きするのです。実際に「寝室1: C6」「寝室1: C7」と書くと、エラーにならず {'寝室1': 'C7'} になりました。書き写しミスに気付けるよう、値を作る前の構文木(yaml.compose()。Pythonのオブジェクトは作らない)で重複を調べています。
# app/core/mapping.py(抜粋)
def _check_duplicate_keys(text: str, where: str) -> None:
root = yaml.compose(text, Loader=yaml.SafeLoader)
stack = [root] if root is not None else []
visited: set[int] = set()
while stack:
node = stack.pop()
if id(node) in visited:
continue
visited.add(id(node))
if isinstance(node, yaml.MappingNode):
seen: dict[str, int] = {}
for key_node, value_node in node.value:
if isinstance(key_node, yaml.ScalarNode):
line = key_node.start_mark.line + 1
if key_node.value in seen:
raise MappingConfigError(
f"{where}: キー「{key_node.value}」が同じ場所に2回書かれています({seen[key_node.value]}行目と{line}行目)。"
)
seen[key_node.value] = line
stack.append(value_node)
elif isinstance(node, yaml.SequenceNode):
stack.extend(node.value)
書き間違いを読み込み時に止める
読み込んだ後は、テンプレートごとに次の点を確認します。メッセージには「どのファイルの、何番目の設定の、どの項目か」を入れます。
| 確認すること | エラーの例 |
|---|---|
| 必須キー・知らないキー(書き間違い) | 必須のキーがありません: sheet/知らないキーがあります: start_cel |
| セル番地 | セル番地が不正です: ‘5C’ |
| 同じセルの重複 | セル C4 が「居間」と「寝室1」の両方に指定されています |
| 辞書で同じ部屋になる名前 | 「居間」と「リビング」は部屋名辞書で同じ部屋(居間)になるため… |
固定の欄の検証部分です。セル番地は全角・小文字を半角・大文字にそろえ、$C$5 や C5:C14 のような書き方は受け付けません。
# app/core/mapping.py(抜粋)
for label, raw_cell in cells.items():
if not isinstance(label, str) or not label.strip():
# 「1:」「yes:」のようなキーはYAMLで数値・真偽値として読まれてしまう
raise MappingConfigError(f"{where}: cells の部屋名 {label!r} は文字列にしてください(必要なら「\"1\":」のように引用符で囲みます)。")
try:
cell = normalize_cell(raw_cell)
except MappingError as exc:
raise MappingConfigError(f"{where}: cells の「{label}」: {exc}") from None
if cell in cell_owner:
raise MappingConfigError(f"{where}: セル {cell} が「{cell_owner[cell]}」と「{label}」の両方に指定されています。")
cell_owner[cell] = label
key = room_key(label, dictionary)
if key in key_owner:
raise MappingConfigError(
f"{where}: 「{key_owner[key]}」と「{label}」は部屋名辞書で同じ部屋({key})になるため、どちらの欄に書くか決められません。"
)
key_owner[key] = label
slots.append(FixedSlot(label=label, cell=cell))
表記ゆれは第3回の部屋名辞書でそろえる
部屋名を欄のキーにそろえる関数です。辞書の照合(RoomDictionary.match())は第3回のものをそのまま使い、一致した表記の後ろに残った番号を代表表記に付け直します。
# app/core/mapping.py(抜粋)
def room_key(name: str, dictionary: RoomDictionary | None = None) -> str:
normalized = unicodedata.normalize("NFKC", name).strip()
if dictionary is None:
return normalized
matched = dictionary.match(normalized)
if matched is None:
return normalized
canonical, alias = matched
alias_normalized = unicodedata.normalize("NFKC", alias).strip()
suffix = normalized[len(alias_normalized) :] if normalized != alias_normalized else ""
return f"{canonical}{suffix}"
書き込み先を決める処理では、欄が無い部屋名をまとめて報告し、2つの部屋名が同じ欄になる場合(「居間」と「リビング」が両方ある等)も止めます。
# app/core/mapping.py(抜粋)
for name in names:
key = room_key(name, dictionary)
slot = slots.get(key)
if slot is None:
unmatched.append(name if key == unicodedata.normalize("NFKC", name).strip() else f"{name}({key})")
continue
if slot.cell in used:
raise MappingError(f"「{used[slot.cell]}」と「{name}」が同じ欄({slot.label}:{slot.cell})になります。どちらかの名前を確認画面で直してください。")
used[slot.cell] = name
assignments.append(CellAssignment(cell=slot.cell, name=name))
テンプレートに合う設定を選ぶ
テンプレートは読み取り専用で開き、シート名と目印のセルだけを読んですぐ閉じます。ファイル名は合ったのにシートが無いときは設定の書き間違いの可能性が高いため、次の設定を探さずにその場でエラーにします。
# app/core/mapping.py(抜粋)
for mapping in config.templates:
name_given = bool(mapping.match.file_names)
if name_given and not _file_name_matches(template.name, mapping.match.file_names):
reasons.append(f"・{mapping.id}:ファイル名が {'/'.join(mapping.match.file_names)} に合いません")
continue
if mapping.sheet not in sheets:
message = f"シート「{mapping.sheet}」がテンプレートにありません(あるシート:{'、'.join(sheets)})"
if name_given:
raise MappingError(f"設定「{mapping.id}」はファイル名が合いましたが、{message}。設定の sheet を確認してください。")
reasons.append(f"・{mapping.id}:{message}")
continue
if mapping.match.marker_cell is not None and mapping.match.marker_text is not None:
found = markers.get((mapping.sheet, mapping.match.marker_cell), "")
if mapping.match.marker_text not in found:
reasons.append(f"・{mapping.id}:{mapping.match.marker_cell} に「{mapping.match.marker_text}」がありません")
continue
return mapping
どれにも当てはまらなければ、設定ごとに合わなかった理由を並べたエラーにします。
第7回の書き込み処理とのつなぎ込み(app/core/excel_writer.py)
第7回で書き込み本体を「どのセルに何を書くか」のリストを受け取るだけにしておいたため、変更は割り当ての部分だけで済みました。mapping を渡さなければ第7回と同じ既定で動きます。
# app/core/excel_writer.py(抜粋)
if mapping is None:
layout = _sequential_layout(start_cell, max_rows)
mapping = TemplateMapping(id=DEFAULT_MAPPING.id, name=DEFAULT_MAPPING.name, sheet=sheet_name, layout=layout)
try:
plan = plan_cells(mapping, names, dictionary)
except MappingError as exc:
raise ExcelWriteError(str(exc)) from None
assignments = plan.assignments
sheet_name = mapping.sheet
画面から設定ファイルを選ぶ(app/ui/main_window.py)
設定ファイルは選んだ時点で検証し、「6. 実行」のときにテンプレートに合う設定を選び直します。
# app/ui/main_window.py(抜粋)
def _on_choose_mapping(self) -> None:
path = filedialog.askopenfilename(title="転記の設定ファイルを選択", filetypes=MAPPING_FILETYPES)
if not path:
return
try:
config = load_mapping_config(path, self._room_dictionary)
except MappingError as exc:
messagebox.showerror("転記の設定ファイルのエラー", str(exc))
return
self.mapping_config = config
self.mapping_path_var.set(f"{path}({len(config.templates)}種類のテンプレートの設定)")
self._refresh_mapping_status()
def _resolve_mapping(self, template: Path) -> TemplateMapping | None:
if self.mapping_config is None:
return DEFAULT_MAPPING
try:
return identify_template(self.mapping_config, template)
except MappingError as exc:
messagebox.showerror("転記の設定エラー", str(exc))
return None
この回で追加・変更するファイル
新しいパッケージはありません。設定ファイルのサンプル(上で抜粋したものの全体)を app/config に置きます。
app/config/mapping.example.yaml を新しく作ります(全文)。
# app/config/mapping.example.yaml
# 部屋名とExcelの欄(セル位置)の対応付けの設定(第8回・app/core/mapping.py が読み込む)。
#
# このファイルはサンプルです。自社・取引先の様式に合わせてコピーし、
# 「mapping.yaml」など別の名前で保存してから、画面の「設定を選ぶ...」で選んでください。
# 文字コードは UTF-8 で保存します。
#
# templates: の下に、テンプレート(様式)1種類ごとの設定を「- 」で始めて並べます。
# 画面で選んだExcelテンプレートに対して、上から順に match の条件を調べ、
# 最初に当てはまった設定を使います。
#
# 共通のキー
# id … 設定の名前(英数字。ファイル内で重複しないこと) 【必須】
# name … 画面に表示する説明(省略時は id)
# sheet … 転記先のシート名(テンプレートのシート見出しと完全に同じ) 【必須】
# layout … 欄の決め方。sequential(順番に並べる)か fixed(部屋ごとに固定の欄)【必須】
# match … どのテンプレートにこの設定を使うか(省略時は「sheet のシートがあれば使う」)
# file_name … ファイル名のパターン(* は任意の文字列)。1つでもリストでもよい
# marker … 目印のセル。cell のセルに contains の文字が含まれていれば当てはまる
#
# layout: sequential のキー
# start_cell … 1件目を書くセル(例:C5) 【必須】
# direction … down(下へ)または right(右へ)。省略時は down
# max_count … 欄の数。これを超える部屋数はエラーにする 【必須】
#
# layout: fixed のキー
# cells … 「部屋名: セル番地」の一覧 【必須】
# 部屋名の表記ゆれ(リビング・LDK・寝室1など)は、部屋名辞書
# (app/config/rooms.yaml)の代表表記+番号にそろえてから突き合わせます。
# 例:図面の「ベッドルーム2」は、ここに書いた「寝室2」の欄に入ります。
# on_unmatched … 欄の無い部屋名があったときの扱い。error(転記を止める。既定)
# または skip(その部屋名だけ書かずに進み、完了メッセージに表示する)
#
# 注意
# - セル番地は「C5」のように1つのセルだけを書きます($C$5 や C5:C14 は不可)。
# - 同じセルを2つの部屋に指定したり、同じキーを2回書いたりするとエラーになります。
# - 部屋名が数字だけ・yes/no などの場合は "1": のように引用符で囲みます。
version: 1
templates:
# 1つ目:第7回の架空テンプレート「部屋一覧」(samples/room_list_template.xlsx)。
# 確認済みの部屋名を、C5から下へ順に最大10行並べる(第7回の既定の動作と同じ)。
- id: room_list
name: 部屋一覧(上から順に並べる)
match:
file_name: ["room_list_template*.xlsx", "部屋一覧*.xlsx"]
sheet: 部屋一覧
layout: sequential
start_cell: C5
direction: down
max_count: 10
# 2つ目:第8回で追加した架空テンプレート「間取り確認表」(samples/floor_plan_sheet.xlsx)。
# B列に部屋種別が印字してあり、C列の決まった行に図面上の表記を書く。
- id: floor_plan_sheet
name: 間取り確認表(部屋種別ごとの欄)
match:
file_name: "floor_plan_sheet*.xlsx"
marker:
cell: A1
contains: 間取り確認表
sheet: 間取り表
layout: fixed
cells:
居間: C4
キッチン: C5
寝室1: C6
寝室2: C7
寝室3: C8
洗面所: C9
浴室: C10
トイレ: C11
玄関: C12
バルコニー: C13
on_unmatched: error
設定ファイルの読み込み・検証・テンプレートの識別・欄の決定をまとめた app/core/mapping.py の全体です。
app/core/mapping.py を新しく作ります(全文)。
app/core/mapping.py の全文(572行)
# app/core/mapping.py
"""部屋名とExcelの欄(セル位置)の対応付けを、設定ファイル(YAML)から読み込むコア処理。
第7回では「シート『部屋一覧』のC5から下へ順に、最大10行」という対応を
`app/core/excel_writer.py` の中に書いていた。第8回ではこれを設定ファイル
(例:`app/config/mapping.example.yaml`)に移し、様式(テンプレート)が
取引先ごとに違っても、**コードを変えずに設定ファイルだけで**対応できるようにする。
扱える書き方(layout)は2通り。
- `sequential`(順番に並べる型)
確認済みの部屋名を、上から順に `start_cell` から `direction`(down=下へ/
right=右へ)に1件ずつ並べる。欄の数は `max_count`。第7回の動作はこの型で表せる。
- `fixed`(部屋ごとに固定の欄がある型)
`cells` に「部屋名: セル番地」を並べる(例:居間 → C6、寝室1 → C7)。
部屋名の表記ゆれ(リビング/LDK/寝室1 など)は、第3回の部屋名辞書
(`app/config/rooms.yaml`)の代表表記+番号にそろえてから突き合わせる。
1つの設定ファイルに複数のテンプレート分の設定を書ける。どれを使うかは、
テンプレートのファイル名(`match.file_name`)・対象シートの有無(`sheet`)・
目印のセルの文字(`match.marker`)で、上から順に調べて最初に当てはまったものを選ぶ。
設定ファイルは人が手で書くものなので、次の誤りは読み込んだ時点で
「どのファイルの、どの設定の、どの項目か」が分かるメッセージでエラーにする。
- 必須キーの欠落・知らないキー(書き間違い)・同じキーの重複
- 不正なセル番地(例:`5C`、`C0`)・同じセルの重複
- layout・direction の値の誤り、max_count が1未満 など
存在しないシートは、テンプレートを開いた時点(`identify_template()`)でエラーにする。
YAMLは必ず `yaml.safe_load()` で読む(`yaml.load()` は使わない)。設定ファイルは
メールやチャットで受け取ることもありうるため、任意のPythonオブジェクトを作れる
読み込み方をしない。tkinterには依存しないため、pytestで検証できる。
"""
from __future__ import annotations
import fnmatch
import re
import unicodedata
import zipfile
from collections.abc import Sequence
from dataclasses import dataclass
from pathlib import Path
from typing import Any
import yaml
from openpyxl import load_workbook
from openpyxl.utils.cell import column_index_from_string, get_column_letter
from openpyxl.utils.exceptions import InvalidFileException
from app.core.room_matcher import RoomDictionary
#: 設定ファイルのサンプルの配置場所(`app/config/mapping.example.yaml`)
EXAMPLE_MAPPING_PATH = Path(__file__).resolve().parent.parent / "config" / "mapping.example.yaml"
LAYOUT_SEQUENTIAL = "sequential"
LAYOUT_FIXED = "fixed"
DIRECTION_DOWN = "down"
DIRECTION_RIGHT = "right"
ON_UNMATCHED_ERROR = "error"
ON_UNMATCHED_SKIP = "skip"
#: Excelのシートの上限(列 XFD=16384列、1048576行)
MAX_EXCEL_COLUMN = 16384
MAX_EXCEL_ROW = 1048576
#: 設定ファイルの大きさの上限(人が書く設定としては十分。巨大なファイルの読み込みを避ける)
MAX_CONFIG_BYTES = 1024 * 1024
_CELL_PATTERN = re.compile(r"^([A-Z]{1,3})([1-9][0-9]*)$")
_TOP_LEVEL_KEYS = {"version", "templates"}
_TEMPLATE_KEYS = {"id", "name", "match", "sheet", "layout", "start_cell", "direction", "max_count", "cells", "on_unmatched"}
_SEQUENTIAL_ONLY_KEYS = {"start_cell", "direction", "max_count"}
_FIXED_ONLY_KEYS = {"cells", "on_unmatched"}
_MATCH_KEYS = {"file_name", "marker"}
_MARKER_KEYS = {"cell", "contains"}
class MappingError(ValueError):
"""部屋名とセルの対応付けができない場合の例外(何も書き込まれていない)。"""
class MappingConfigError(MappingError):
"""設定ファイルそのものに誤りがある場合の例外。"""
class TemplateNotMatchedError(MappingError):
"""選んだテンプレートに当てはまる設定が、設定ファイルに1つも無い場合の例外。"""
@dataclass(frozen=True)
class CellAssignment:
"""部屋名1件の書き込み先(セル番地と書き込む値)。"""
cell: str
name: str
@dataclass(frozen=True)
class CellPlan:
"""書き込み計画。`skipped` は `on_unmatched: skip` で書き込まなかった部屋名。"""
assignments: list[CellAssignment]
skipped: list[str]
@dataclass(frozen=True)
class SequentialLayout:
"""順番に並べる型:`start_cell` から `direction` の方向へ `max_count` 個の欄。"""
start_cell: str
direction: str
max_count: int
def cells(self) -> list[str]:
column, row = split_cell(self.start_cell)
col_index = column_index_from_string(column)
if self.direction == DIRECTION_RIGHT:
return [f"{get_column_letter(col_index + i)}{row}" for i in range(self.max_count)]
return [f"{column}{row + i}" for i in range(self.max_count)]
@dataclass(frozen=True)
class FixedSlot:
"""固定の欄1つ。`label` は設定ファイルに書かれた部屋名(メッセージ表示用)。"""
label: str
cell: str
@dataclass(frozen=True)
class FixedLayout:
"""部屋ごとに固定の欄がある型。"""
slots: tuple[FixedSlot, ...]
on_unmatched: str = ON_UNMATCHED_ERROR
@dataclass(frozen=True)
class TemplateMatch:
"""どのテンプレートにこの設定を使うかの条件(空なら「対象シートがあれば当てはまる」)。"""
file_names: tuple[str, ...] = ()
marker_cell: str | None = None
marker_text: str | None = None
@dataclass(frozen=True)
class TemplateMapping:
"""テンプレート1種類分の対応付け。"""
id: str
name: str
sheet: str
layout: SequentialLayout | FixedLayout
match: TemplateMatch = TemplateMatch()
@dataclass(frozen=True)
class MappingConfig:
"""読み込んだ設定ファイル全体。"""
path: Path | None
templates: tuple[TemplateMapping, ...]
#: 設定ファイルを選んでいないときの対応付け(第7回と同じ:部屋一覧のC5から下へ順に最大10行)
DEFAULT_SHEET_NAME = "部屋一覧"
DEFAULT_START_CELL = "C5"
DEFAULT_MAX_COUNT = 10
DEFAULT_MAPPING = TemplateMapping(
id="default",
name="既定(第7回と同じ)",
sheet=DEFAULT_SHEET_NAME,
layout=SequentialLayout(start_cell=DEFAULT_START_CELL, direction=DIRECTION_DOWN, max_count=DEFAULT_MAX_COUNT),
)
# --- セル番地 ---------------------------------------------------------------
def normalize_cell(text: object) -> str:
"""セル番地をそろえる(全角→半角・小文字→大文字)。不正なら `MappingError`。
`$C$5` のような絶対参照の記号や、`C5:C14` のような範囲は受け付けない
(1つのセルだけを指す番地だけにして、設定の読み違いを防ぐ)。
"""
if not isinstance(text, str):
raise MappingError(f"セル番地は文字列で書いてください: {text!r}")
cell = unicodedata.normalize("NFKC", text).strip().upper()
matched = _CELL_PATTERN.match(cell)
if not matched:
raise MappingError(f"セル番地が不正です: {text!r}(「C5」のように列の英字+行番号で書いてください)")
column, row = matched.group(1), int(matched.group(2))
if column_index_from_string(column) > MAX_EXCEL_COLUMN or row > MAX_EXCEL_ROW:
raise MappingError(f"セル番地がExcelのシートの範囲外です: {text!r}")
return cell
def split_cell(cell: str) -> tuple[str, int]:
matched = _CELL_PATTERN.match(cell)
if not matched:
raise MappingError(f"セル番地が不正です: {cell!r}")
return matched.group(1), int(matched.group(2))
# --- 部屋名 → 欄のキー ---------------------------------------------------------
def room_key(name: str, dictionary: RoomDictionary | None = None) -> str:
"""部屋名を、固定の欄と突き合わせるためのキーにそろえる。
第3回の部屋名辞書で「代表表記+末尾の番号」に変換する。
例:リビング → 居間、LDK → 居間、ベッドルーム2 → 寝室2、寝室1 → 寝室1。
辞書に無い名前(人が修正した「洗面脱衣室」など)は、NFKC正規化しただけの文字列を使う。
"""
normalized = unicodedata.normalize("NFKC", name).strip()
if dictionary is None:
return normalized
matched = dictionary.match(normalized)
if matched is None:
return normalized
canonical, alias = matched
alias_normalized = unicodedata.normalize("NFKC", alias).strip()
suffix = normalized[len(alias_normalized) :] if normalized != alias_normalized else ""
return f"{canonical}{suffix}"
# --- 設定ファイルの読み込み -------------------------------------------------------
def load_mapping_config(path: str | Path, dictionary: RoomDictionary | None = None) -> MappingConfig:
"""設定ファイル(YAML)を読み込み、内容を検証して `MappingConfig` を返す。
`dictionary` を渡すと、固定の欄の部屋名を辞書でそろえたうえで重複を確認する
(例:「居間」と「リビング」を別々の欄に書いた設定は、どちらに書くか決められないためエラー)。
"""
config_path = Path(path)
if not config_path.is_file():
raise MappingConfigError(f"設定ファイルが見つかりません: {config_path}")
if config_path.stat().st_size > MAX_CONFIG_BYTES:
raise MappingConfigError(f"設定ファイルが大きすぎます({MAX_CONFIG_BYTES // 1024}KBまで): {config_path.name}")
try:
text = config_path.read_text(encoding="utf-8")
except UnicodeDecodeError as exc:
raise MappingConfigError(f"設定ファイルをUTF-8として読めません: {config_path.name}") from exc
return parse_mapping_config(text, source=config_path, dictionary=dictionary)
def parse_mapping_config(
text: str, *, source: Path | None = None, dictionary: RoomDictionary | None = None
) -> MappingConfig:
"""YAMLの文字列から `MappingConfig` を作る(`load_mapping_config()` の本体。テストからも使う)。"""
where = source.name if source is not None else "設定"
try:
_check_duplicate_keys(text, where)
data = yaml.safe_load(text) # 任意のPythonオブジェクトを作らない読み込み方(yaml.loadは使わない)
except yaml.YAMLError as exc:
mark = getattr(exc, "problem_mark", None)
line = f"({mark.line + 1}行目付近)" if mark is not None else ""
raise MappingConfigError(f"{where}: YAMLとして読み込めません{line}。インデントや「:」の後の空白を確認してください。") from exc
if not isinstance(data, dict):
raise MappingConfigError(f"{where}: 先頭に「templates:」を書き、その下にテンプレートごとの設定を並べてください。")
_check_keys(data, _TOP_LEVEL_KEYS, required={"templates"}, where=where)
if "version" in data and data["version"] != 1:
raise MappingConfigError(f"{where}: version は 1 だけに対応しています({data['version']!r})。")
raw_templates = data["templates"]
if not isinstance(raw_templates, list) or not raw_templates:
raise MappingConfigError(f"{where}: templates にテンプレートの設定を1つ以上、「- 」で始めて並べてください。")
templates: list[TemplateMapping] = []
seen_ids: set[str] = set()
for index, raw in enumerate(raw_templates):
mapping = _parse_template(raw, where=f"{where} の templates[{index}]", dictionary=dictionary)
if mapping.id in seen_ids:
raise MappingConfigError(f"{where}: id「{mapping.id}」が2回使われています(idは設定ごとに別の名前にしてください)。")
seen_ids.add(mapping.id)
templates.append(mapping)
return MappingConfig(path=source, templates=tuple(templates))
def _parse_template(raw: Any, *, where: str, dictionary: RoomDictionary | None) -> TemplateMapping:
if not isinstance(raw, dict):
raise MappingConfigError(f"{where}: 「id:」「sheet:」「layout:」などのキーを持つ設定にしてください。")
if isinstance(raw.get("id"), str):
where = f"{where}(id: {raw['id']})"
_check_keys(raw, _TEMPLATE_KEYS, required={"id", "sheet", "layout"}, where=where)
template_id = _require_text(raw, "id", where)
sheet = _require_text(raw, "sheet", where)
name = _require_text(raw, "name", where) if "name" in raw else template_id
layout_name = raw["layout"]
if layout_name == LAYOUT_SEQUENTIAL:
extra = sorted(_FIXED_ONLY_KEYS & raw.keys())
if extra:
raise MappingConfigError(f"{where}: layout: sequential では {'、'.join(extra)} は使えません(fixed 用のキーです)。")
layout: SequentialLayout | FixedLayout = _parse_sequential(raw, where)
elif layout_name == LAYOUT_FIXED:
extra = sorted(_SEQUENTIAL_ONLY_KEYS & raw.keys())
if extra:
raise MappingConfigError(f"{where}: layout: fixed では {'、'.join(extra)} は使えません(sequential 用のキーです)。")
layout = _parse_fixed(raw, where, dictionary)
else:
raise MappingConfigError(
f"{where}: layout は「{LAYOUT_SEQUENTIAL}」(順番に並べる)か「{LAYOUT_FIXED}」(部屋ごとに固定の欄)のどちらかです: {layout_name!r}"
)
match = _parse_match(raw.get("match"), where)
return TemplateMapping(id=template_id, name=name, sheet=sheet, layout=layout, match=match)
def _parse_sequential(raw: dict[str, Any], where: str) -> SequentialLayout:
for key in ("start_cell", "max_count"):
if key not in raw:
raise MappingConfigError(f"{where}: layout: sequential には「{key}:」が必要です。")
try:
start = normalize_cell(raw["start_cell"])
except MappingError as exc:
raise MappingConfigError(f"{where}: start_cell(書き込み開始セル)の指定が不正です。{exc}") from None
direction = raw.get("direction", DIRECTION_DOWN)
if direction not in (DIRECTION_DOWN, DIRECTION_RIGHT):
raise MappingConfigError(f"{where}: direction は「down」(下へ)か「right」(右へ)です: {direction!r}")
max_count = raw["max_count"]
if isinstance(max_count, bool) or not isinstance(max_count, int) or max_count < 1:
raise MappingConfigError(f"{where}: max_count(欄の数)は1以上の整数で書いてください: {max_count!r}")
column, row = split_cell(start)
last_col = column_index_from_string(column) + (max_count - 1 if direction == DIRECTION_RIGHT else 0)
last_row = row + (max_count - 1 if direction == DIRECTION_DOWN else 0)
if last_col > MAX_EXCEL_COLUMN or last_row > MAX_EXCEL_ROW:
raise MappingConfigError(f"{where}: {start}から{max_count}個の欄がExcelのシートの範囲を超えます。")
return SequentialLayout(start_cell=start, direction=direction, max_count=max_count)
def _parse_fixed(raw: dict[str, Any], where: str, dictionary: RoomDictionary | None) -> FixedLayout:
cells = raw.get("cells")
if not isinstance(cells, dict) or not cells:
raise MappingConfigError(f"{where}: layout: fixed には「cells:」の下に「部屋名: セル番地」を1つ以上書いてください。")
on_unmatched = raw.get("on_unmatched", ON_UNMATCHED_ERROR)
if on_unmatched not in (ON_UNMATCHED_ERROR, ON_UNMATCHED_SKIP):
raise MappingConfigError(f"{where}: on_unmatched は「error」か「skip」です: {on_unmatched!r}")
slots: list[FixedSlot] = []
cell_owner: dict[str, str] = {}
key_owner: dict[str, str] = {}
for label, raw_cell in cells.items():
if not isinstance(label, str) or not label.strip():
# 「1:」「yes:」のようなキーはYAMLで数値・真偽値として読まれてしまう
raise MappingConfigError(f"{where}: cells の部屋名 {label!r} は文字列にしてください(必要なら「\"1\":」のように引用符で囲みます)。")
try:
cell = normalize_cell(raw_cell)
except MappingError as exc:
raise MappingConfigError(f"{where}: cells の「{label}」: {exc}") from None
if cell in cell_owner:
raise MappingConfigError(f"{where}: セル {cell} が「{cell_owner[cell]}」と「{label}」の両方に指定されています。")
cell_owner[cell] = label
key = room_key(label, dictionary)
if key in key_owner:
raise MappingConfigError(
f"{where}: 「{key_owner[key]}」と「{label}」は部屋名辞書で同じ部屋({key})になるため、どちらの欄に書くか決められません。"
)
key_owner[key] = label
slots.append(FixedSlot(label=label, cell=cell))
return FixedLayout(slots=tuple(slots), on_unmatched=on_unmatched)
def _parse_match(raw: Any, where: str) -> TemplateMatch:
if raw is None:
return TemplateMatch()
if not isinstance(raw, dict):
raise MappingConfigError(f"{where}: match には「file_name:」「marker:」を書いてください。")
_check_keys(raw, _MATCH_KEYS, required=set(), where=f"{where} の match")
file_names: tuple[str, ...] = ()
if "file_name" in raw:
value = raw["file_name"]
values = [value] if isinstance(value, str) else value
if not isinstance(values, list) or not values or not all(isinstance(v, str) and v.strip() for v in values):
raise MappingConfigError(f"{where}: match.file_name はファイル名のパターン(例:\"部屋一覧*.xlsx\")かそのリストです。")
file_names = tuple(values)
marker_cell = marker_text = None
if "marker" in raw:
marker = raw["marker"]
if not isinstance(marker, dict):
raise MappingConfigError(f"{where}: match.marker には「cell:」と「contains:」を書いてください。")
_check_keys(marker, _MARKER_KEYS, required=_MARKER_KEYS, where=f"{where} の match.marker")
try:
marker_cell = normalize_cell(marker["cell"])
except MappingError as exc:
raise MappingConfigError(f"{where}: match.marker.cell: {exc}") from None
if not isinstance(marker["contains"], str) or not marker["contains"].strip():
raise MappingConfigError(f"{where}: match.marker.contains には目印の文字を書いてください。")
marker_text = marker["contains"]
return TemplateMatch(file_names=file_names, marker_cell=marker_cell, marker_text=marker_text)
def _check_keys(raw: dict[Any, Any], allowed: set[str], *, required: set[str], where: str) -> None:
unknown = [str(k) for k in raw if k not in allowed]
if unknown:
raise MappingConfigError(
f"{where}: 知らないキーがあります: {'、'.join(unknown)}(書き間違いでないか確認してください。使えるキー:{'、'.join(sorted(allowed))})"
)
missing = sorted(required - raw.keys())
if missing:
raise MappingConfigError(f"{where}: 必須のキーがありません: {'、'.join(missing)}")
def _require_text(raw: dict[str, Any], key: str, where: str) -> str:
value = raw.get(key)
if not isinstance(value, str) or not value.strip():
raise MappingConfigError(f"{where}: {key} は空でない文字列で書いてください: {value!r}")
return value.strip()
def _check_duplicate_keys(text: str, where: str) -> None:
"""同じ階層に同じキーが2回あると、`yaml.safe_load()` は黙って後の値で上書きする。
設定の書き写しミス(「寝室1: C7」を2行書いた等)に気付けるよう、値を作る前の
構文木(`yaml.compose()`。Pythonオブジェクトは作らない)で重複を調べる。
"""
root = yaml.compose(text, Loader=yaml.SafeLoader)
stack = [root] if root is not None else []
visited: set[int] = set()
while stack:
node = stack.pop()
if id(node) in visited:
continue
visited.add(id(node))
if isinstance(node, yaml.MappingNode):
seen: dict[str, int] = {}
for key_node, value_node in node.value:
if isinstance(key_node, yaml.ScalarNode):
line = key_node.start_mark.line + 1
if key_node.value in seen:
raise MappingConfigError(
f"{where}: キー「{key_node.value}」が同じ場所に2回書かれています({seen[key_node.value]}行目と{line}行目)。"
)
seen[key_node.value] = line
stack.append(value_node)
elif isinstance(node, yaml.SequenceNode):
stack.extend(node.value)
# --- テンプレートの識別 -----------------------------------------------------------
def identify_template(config: MappingConfig, template_path: str | Path) -> TemplateMapping:
"""選んだテンプレートに使う設定を、設定ファイルの上から順に調べて選ぶ。
条件:`match.file_name` のどれかにファイル名が合う(書いてあれば)、`sheet` のシートがある、
`match.marker` のセルに目印の文字が入っている(書いてあれば)。
ファイル名は合ったのにシートが無い場合は、設定の書き間違いの可能性が高いのでその場でエラーにする。
"""
template = Path(template_path)
sheets, markers = _read_template_outline(template, config)
reasons: list[str] = []
for mapping in config.templates:
name_given = bool(mapping.match.file_names)
if name_given and not _file_name_matches(template.name, mapping.match.file_names):
reasons.append(f"・{mapping.id}:ファイル名が {'/'.join(mapping.match.file_names)} に合いません")
continue
if mapping.sheet not in sheets:
message = f"シート「{mapping.sheet}」がテンプレートにありません(あるシート:{'、'.join(sheets)})"
if name_given:
raise MappingError(f"設定「{mapping.id}」はファイル名が合いましたが、{message}。設定の sheet を確認してください。")
reasons.append(f"・{mapping.id}:{message}")
continue
if mapping.match.marker_cell is not None and mapping.match.marker_text is not None:
found = markers.get((mapping.sheet, mapping.match.marker_cell), "")
if mapping.match.marker_text not in found:
reasons.append(f"・{mapping.id}:{mapping.match.marker_cell} に「{mapping.match.marker_text}」がありません")
continue
return mapping
source = config.path.name if config.path is not None else "設定ファイル"
raise TemplateNotMatchedError(
f"テンプレート「{template.name}」に当てはまる設定が {source} にありません。\n" + "\n".join(reasons)
)
def _file_name_matches(file_name: str, patterns: Sequence[str]) -> bool:
# Windowsのファイル名は大文字・小文字を区別しないため、そろえてから比べる
name = unicodedata.normalize("NFKC", file_name).casefold()
return any(fnmatch.fnmatchcase(name, unicodedata.normalize("NFKC", p).casefold()) for p in patterns)
def _read_template_outline(template: Path, config: MappingConfig) -> tuple[list[str], dict[tuple[str, str], str]]:
"""テンプレートのシート名の一覧と、設定に書かれた目印のセルの文字を読む(読み取り専用で開いてすぐ閉じる)。"""
if not template.is_file():
raise MappingError(f"Excelテンプレートが見つかりません: {template}")
try:
workbook = load_workbook(template, read_only=True)
except (InvalidFileException, zipfile.BadZipFile, KeyError, OSError) as exc:
raise MappingError(f"Excelテンプレートを開けません(壊れているか、Excel形式ではありません): {template.name}") from exc
try:
sheets = list(workbook.sheetnames)
markers: dict[tuple[str, str], str] = {}
for mapping in config.templates:
cell = mapping.match.marker_cell
if cell is not None and mapping.sheet in sheets:
value = workbook[mapping.sheet][cell].value
markers[(mapping.sheet, cell)] = "" if value is None else str(value)
return sheets, markers
finally:
workbook.close()
# --- 書き込み計画 ------------------------------------------------------------
def plan_cells(
mapping: TemplateMapping, names: Sequence[str], dictionary: RoomDictionary | None = None
) -> CellPlan:
"""確認済みの部屋名を、設定に従ってどのセルへ書くかを決める(まだ何も書かない)。"""
if isinstance(mapping.layout, SequentialLayout):
return CellPlan(assignments=_plan_sequential(mapping.layout, names), skipped=[])
return _plan_fixed(mapping.layout, names, dictionary)
def _plan_sequential(layout: SequentialLayout, names: Sequence[str]) -> list[CellAssignment]:
if len(names) > layout.max_count:
way = "下へ" if layout.direction == DIRECTION_DOWN else "右へ"
raise MappingError(
f"部屋名が{len(names)}件あり、テンプレートの記入欄({layout.start_cell}から{way}{layout.max_count}個)に収まりません。"
)
return [CellAssignment(cell=cell, name=name) for cell, name in zip(layout.cells(), names, strict=False)]
def _plan_fixed(layout: FixedLayout, names: Sequence[str], dictionary: RoomDictionary | None) -> CellPlan:
slots: dict[str, FixedSlot] = {}
for slot in layout.slots:
key = room_key(slot.label, dictionary)
if key in slots:
raise MappingError(f"設定の「{slots[key].label}」と「{slot.label}」が同じ部屋({key})になり、欄を決められません。")
slots[key] = slot
assignments: list[CellAssignment] = []
skipped: list[str] = []
used: dict[str, str] = {}
unmatched: list[str] = []
for name in names:
key = room_key(name, dictionary)
slot = slots.get(key)
if slot is None:
unmatched.append(name if key == unicodedata.normalize("NFKC", name).strip() else f"{name}({key})")
continue
if slot.cell in used:
raise MappingError(f"「{used[slot.cell]}」と「{name}」が同じ欄({slot.label}:{slot.cell})になります。どちらかの名前を確認画面で直してください。")
used[slot.cell] = name
assignments.append(CellAssignment(cell=slot.cell, name=name))
if unmatched:
if layout.on_unmatched == ON_UNMATCHED_ERROR:
labels = "、".join(s.label for s in layout.slots)
raise MappingError(
f"次の部屋名を書き込む欄が設定にありません:{'、'.join(unmatched)}\n"
f"(設定にある欄:{labels})確認画面で名前を直すか、設定ファイルの cells に追加してください。"
)
skipped = unmatched
# 完了メッセージが様式の並び順になるよう、設定に書いた欄の順に並べ直す
order = {slot.cell: i for i, slot in enumerate(layout.slots)}
assignments.sort(key=lambda a: order[a.cell])
return CellPlan(assignments=assignments, skipped=skipped)
def describe_mapping(mapping: TemplateMapping) -> str:
"""画面に表示する設定の説明(例:「部屋一覧/シート「部屋一覧」・C5から下へ最大10個」)。"""
layout = mapping.layout
if isinstance(layout, SequentialLayout):
way = "下へ" if layout.direction == DIRECTION_DOWN else "右へ"
detail = f"{layout.start_cell}から{way}最大{layout.max_count}個"
else:
detail = f"部屋ごとの固定欄{len(layout.slots)}か所"
return f"{mapping.name}/シート「{mapping.sheet}」・{detail}"
第7回の excel_writer.py は、欄の割り当てを mapping.py に任せる形に変えます。CellAssignment も mapping.py へ移します(excel_writer からも今までどおり読み込めます)。
app/core/excel_writer.py に次の変更を加えます(+ が追加、- が削除)。
app/core/excel_writer.py の差分(194行)
--- a/app/core/excel_writer.py
+++ b/app/core/excel_writer.py
@@ -5,9 +5,9 @@
既存のテンプレートを開いて、決まったセルへ部屋名を「値だけ」書き込み、
**元のテンプレートとは別のファイル名で**保存する。
-書き込み先のセル(部屋名とセル位置の対応)は、まずは「シート『部屋一覧』のC5から
-下へ順に、最大10行」という簡単な決め方にしている(`assign_cells()`)。取引先ごとに
-様式が違う場合に設定ファイルで変えられるようにするのは第8回で扱う。
+書き込み先のセル(部屋名とセル位置の対応)は、第8回から `app/core/mapping.py` の
+設定(`TemplateMapping`)で決める。設定を渡さない場合は第7回と同じ既定
+(シート「部屋一覧」のC5から下へ順に、最大10行)で書き込む。
書き込みの前に、次のことを全件まとめて確認し、1件でも問題があれば
何も書き込まずに `ExcelWriteError` を送出する(途中まで書いたファイルを残さない)。
@@ -28,22 +28,43 @@ import os
import unicodedata
import zipfile
from collections.abc import Sequence
-from dataclasses import dataclass
+from dataclasses import dataclass, field
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.utils.exceptions import InvalidFileException
from openpyxl.worksheet.worksheet import Worksheet
+from app.core.mapping import (
+ DEFAULT_MAPPING,
+ DIRECTION_DOWN,
+ CellAssignment,
+ MappingError,
+ SequentialLayout,
+ TemplateMapping,
+ normalize_cell,
+ plan_cells,
+)
+from app.core.mapping import (
+ DEFAULT_MAX_COUNT as MAPPING_DEFAULT_MAX_COUNT,
+)
+from app.core.mapping import (
+ DEFAULT_SHEET_NAME as MAPPING_DEFAULT_SHEET_NAME,
+)
+from app.core.mapping import (
+ DEFAULT_START_CELL as MAPPING_DEFAULT_START_CELL,
+)
from app.core.review_model import FORMULA_PREFIXES, MAX_NAME_LENGTH, ReviewedRoom
+from app.core.room_matcher import RoomDictionary
-#: 転記先のシート名・書き込み開始セル・記入欄の行数(架空テンプレート `samples/room_list_template.xlsx` に合わせた既定)
-DEFAULT_SHEET_NAME = "部屋一覧"
-DEFAULT_START_CELL = "C5"
-DEFAULT_MAX_ROWS = 10
+__all__ = ["CellAssignment"] # 第7回からの呼び出し元のため、ここからもimportできるようにしておく
+
+#: 設定ファイルを使わないときの既定(第7回と同じ。値は `mapping.DEFAULT_MAPPING` と共通)
+DEFAULT_SHEET_NAME = MAPPING_DEFAULT_SHEET_NAME
+DEFAULT_START_CELL = MAPPING_DEFAULT_START_CELL
+DEFAULT_MAX_ROWS = MAPPING_DEFAULT_MAX_COUNT
#: 既定の出力ファイル名に付ける文字(例:room_list_template_転記_20260209-100000.xlsx)
OUTPUT_LABEL = "転記"
#: マクロ付きブックの拡張子。マクロ(vbaProject.bin)を残したまま読み書きする
@@ -62,14 +83,6 @@ class CellNotEmptyError(ExcelWriteError):
self.cells = cells
-@dataclass(frozen=True)
-class CellAssignment:
- """部屋名1件の書き込み先(セル番地と書き込む値)。"""
-
- cell: str
- name: str
-
-
@dataclass(frozen=True)
class ExcelWriteResult:
"""転記の結果(完了メッセージ・作業記録に使う)。"""
@@ -80,6 +93,10 @@ class ExcelWriteResult:
assignments: list[CellAssignment]
#: 既に値が入っていて上書きしたセル(`overwrite=True` のときだけ)
overwritten: list[str]
+ #: 使った対応付けの設定(第8回)
+ mapping: TemplateMapping = DEFAULT_MAPPING
+ #: 設定の `on_unmatched: skip` により書き込まなかった部屋名(第8回)
+ skipped: list[str] = field(default_factory=list)
def check_cell_text(text: str) -> str:
@@ -111,23 +128,27 @@ def assign_cells(
start_cell: str = DEFAULT_START_CELL,
max_rows: int = DEFAULT_MAX_ROWS,
) -> list[CellAssignment]:
- """部屋名を上から順に、`start_cell` から同じ列の下方向のセルへ割り当てる。
+ """部屋名を上から順に、`start_cell` から同じ列の下方向のセルへ割り当てる(第7回の関数)。
- 例:`["居間", "寝室1"]` → C5=居間、C6=寝室1。確認画面で確定した一覧は図面を読む順
- (上→下、左→右)に並んでいるので、その順に割り当てる。欄の数を超える場合はエラー。
- この決め方は第8回で設定ファイル(YAML)に置き換える。
+ 例:`["居間", "寝室1"]` → C5=居間、C6=寝室1。第8回からは `mapping.plan_cells()` の
+ 「順番に並べる型(sequential)」で同じことをしており、この関数はその呼び出しに置き換えた。
"""
+ layout = _sequential_layout(start_cell, max_rows)
+ mapping = TemplateMapping(id="custom", name="custom", sheet=DEFAULT_SHEET_NAME, layout=layout)
+ try:
+ return plan_cells(mapping, names).assignments
+ except MappingError as exc:
+ raise ExcelWriteError(str(exc)) from None
+
+
+def _sequential_layout(start_cell: str, max_rows: int) -> SequentialLayout:
if max_rows < 1:
raise ExcelWriteError(f"記入欄の行数が不正です: {max_rows}")
try:
- column, first_row = coordinate_from_string(start_cell.upper())
- except (CellCoordinatesException, ValueError):
+ start = normalize_cell(start_cell)
+ except MappingError:
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)]
+ return SequentialLayout(start_cell=start, direction=DIRECTION_DOWN, max_count=max_rows)
def default_output_path(template_path: str | Path, *, now: datetime | None = None) -> Path:
@@ -156,10 +177,15 @@ def write_rooms_to_excel(
start_cell: str = DEFAULT_START_CELL,
max_rows: int = DEFAULT_MAX_ROWS,
overwrite: bool = False,
+ mapping: TemplateMapping | None = None,
+ dictionary: RoomDictionary | None = None,
) -> ExcelWriteResult:
"""確認済みの部屋名をテンプレートの決まった欄へ書き込み、別名で保存する。
- - 書き込み先は `sheet_name` のシートの `start_cell` から下へ順に(最大 `max_rows` 行)
+ - `mapping`(第8回)を渡すと、その設定のシート・欄の決め方で書き込む。部屋ごとに
+ 固定の欄がある設定では、`dictionary`(部屋名辞書)で表記ゆれをそろえて欄を探す。
+ `mapping` を省略した場合は `sheet_name`・`start_cell`・`max_rows`(既定は第7回と同じ
+ 「部屋一覧のC5から下へ最大10行」)で順番に並べる
- `output_path` を省略すると `default_output_path()` の名前で保存する
- 元のテンプレートと同じパス・既に存在するファイルには保存しない
- 書き込むのはセルの値だけ。書式・数式・結合・列幅などには触れない
@@ -173,7 +199,17 @@ def write_rooms_to_excel(
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)
+ if mapping is None:
+ layout = _sequential_layout(start_cell, max_rows)
+ mapping = TemplateMapping(id=DEFAULT_MAPPING.id, name=DEFAULT_MAPPING.name, sheet=sheet_name, layout=layout)
+ try:
+ plan = plan_cells(mapping, names, dictionary)
+ except MappingError as exc:
+ raise ExcelWriteError(str(exc)) from None
+ assignments = plan.assignments
+ if not assignments:
+ raise ExcelWriteError("設定に合う欄が1つも無いため、書き込む部屋名がありません。")
+ sheet_name = mapping.sheet
workbook = _load_template(template)
try:
@@ -194,6 +230,8 @@ def write_rooms_to_excel(
sheet_name=sheet_name,
assignments=assignments,
overwritten=overwritten,
+ mapping=mapping,
+ skipped=plan.skipped,
)
@@ -203,11 +241,16 @@ def describe_result(result: ExcelWriteResult) -> str:
f"保存先:{result.output_path}",
f"元のテンプレート:{result.template_path.name}(変更していません)",
f"シート:{result.sheet_name}",
- "",
]
+ if result.mapping.id != DEFAULT_MAPPING.id:
+ lines.append(f"転記の設定:{result.mapping.name}")
+ lines.append("")
for assignment in result.assignments:
mark = "(上書き)" if assignment.cell in result.overwritten else ""
lines.append(f"{assignment.cell}:{assignment.name}{mark}")
+ if result.skipped:
+ lines.append("")
+ lines.append(f"欄が無いため書き込まなかった部屋名:{'、'.join(result.skipped)}")
return "\n".join(lines)
メイン画面には「2-2. 転記の設定ファイル」の選択欄を追加し、「6. 実行」でテンプレートに合う設定を選んで書き込むようにします。
app/ui/main_window.py に次の変更を加えます(+ が追加、- が削除)。
app/ui/main_window.py の差分(237行)
--- a/app/ui/main_window.py
+++ b/app/ui/main_window.py
@@ -28,6 +28,10 @@ AI(Anthropic Claude)へ送り、部屋名だけをJSONで受け取る。送
選んだExcelテンプレートの決まった欄(シート「部屋一覧」のC5から下へ順に)へ書き込み、
元のテンプレートは変えずに、同じフォルダへ日時入りの別名で保存する。確認画面で
確定していない場合は書き込まない(AI・OCRの結果を人の確認なしに転記しないため)。
+第8回では、「転記の設定ファイル(任意)」の選択欄を追加した。部屋名とExcelの欄の
+対応を書いたYAML(`app/config/mapping.example.yaml` を参考に作る)を選ぶと、
+`app/core/mapping.py` が選んだExcelテンプレートに合う設定を探し、その設定の
+シート・欄へ書き込む。設定ファイルを選ばなければ第7回と同じ既定の動作になる。
"""
from __future__ import annotations
@@ -44,6 +48,15 @@ from app.core.excel_writer import (
write_rooms_to_excel,
)
from app.core.file_selection import FileSelectionError, SelectedFiles, validate_excel_path, validate_pdf_path
+from app.core.mapping import (
+ DEFAULT_MAPPING,
+ MappingConfig,
+ MappingError,
+ TemplateMapping,
+ describe_mapping,
+ identify_template,
+ load_mapping_config,
+)
from app.core.ocr_ai import (
SEND_CONFIRMATION_TITLE,
AiOcrError,
@@ -62,10 +75,14 @@ from app.ui.preview_canvas import PreviewCanvas
from app.ui.review_dialog import open_review_dialog
WINDOW_TITLE = "間取りOCR転記ツール"
-WINDOW_SIZE = "760x820"
+WINDOW_SIZE = "760x880"
PDF_FILETYPES = [("PDFファイル", "*.pdf")]
EXCEL_FILETYPES = [("Excelファイル", "*.xlsx *.xlsm")]
+MAPPING_FILETYPES = [("転記の設定ファイル(YAML)", "*.yaml *.yml")]
+
+#: 設定ファイルを選んでいないときの表示(第7回と同じ既定の動作)
+MAPPING_NOT_SELECTED = "未選択(既定:シート「部屋一覧」のC5から下へ順に最大10行。第7回と同じ)"
#: 読み取り方式(第5回)。既定はローカル完結(図面を社外に送らない)
READ_MODE_LOCAL = "local"
@@ -92,6 +109,11 @@ class MainWindow(ttk.Frame):
self._last_detection: tuple[list[ExtractedWord], list[RoomCandidate], str, int] | None = None
self.reviewed_rooms: list[ReviewedRoom] | None = None
+ # 転記の設定ファイル(第8回)。未選択なら第7回と同じ既定の対応付けで書き込む
+ self.mapping_config: MappingConfig | None = None
+ self.mapping_path_var = tk.StringVar(value=MAPPING_NOT_SELECTED)
+ self.mapping_status_var = tk.StringVar(value="")
+
# 部屋名辞書はアプリ起動時に1回だけ読み込み、ボタンを押すたびに使い回す
# (`app/config/rooms.yaml` を毎回読み直す必要はないため)。読み込みに
# 失敗した場合(辞書ファイルが壊れている等)はエラーダイアログを出し、
@@ -112,7 +134,7 @@ class MainWindow(ttk.Frame):
def _build_widgets(self) -> None:
self.columnconfigure(0, weight=1)
- self.rowconfigure(10, weight=1)
+ self.rowconfigure(12, weight=1)
ttk.Label(self, text="1. CAD図面PDFを選択").grid(row=0, column=0, sticky="w")
ttk.Button(self, text="PDFを選ぶ...", command=self._on_choose_pdf).grid(row=0, column=1, padx=8)
@@ -126,8 +148,21 @@ class MainWindow(ttk.Frame):
row=3, column=0, columnspan=2, sticky="w", pady=(0, 12)
)
+ ttk.Label(self, text="2-2. 転記の設定ファイル(任意・YAML。テンプレートごとの欄の対応)").grid(
+ row=4, column=0, sticky="w"
+ )
+ mapping_buttons = ttk.Frame(self)
+ mapping_buttons.grid(row=4, column=1, padx=8)
+ ttk.Button(mapping_buttons, text="設定を選ぶ...", command=self._on_choose_mapping).pack(side="left")
+ ttk.Button(mapping_buttons, text="既定に戻す", command=self._on_reset_mapping).pack(side="left", padx=(4, 0))
+ mapping_info = ttk.Frame(self)
+ mapping_info.grid(row=5, column=0, columnspan=2, sticky="w", pady=(0, 12))
+ ttk.Label(mapping_info, textvariable=self.mapping_path_var, foreground="#555555").pack(anchor="w")
+ self.mapping_status_label = ttk.Label(mapping_info, textvariable=self.mapping_status_var, foreground="#1f5fbf")
+ self.mapping_status_label.pack(anchor="w")
+
mode_frame = ttk.Frame(self)
- mode_frame.grid(row=4, column=0, columnspan=2, sticky="ew", pady=(0, 4))
+ mode_frame.grid(row=6, column=0, columnspan=2, sticky="ew", pady=(0, 4))
ttk.Label(mode_frame, text="読み取り方式:").pack(side="left")
ttk.Radiobutton(
mode_frame,
@@ -148,7 +183,7 @@ class MainWindow(ttk.Frame):
command=self._on_detect_text,
state="disabled",
)
- self.detect_text_button.grid(row=5, column=0, columnspan=2, sticky="ew", pady=(4, 4))
+ self.detect_text_button.grid(row=7, column=0, columnspan=2, sticky="ew", pady=(4, 4))
self.filter_room_button = ttk.Button(
self,
@@ -156,7 +191,7 @@ class MainWindow(ttk.Frame):
command=self._on_filter_room_candidates,
state="disabled",
)
- self.filter_room_button.grid(row=6, column=0, columnspan=2, sticky="ew", pady=(4, 4))
+ self.filter_room_button.grid(row=8, column=0, columnspan=2, sticky="ew", pady=(4, 4))
self.review_button = ttk.Button(
self,
@@ -164,22 +199,22 @@ class MainWindow(ttk.Frame):
command=self._on_open_review,
state="disabled",
)
- self.review_button.grid(row=7, column=0, columnspan=2, sticky="ew", pady=(4, 4))
+ self.review_button.grid(row=9, 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.run_button.grid(row=8, column=0, columnspan=2, sticky="ew", pady=(4, 12))
+ self.run_button.grid(row=10, column=0, columnspan=2, sticky="ew", pady=(4, 12))
ttk.Label(self, textvariable=self.status_var, foreground="#1a6b2a").grid(
- row=9, column=0, columnspan=2, sticky="w"
+ row=11, column=0, columnspan=2, sticky="w"
)
ttk.Label(self, text="図面プレビュー(赤枠:検出した単語すべて/青枠:部屋名候補)").grid(
- row=10, column=0, sticky="nw", pady=(12, 0)
+ row=12, column=0, sticky="nw", pady=(12, 0)
)
self.preview = PreviewCanvas(self)
- self.preview.grid(row=10, column=0, columnspan=2, sticky="nsew", pady=(28, 0))
+ self.preview.grid(row=12, column=0, columnspan=2, sticky="nsew", pady=(28, 0))
def _on_choose_pdf(self) -> None:
path = filedialog.askopenfilename(title="CAD図面PDFを選択", filetypes=PDF_FILETYPES)
@@ -211,8 +246,58 @@ class MainWindow(ttk.Frame):
return
self.selected = self.selected.with_excel(validated)
self.excel_path_var.set(str(validated))
+ self._refresh_mapping_status()
self._refresh_buttons()
+ def _on_choose_mapping(self) -> None:
+ """転記の設定ファイル(YAML)を選び、その場で内容を検証する(第8回)。
+
+ 書き間違い(必須キーの欠落・不正なセル番地・同じセルの重複など)は、転記を
+ 実行する前のこの時点でエラーダイアログに出す。
+ """
+ path = filedialog.askopenfilename(title="転記の設定ファイルを選択", filetypes=MAPPING_FILETYPES)
+ if not path:
+ return
+ try:
+ config = load_mapping_config(path, self._room_dictionary)
+ except MappingError as exc:
+ messagebox.showerror("転記の設定ファイルのエラー", str(exc))
+ return
+ self.mapping_config = config
+ self.mapping_path_var.set(f"{path}({len(config.templates)}種類のテンプレートの設定)")
+ self._refresh_mapping_status()
+
+ def _on_reset_mapping(self) -> None:
+ """設定ファイルの選択を外し、第7回と同じ既定の対応付けに戻す。"""
+ self.mapping_config = None
+ self.mapping_path_var.set(MAPPING_NOT_SELECTED)
+ self._refresh_mapping_status()
+
+ def _refresh_mapping_status(self) -> None:
+ """選んだExcelテンプレートにどの設定が使われるかを表示する。"""
+ template = self.selected.excel_path
+ if self.mapping_config is None or template is None:
+ self.mapping_status_var.set("")
+ return
+ try:
+ mapping = identify_template(self.mapping_config, template)
+ except MappingError as exc:
+ self.mapping_status_label.configure(foreground="#b00020")
+ self.mapping_status_var.set("このテンプレートに使える設定がありません:" + str(exc).splitlines()[0])
+ return
+ self.mapping_status_label.configure(foreground="#1f5fbf")
+ self.mapping_status_var.set(f"使う設定:{describe_mapping(mapping)}")
+
+ def _resolve_mapping(self, template: Path) -> TemplateMapping | None:
+ """転記に使う設定を決める。設定ファイル未選択なら既定、合う設定が無ければエラー表示して `None`。"""
+ if self.mapping_config is None:
+ return DEFAULT_MAPPING
+ try:
+ return identify_template(self.mapping_config, template)
+ except MappingError as exc:
+ messagebox.showerror("転記の設定エラー", str(exc))
+ return None
+
def _refresh_run_button(self) -> None:
if self.selected.is_ready():
self.run_button.configure(state="normal")
@@ -425,8 +510,13 @@ class MainWindow(ttk.Frame):
detail="AI・OCRの読み取り結果を、人の確認を通さずにExcelへ書き込まないためです。",
)
return
+ mapping = self._resolve_mapping(template) # 第8回:テンプレートに合う設定を選ぶ
+ if mapping is None:
+ return
try:
- result = write_rooms_to_excel(template, self.reviewed_rooms)
+ result = write_rooms_to_excel(
+ template, self.reviewed_rooms, mapping=mapping, dictionary=self._room_dictionary
+ )
except CellNotEmptyError as exc:
if not messagebox.askyesno(
"記入欄に値が入っています",
@@ -437,7 +527,7 @@ class MainWindow(ttk.Frame):
):
self.status_var.set("転記を取りやめました(ファイルは作成していません)。")
return
- result = self._write_excel(template, overwrite=True)
+ result = self._write_excel(template, mapping, overwrite=True)
except ExcelWriteError as exc:
messagebox.showerror("Excel転記エラー", str(exc))
return
@@ -450,10 +540,16 @@ class MainWindow(ttk.Frame):
)
self.status_var.set(f"Excelへ転記しました:{result.output_path.name}(元のテンプレートは変更していません)")
- def _write_excel(self, template: Path, *, overwrite: bool) -> ExcelWriteResult | None:
+ def _write_excel(self, template: Path, mapping: TemplateMapping, *, overwrite: bool) -> ExcelWriteResult | None:
"""書き込みを実行し、失敗したらエラーダイアログを出して `None` を返す。"""
try:
- return write_rooms_to_excel(template, self.reviewed_rooms or [], overwrite=overwrite)
+ return write_rooms_to_excel(
+ template,
+ self.reviewed_rooms or [],
+ overwrite=overwrite,
+ mapping=mapping,
+ dictionary=self._room_dictionary,
+ )
except ExcelWriteError as exc:
messagebox.showerror("Excel転記エラー", str(exc))
return None
レイアウトの違う2つ目の架空テンプレート「間取り確認表」も作れるようにします。
tools/make_sample_template.py に次の変更を加えます(+ が追加、- が削除)。
tools/make_sample_template.py の差分(117行)
--- a/tools/make_sample_template.py
+++ b/tools/make_sample_template.py
@@ -14,9 +14,18 @@
転記先は「部屋名」の列(C5〜C14の10行)。第7回ではこの位置をコード内で
上から順に割り当てる(`app/core/excel_writer.py`)。
+第8回で、レイアウトの違う2つ目の架空テンプレート「間取り確認表」
+(`samples/floor_plan_sheet.xlsx`)を追加した。こちらは「部屋種別ごとに記入欄が
+決まっている」様式で、シート「間取り表」のB列に部屋種別(居間・キッチン・寝室1…)が
+あらかじめ印字され、C列(C4〜C13)に図面上の表記を書き込む。D列には
+「C列が空でなければ『有』」という数式が入っている。先頭に「表紙」シートもあり、
+転記先のシートを設定で指定する必要がある。
+
使い方:
python3 tools/make_sample_template.py [<出力先.xlsx>]
(省略時は samples/room_list_template.xlsx)
+ python3 tools/make_sample_template.py --floor-plan [<出力先.xlsx>]
+ (省略時は samples/floor_plan_sheet.xlsx)
"""
from __future__ import annotations
@@ -37,6 +46,15 @@ COUNT_ROW = LAST_ROW + 2 # 16
DEFAULT_OUTPUT = Path(__file__).resolve().parents[1] / "samples" / "room_list_template.xlsx"
+#: 第8回:2つ目の架空テンプレート(部屋種別ごとの固定欄)
+FLOOR_PLAN_SHEET_NAME = "間取り表"
+FLOOR_PLAN_COVER_SHEET_NAME = "表紙"
+FLOOR_PLAN_TITLE = "間取り確認表"
+FLOOR_PLAN_FIRST_ROW = 4
+#: B列に印字する部屋種別。C列の同じ行が記入欄(C4〜C13)
+FLOOR_PLAN_ROOMS = ["居間", "キッチン", "寝室1", "寝室2", "寝室3", "洗面所", "浴室", "トイレ", "玄関", "バルコニー"]
+FLOOR_PLAN_OUTPUT = Path(__file__).resolve().parents[1] / "samples" / "floor_plan_sheet.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")
@@ -105,10 +123,77 @@ def build_template() -> Workbook:
return wb
+def build_floor_plan_template() -> Workbook:
+ """第8回:レイアウトの違う架空の「間取り確認表」テンプレートを作って返す(保存はしない)。"""
+ wb = Workbook()
+ cover = wb.active
+ cover.title = FLOOR_PLAN_COVER_SHEET_NAME
+ cover["A1"] = f"{FLOOR_PLAN_TITLE}(架空の様式・連載の動作確認用)"
+ cover["A1"].font = Font(size=14, bold=True)
+ cover["A3"] = "物件名"
+ cover["A4"] = "作成日"
+ cover.column_dimensions["A"].width = 12
+ cover.column_dimensions["B"].width = 30
+
+ ws = wb.create_sheet(FLOOR_PLAN_SHEET_NAME)
+ ws["A1"] = FLOOR_PLAN_TITLE
+ ws["A1"].font = Font(size=14, bold=True)
+ ws.merge_cells("A1:E1")
+ ws["A2"] = "図面の部屋名を、該当する部屋種別の行に記入する"
+ ws["A2"].font = Font(size=9, color="555555")
+ ws.merge_cells("A2:E2")
+
+ headers = ["No.", "部屋種別", "図面上の表記", "有無", "備考"]
+ header_row = FLOOR_PLAN_FIRST_ROW - 1
+ for col, text in zip("ABCDE", headers, strict=True):
+ cell = ws[f"{col}{header_row}"]
+ cell.value = text
+ cell.font = Font(bold=True)
+ cell.fill = _HEADER_FILL
+ cell.border = _BORDER
+ cell.alignment = Alignment(horizontal="center", vertical="center")
+
+ last_row = FLOOR_PLAN_FIRST_ROW + len(FLOOR_PLAN_ROOMS) - 1
+ for i, room in enumerate(FLOOR_PLAN_ROOMS):
+ row = FLOOR_PLAN_FIRST_ROW + i
+ ws[f"A{row}"] = i + 1
+ ws[f"A{row}"].alignment = Alignment(horizontal="center")
+ ws[f"B{row}"] = room
+ ws[f"B{row}"].fill = _TOTAL_FILL
+ ws[f"D{row}"] = f'=IF(C{row}="","","有")'
+ ws[f"D{row}"].alignment = Alignment(horizontal="center")
+ for col in "ABCDE":
+ ws[f"{col}{row}"].border = _BORDER
+
+ total_row = last_row + 1
+ ws[f"A{total_row}"] = "記入した部屋数"
+ ws.merge_cells(f"A{total_row}:C{total_row}")
+ ws[f"A{total_row}"].font = Font(bold=True)
+ ws[f"A{total_row}"].alignment = Alignment(horizontal="right")
+ ws[f"D{total_row}"] = f'=COUNTIF(D{FLOOR_PLAN_FIRST_ROW}:D{last_row},"有")'
+ ws[f"D{total_row}"].alignment = Alignment(horizontal="center")
+ for col in "ABCDE":
+ ws[f"{col}{total_row}"].border = _BORDER
+ ws[f"{col}{total_row}"].fill = _TOTAL_FILL
+
+ for col, width in zip("ABCDE", (6, 14, 20, 8, 16), strict=True):
+ ws.column_dimensions[col].width = width
+ ws.row_dimensions[1].height = 24
+ ws.print_area = f"A1:E{total_row}"
+ 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
+ args = argv[1:]
+ floor_plan = "--floor-plan" in args
+ args = [a for a in args if a != "--floor-plan"]
+ default = FLOOR_PLAN_OUTPUT if floor_plan else DEFAULT_OUTPUT
+ out = Path(args[0]) if args else default
out.parent.mkdir(parents=True, exist_ok=True)
- build_template().save(out)
+ (build_floor_plan_template() if floor_plan else build_template()).save(out)
print(f"保存しました: {out}")
python tools/make_sample_template.py --floor-plan
これで samples/floor_plan_sheet.xlsx ができます(第7回の samples/room_list_template.xlsx も、テストで使うので残しておきます)。
設定ファイルの読み込み・書き間違いの検出・テンプレートの識別・2つのテンプレートへの転記を確かめるテストです。
tests/test_mapping.py を新しく作ります(全文)。
tests/test_mapping.py の全文(425行)
# tests/test_mapping.py
"""`app.core.mapping` のテスト(tkinter非依存)。
- `app/config/mapping.example.yaml` を読み込み、部屋名からセル位置が正しく決まること
- 同じ設定ファイルだけで、レイアウトの違う2つの架空テンプレート
(`samples/room_list_template.xlsx`・`samples/floor_plan_sheet.xlsx`)の両方へ書けること
- 設定ファイルの誤り(必須キーの欠落・不正なセル番地・重複・存在しないシートなど)が
分かりやすいメッセージのエラーになること
- 設定を渡さない場合は第7回と同じ結果になること(後方互換)
"""
from __future__ import annotations
import ast
import shutil
from pathlib import Path
import pytest
from openpyxl import load_workbook
from app.core import mapping as mapping_module
from app.core.excel_writer import ExcelWriteError, describe_result, write_rooms_to_excel
from app.core.mapping import (
DEFAULT_MAPPING,
EXAMPLE_MAPPING_PATH,
CellAssignment,
FixedLayout,
MappingConfigError,
MappingError,
SequentialLayout,
TemplateMapping,
TemplateNotMatchedError,
identify_template,
load_mapping_config,
normalize_cell,
parse_mapping_config,
plan_cells,
room_key,
)
from app.core.review_model import SOURCE_EMBEDDED, ReviewedRoom
from app.core.room_matcher import RoomDictionary, load_room_dictionary
from tools.make_sample_template import (
FLOOR_PLAN_ROOMS,
FLOOR_PLAN_SHEET_NAME,
build_floor_plan_template,
build_template,
)
SAMPLES = Path(__file__).resolve().parents[1] / "samples"
@pytest.fixture(scope="module")
def dictionary() -> RoomDictionary:
return load_room_dictionary()
@pytest.fixture(scope="module")
def config(dictionary: RoomDictionary):
return load_mapping_config(EXAMPLE_MAPPING_PATH, dictionary)
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 _write_yaml(tmp_path: Path, text: str) -> Path:
path = tmp_path / "mapping.yaml"
path.write_text(text, encoding="utf-8")
return path
FIXED_YAML = """
templates:
- id: fixed
sheet: 間取り表
layout: fixed
cells:
居間: C4
寝室1: C6
"""
# --- サンプル設定ファイル ------------------------------------------------------
def test_example_config_has_two_layouts(config) -> None:
ids = [t.id for t in config.templates]
assert ids == ["room_list", "floor_plan_sheet"]
assert isinstance(config.templates[0].layout, SequentialLayout)
assert isinstance(config.templates[1].layout, FixedLayout)
def test_example_sequential_setting_equals_the_default_of_part7(config) -> None:
room_list = config.templates[0]
assert room_list.sheet == DEFAULT_MAPPING.sheet
assert room_list.layout == DEFAULT_MAPPING.layout
def test_example_fixed_cells_follow_the_sample_template(config) -> None:
layout = config.templates[1].layout
assert isinstance(layout, FixedLayout)
ws = build_floor_plan_template()[FLOOR_PLAN_SHEET_NAME]
# 設定の「部屋名: セル」の部屋名が、テンプレートの同じ行のB列(印字された部屋種別)と一致する
for slot in layout.slots:
assert ws[f"B{slot.cell[1:]}"].value == slot.label
assert [s.label for s in layout.slots] == FLOOR_PLAN_ROOMS
def test_sample_templates_are_identified(config) -> None:
assert identify_template(config, SAMPLES / "room_list_template.xlsx").id == "room_list"
assert identify_template(config, SAMPLES / "floor_plan_sheet.xlsx").id == "floor_plan_sheet"
# --- 設定だけで2つのテンプレートへ書ける -----------------------------------------
def test_same_config_writes_to_both_templates(config, dictionary: RoomDictionary, tmp_path: Path) -> None:
names = ["居間", "寝室1", "キッチン", "洗面所"]
results = {}
for file_name in ("room_list_template.xlsx", "floor_plan_sheet.xlsx"):
template = tmp_path / file_name
shutil.copy(SAMPLES / file_name, template)
mapping = identify_template(config, template)
results[file_name] = write_rooms_to_excel(template, _rooms(names), mapping=mapping, dictionary=dictionary)
room_list = load_workbook(results["room_list_template.xlsx"].output_path)["部屋一覧"]
assert [room_list[f"C{r}"].value for r in range(5, 10)] == [*names, None]
floor_plan = load_workbook(results["floor_plan_sheet.xlsx"].output_path)[FLOOR_PLAN_SHEET_NAME]
written = {floor_plan[f"B{r}"].value: floor_plan[f"C{r}"].value for r in range(4, 14)}
assert written == {
"居間": "居間",
"キッチン": "キッチン",
"寝室1": "寝室1",
"寝室2": None,
"寝室3": None,
"洗面所": "洗面所",
"浴室": None,
"トイレ": None,
"玄関": None,
"バルコニー": None,
}
# D列の数式(C列が空でなければ「有」)は数式のまま残る
assert floor_plan["D4"].value == '=IF(C4="","","有")'
assert floor_plan["D14"].data_type == "f"
# 表紙シートには何も書かない
assert load_workbook(results["floor_plan_sheet.xlsx"].output_path)["表紙"]["B3"].value is None
def test_fixed_layout_absorbs_spelling_variants(config, dictionary: RoomDictionary, tmp_path: Path) -> None:
template = tmp_path / "floor_plan_sheet.xlsx"
shutil.copy(SAMPLES / "floor_plan_sheet.xlsx", template)
names = ["リビング", "ベッドルーム2", "寝室1", "DK", "洗面脱衣所", "WC"]
result = write_rooms_to_excel(
template, _rooms(names), mapping=identify_template(config, template), dictionary=dictionary
)
# 様式の並び順(設定に書いた順)で返る。書き込むのは確認済みの名前そのもの
assert result.assignments == [
CellAssignment("C4", "リビング"),
CellAssignment("C5", "DK"),
CellAssignment("C6", "寝室1"),
CellAssignment("C7", "ベッドルーム2"),
CellAssignment("C9", "洗面脱衣所"),
CellAssignment("C11", "WC"),
]
assert "転記の設定:間取り確認表" in describe_result(result)
@pytest.mark.parametrize(
("name", "key"),
[("リビング", "居間"), ("LDK", "居間"), ("ベッドルーム2", "寝室2"), ("寝室1", "寝室1"), ("洗面脱衣室", "洗面脱衣室")],
)
def test_room_key_uses_room_dictionary(dictionary: RoomDictionary, name: str, key: str) -> None:
assert room_key(name, dictionary) == key
def test_unmatched_message_shows_how_the_name_was_read(config, dictionary: RoomDictionary) -> None:
with pytest.raises(MappingError, match="ベッドルーム4(寝室4)"):
plan_cells(config.templates[1], ["ベッドルーム4"], dictionary)
def test_room_key_without_dictionary_only_normalizes() -> None:
assert room_key(" 寝室1 ") == "寝室1"
assert room_key("リビング") == "リビング"
# --- 部屋名とセルの対応付け ---------------------------------------------------
def test_fixed_layout_stops_on_unmatched_names(config, dictionary: RoomDictionary) -> None:
with pytest.raises(MappingError, match="欄が設定にありません:洋室3"):
plan_cells(config.templates[1], ["居間", "洋室3"], dictionary)
def test_fixed_layout_can_skip_unmatched_names(dictionary: RoomDictionary, tmp_path: Path) -> None:
text = FIXED_YAML + " on_unmatched: skip\n"
mapping = parse_mapping_config(text, dictionary=dictionary).templates[0]
plan = plan_cells(mapping, ["居間", "書斎"], dictionary)
assert plan.assignments == [CellAssignment("C4", "居間")]
assert plan.skipped == ["書斎"]
template = tmp_path / "floor.xlsx"
build_floor_plan_template().save(template)
result = write_rooms_to_excel(template, _rooms(["居間", "書斎"]), mapping=mapping, dictionary=dictionary)
assert result.skipped == ["書斎"]
assert "書き込まなかった部屋名:書斎" in describe_result(result)
def test_two_rooms_for_the_same_cell_are_rejected(config, dictionary: RoomDictionary) -> None:
with pytest.raises(MappingError, match="同じ欄"):
plan_cells(config.templates[1], ["居間", "リビング"], dictionary)
def test_sequential_right_direction() -> None:
mapping = TemplateMapping(
id="h", name="h", sheet="s", layout=SequentialLayout(start_cell="B3", direction="right", max_count=3)
)
assert [a.cell for a in plan_cells(mapping, ["a", "b", "c"]).assignments] == ["B3", "C3", "D3"]
with pytest.raises(MappingError, match="B3から右へ3個)に収まりません"):
plan_cells(mapping, ["a", "b", "c", "d"])
def test_sequential_right_crosses_column_z() -> None:
layout = SequentialLayout(start_cell="Y1", direction="right", max_count=3)
assert layout.cells() == ["Y1", "Z1", "AA1"]
def test_write_without_mapping_is_same_as_part7(tmp_path: Path) -> None:
template = tmp_path / "部屋一覧.xlsx"
build_template().save(template)
names = ["居間", "寝室1", "キッチン"]
without = write_rooms_to_excel(template, _rooms(names), output_path=tmp_path / "a.xlsx")
with_default = write_rooms_to_excel(template, _rooms(names), output_path=tmp_path / "b.xlsx", mapping=DEFAULT_MAPPING)
assert without.assignments == with_default.assignments == [
CellAssignment("C5", "居間"),
CellAssignment("C6", "寝室1"),
CellAssignment("C7", "キッチン"),
]
assert without.mapping == DEFAULT_MAPPING
assert "転記の設定" not in describe_result(without)
def test_mapping_error_is_reported_as_excel_write_error(config, dictionary: RoomDictionary, tmp_path: Path) -> None:
template = tmp_path / "floor_plan_sheet.xlsx"
shutil.copy(SAMPLES / "floor_plan_sheet.xlsx", template)
with pytest.raises(ExcelWriteError, match="欄が設定にありません"):
write_rooms_to_excel(template, _rooms(["洋室3"]), mapping=config.templates[1], dictionary=dictionary)
assert [p.name for p in tmp_path.iterdir()] == ["floor_plan_sheet.xlsx"] # 何も保存していない
# --- セル番地 ---------------------------------------------------------------
@pytest.mark.parametrize(("text", "cell"), [("C5", "C5"), ("c5", "C5"), ("C5", "C5"), (" AA10 ", "AA10"), ("XFD1048576", "XFD1048576")])
def test_normalize_cell_accepts(text: str, cell: str) -> None:
assert normalize_cell(text) == cell
@pytest.mark.parametrize("text", ["", "5C", "C0", "$C$5", "C5:C14", "セル", "XFE1", "A1048577", 5, None])
def test_normalize_cell_rejects(text: object) -> None:
with pytest.raises(MappingError):
normalize_cell(text)
# --- 設定ファイルの検証 ---------------------------------------------------------
@pytest.mark.parametrize(
("text", "message"),
[
("", "templates:"),
("templates: []\n", "1つ以上"),
("templates:\n - sheet: 部屋一覧\n layout: sequential\n start_cell: C5\n max_count: 10\n", "必須のキーがありません: id"),
("templates:\n - id: a\n layout: sequential\n start_cell: C5\n max_count: 10\n", "必須のキーがありません: sheet"),
("templates:\n - id: a\n sheet: s\n start_cell: C5\n", "必須のキーがありません: layout"),
("templates:\n - id: a\n sheet: s\n layout: sequential\n max_count: 10\n", "start_cell:」が必要"),
("templates:\n - id: a\n sheet: s\n layout: fixed\n", "cells:」の下に"),
("templates:\n - id: a\n sheet: s\n layout: sequential\n start_cell: 5C\n max_count: 10\n", "開始セル"),
("templates:\n - id: a\n sheet: s\n layout: sequential\n start_cell: C5\n max_count: 0\n", "max_count"),
("templates:\n - id: a\n sheet: s\n layout: sequential\n start_cell: C5\n max_count: true\n", "max_count"),
("templates:\n - id: a\n sheet: s\n layout: sequential\n start_cell: C5\n max_count: 3\n direction: up\n", "direction"),
("templates:\n - id: a\n sheet: s\n layout: grid\n", "layout は"),
("templates:\n - id: a\n sheet: s\n layout: sequential\n start_cel: C5\n max_count: 3\n", "知らないキー.*start_cel"),
("templates:\n - id: a\n sheet: s\n layout: sequential\n start_cell: C5\n max_count: 3\n cells: {居間: C4}\n", "sequential では cells"),
("templates:\n - id: a\n sheet: s\n layout: fixed\n start_cell: C5\n cells: {居間: C4}\n", "fixed では start_cell"),
("templates:\n - id: a\n sheet: s\n layout: fixed\n cells: {居間: C4, 寝室1: c4}\n", "セル C4 が「居間」と「寝室1」の両方"),
("templates:\n - id: a\n sheet: s\n layout: fixed\n cells: {居間: C4, 1: C5}\n", "文字列にしてください"),
("templates:\n - id: a\n sheet: s\n layout: fixed\n cells: {居間: C0}\n", "「居間」: セル番地が不正"),
("templates:\n - id: a\n sheet: s\n layout: fixed\n cells: {居間: C4}\n on_unmatched: ignore\n", "on_unmatched"),
("templates:\n - id: a\n sheet: s\n layout: sequential\n start_cell: C1048570\n max_count: 10\n", "範囲を超えます"),
("templates:\n - id: a\n sheet: s\n layout: fixed\n cells: {居間: C4}\n match: {marker: {cell: A1}}\n", "必須のキーがありません: contains"),
("templates:\n - id: a\n sheet: s\n layout: fixed\n cells: {居間: C4}\n match: {file_name: 3}\n", "file_name"),
("version: 2\ntemplates: []\n", "version"),
],
)
def test_invalid_config_is_reported(text: str, message: str) -> None:
with pytest.raises(MappingConfigError, match=message):
parse_mapping_config(text)
def test_error_message_tells_which_file_and_which_setting(tmp_path: Path) -> None:
path = _write_yaml(tmp_path, "templates:\n - id: ok\n sheet: s\n layout: fixed\n cells: {居間: C4}\n"
" - id: broken\n sheet: s\n layout: fixed\n cells: {居間: Z}\n")
with pytest.raises(MappingConfigError, match=r"mapping.yaml の templates\[1\](id: broken): cells の「居間」"):
load_mapping_config(path)
def test_duplicate_ids_are_rejected() -> None:
text = FIXED_YAML + FIXED_YAML.replace("templates:\n", "")
with pytest.raises(MappingConfigError, match="id「fixed」が2回"):
parse_mapping_config(text)
def test_duplicate_yaml_keys_are_rejected() -> None:
# yaml.safe_load() だけでは、後に書いた「寝室1: C7」で黙って上書きされてしまう
text = FIXED_YAML + " 寝室1: C7\n"
with pytest.raises(MappingConfigError, match="キー「寝室1」が同じ場所に2回書かれています(8行目と9行目)"):
parse_mapping_config(text)
def test_keys_that_mean_the_same_room_are_rejected(dictionary: RoomDictionary) -> None:
text = FIXED_YAML + " リビング: C9\n"
parse_mapping_config(text) # 辞書を使わなければ別の部屋として扱う
with pytest.raises(MappingConfigError, match="「居間」と「リビング」は部屋名辞書で同じ部屋"):
parse_mapping_config(text, dictionary=dictionary)
def test_broken_yaml_is_reported_with_line() -> None:
with pytest.raises(MappingConfigError, match="YAMLとして読み込めません(3行目付近)"):
parse_mapping_config("templates:\n - id: a\n sheet: [s\n")
def test_python_tags_are_not_executed(tmp_path: Path) -> None:
# yaml.safe_load() は !!python/... のタグを受け付けない(任意のコードを実行しない)
marker = tmp_path / "executed"
text = f"templates: !!python/object/apply:os.system ['touch {marker}']\n"
with pytest.raises(MappingConfigError, match="YAMLとして読み込めません"):
parse_mapping_config(text)
assert not marker.exists()
def test_source_uses_safe_load_only() -> None:
# コメント・説明文ではなく、実際の関数呼び出しだけを調べる
tree = ast.parse(Path(mapping_module.__file__).read_text(encoding="utf-8"))
calls = {
node.func.attr
for node in ast.walk(tree)
if isinstance(node, ast.Call)
and isinstance(node.func, ast.Attribute)
and isinstance(node.func.value, ast.Name)
and node.func.value.id == "yaml"
}
assert "safe_load" in calls
assert not calls & {"load", "load_all", "unsafe_load", "full_load"}
def test_missing_or_non_utf8_file(tmp_path: Path) -> None:
with pytest.raises(MappingConfigError, match="見つかりません"):
load_mapping_config(tmp_path / "none.yaml")
sjis = tmp_path / "sjis.yaml"
sjis.write_bytes("templates:\n - id: 居間\n".encode("cp932"))
with pytest.raises(MappingConfigError, match="UTF-8"):
load_mapping_config(sjis)
# --- テンプレートの識別 ----------------------------------------------------------
def test_identify_by_sheet_when_no_match_rule(tmp_path: Path) -> None:
config = parse_mapping_config(FIXED_YAML)
template = tmp_path / "どんな名前でも.xlsx"
build_floor_plan_template().save(template)
assert identify_template(config, template).id == "fixed"
def test_identify_is_case_insensitive_for_file_names(config, tmp_path: Path) -> None:
template = tmp_path / "Floor_Plan_Sheet_B棟.XLSX"
shutil.copy(SAMPLES / "floor_plan_sheet.xlsx", template)
assert identify_template(config, template).id == "floor_plan_sheet"
def test_missing_sheet_is_reported_when_file_name_matches(config, tmp_path: Path) -> None:
wb = build_floor_plan_template()
wb[FLOOR_PLAN_SHEET_NAME].title = "Sheet2"
template = tmp_path / "floor_plan_sheet_v2.xlsx"
wb.save(template)
with pytest.raises(MappingError, match="シート「間取り表」がテンプレートにありません(あるシート:表紙、Sheet2)"):
identify_template(config, template)
def test_marker_mismatch_is_not_matched(config, tmp_path: Path) -> None:
wb = build_floor_plan_template()
wb[FLOOR_PLAN_SHEET_NAME]["A1"] = "別の様式"
template = tmp_path / "floor_plan_sheet.xlsx"
wb.save(template)
with pytest.raises(TemplateNotMatchedError, match="A1 に「間取り確認表」がありません"):
identify_template(config, template)
def test_unknown_template_lists_reasons(config, tmp_path: Path) -> None:
template = tmp_path / "見積書.xlsx"
build_template().save(template)
with pytest.raises(TemplateNotMatchedError) as info:
identify_template(config, template)
message = str(info.value)
assert "「見積書.xlsx」に当てはまる設定が mapping.example.yaml にありません" in message
assert "room_list:ファイル名が" in message
assert "floor_plan_sheet:ファイル名が" in message
def test_first_matching_setting_wins(tmp_path: Path) -> None:
text = FIXED_YAML + FIXED_YAML.replace("templates:\n", "").replace("id: fixed", "id: second")
template = tmp_path / "t.xlsx"
build_floor_plan_template().save(template)
assert identify_template(parse_mapping_config(text), template).id == "fixed"
def test_identify_rejects_broken_template(config, tmp_path: Path) -> None:
broken = tmp_path / "floor_plan_sheet.xlsx"
broken.write_text("not excel", encoding="utf-8")
with pytest.raises(MappingError, match="開けません"):
identify_template(config, broken)
動かしてみる
pytest
ruff check .
python -m app.main
pytest で「268 passed」と表示されれば完了です。アプリで、Excelテンプレートに samples/floor_plan_sheet.xlsx を、「2-2. 設定を選ぶ…」に app/config/mapping.example.yaml(自社の様式に合わせるときは、コピーして書き換えたもの)を選ぶと、「使う設定:間取り確認表(部屋種別ごとの欄)…」と表示され、「6.」で部屋種別ごとの欄へ転記されます。
動作確認の方法
Linux開発環境で確認できたこと
pytest:合計268件が成功(うちtests/test_mapping.pyが新規73件。Tesseract 5.3.4+日本語データの環境)ruff check .:エラーなし
中心となるテストは、同じ設定ファイルだけで、レイアウトの違う2つのテンプレートの両方に書けることです。
# tests/test_mapping.py(抜粋)
def test_same_config_writes_to_both_templates(config, dictionary, tmp_path: Path) -> None:
names = ["居間", "寝室1", "キッチン", "洗面所"]
results = {}
for file_name in ("room_list_template.xlsx", "floor_plan_sheet.xlsx"):
template = tmp_path / file_name
shutil.copy(SAMPLES / file_name, template)
mapping = identify_template(config, template)
results[file_name] = write_rooms_to_excel(template, _rooms(names), mapping=mapping, dictionary=dictionary)
room_list = load_workbook(results["room_list_template.xlsx"].output_path)["部屋一覧"]
assert [room_list[f"C{r}"].value for r in range(5, 10)] == [*names, None]
...
ほかに、表記ゆれ(リビング・ベッドルーム2・寝室1・DK・洗面脱衣所・WC)が正しい欄に入ること、設定を渡さない場合に第7回と同じセルになること、設定の書き間違い23パターンがそれぞれエラーになること、!!python/... のタグを含むYAMLでもコマンドが実行されないこと、yaml.load() の呼び出しが無いことを検証しています。
次は、設定ファイルを選び、2つ目の「間取り確認表」へ「6. 実行」で転記したときの画面です。開発環境(Linux/Xvfb上・Ubuntu標準のTkテーマ)での確認画面で、Windows実機では見た目が異なります。ファイル名の日時は撮影スクリプトで固定しています。

出力ファイルをopenpyxlで読み戻した内容です(一部)。図面の検出順(居間→寝室1→キッチン→洗面所)ではなく、様式の行に合わせて入っています。
| 行 | B列(印字済み) | C列(書き込み) | D列 |
|---|---|---|---|
| 4 | 居間 | 居間 | =IF(C4="","","有")(数式のまま) |
| 5 | キッチン | キッチン | 同上 |
| 6 | 寝室1 | 寝室1 | 同上 |
| 7 | 寝室2 | (空) | 同上 |
| 9 | 洗面所 | 洗面所 | 同上 |
画面からは、誤りのある設定ファイルを選ぶとエラーが出て選択されないこと、どの設定にも合わないテンプレートでは「使える設定がありません」と赤字で表示され、「6. 実行」でも理由付きのエラーで止まることを確認しました。
確認できていないこと
- Windows実機での画面表示と、Windowsのメモ帳などで保存した設定ファイル(文字コード・改行)の読み込み。UTF-8以外(Shift_JIS)で保存した場合はエラーになることまではテストで確認しています
- 実在の取引先の様式(1部屋に複数の欄がある、階ごとに表が分かれている等)を今回の2つの型で表せるか
つまずきやすい点・セキュリティ上の注意
- 人が修正した名前は辞書に無いことがある:第6回・第7回で「洗面所」を「洗面脱衣室」に修正した例は、固定の欄の型では欄が見つからずエラーになります。辞書(
rooms.yaml)に表記を追加するか、設定のcellsに欄を足します。順番に並べる型では問題になりません - YAMLの型の自動判定:
1:は数値、yes:やon:は真偽値として読まれます。PyYAML 6.0.3で試すと、1:とyes:とon:を並べた設定は同じキー扱いになり1つに潰れました。部屋名は文字列でないとエラーにし、必要なら引用符で囲むよう案内しています - 設定ファイルも管理対象:取引先名をファイル名やidに入れると、それ自体が取引関係の情報になります。置き場所のアクセス権はテンプレートと同じ範囲に絞ります
yaml.load()を使わない:PyYAML 6.0.3のyaml.load()はLoaderの指定が必須ですが、指定次第で安全でない読み込みになりえます。読み込みはsafe_load()に統一します
発注者向けメモ
フォーマットの数だけ設定ファイル(設定)を用意すれば対応できる
取引先ごとにExcelのフォーマットが違っても、この回の仕組みがあれば、様式を1つ増やすたびにプログラムを直す必要はありません。様式ごとに設定を1つ書き足すだけで、社内の担当者が追加・修正できる可能性もあります。
ただし、設定だけで対応できるのは「今回の2つの型で表せる様式」に限られます。たとえば次のような様式は、プログラムの改修が必要になりえます。
| 様式の特徴 | 設定だけで対応できるか |
|---|---|
| 部屋名を上から(または左から)順に並べる | できる(sequential) |
| 部屋種別ごとに欄が決まっている | できる(fixed)。辞書に無い表記は辞書の追加が必要 |
| シート名・欄の位置・欄の数が違う | できる |
| 欄が足りないときに2枚目のシートや行を追加する | できない(改修が必要) |
| 部屋名以外(面積・階)も書く、1部屋に複数の欄がある | できない(改修が必要) |
| 様式に図形・マクロ・シート保護がある | 第7回の注意点のとおり、別途確認が必要 |
コード改修が要らない範囲を最初に決めると、追加費用の交渉がしやすい
「設定で吸収できる範囲」と「改修が必要な範囲」の線引きを契約前にすり合わせておくと、様式が増えたときに「設定の追加」か「機能追加(見積もり)」かを判断しやすくなります。線引きが曖昧なままだと、様式が増えるたびに費用の話し合いが必要になり、双方の負担になります。見積もりの前に、今ある様式と今後増えそうな様式の実物(顧客情報を消したもの)を集め、上の表のどれに当たるかを開発会社と一緒に確認するのがおすすめです。
- ☐ 転記先の様式を、今あるもの・今後増えそうなものまで棚卸ししたか
- ☐ 各様式が「順番に並べる」「部屋ごとに固定の欄」のどちらに当たるか確認したか
- ☐ 設定の追加・修正を社内で行うか、開発会社に依頼するかを決めたか
- ☐ 設定で対応できない様式が出てきたときの扱い(見積もりの出し方)を決めたか
- ☐ 設定ファイルの保管場所と、変更したときの記録の残し方を決めたか
開発会社への質問例
- 「新しい取引先の様式が増えたとき、プログラムの改修なしで対応できるのはどこまでですか?」
- 「設定ファイルは社内の担当者でも書けますか?書き間違えたときはどう表示されますか?」
- 「設定ファイルの書き方の説明書と、サンプルの設定を納品物に含めてもらえますか?」
- 「部屋名の表記ゆれ(リビング/LDKなど)は、どこで吸収していますか?新しい表記はどう追加しますか?」
まとめと次回予告
第8回では、部屋名とExcelの欄の対応付けを設定ファイル(YAML)に移す app/core/mapping.py を実装し、画面から設定ファイルを選べるようにしました。2通りの型で、レイアウトの違う2つの架空テンプレートにコードを変えずに書けることを確かめています。YAMLは safe_load() で読み、重複キーのような書き間違いも読み込み時に止めました。
次回(第9回)は「複数のPDF・複数物件をまとめて処理する」です。フォルダを指定して複数の図面PDFを一括で処理し、1件が失敗しても残りを止めない仕組みとログ出力を作ります。
この連載の記事一覧
この記事は連載「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にまとめて配布し、精度の限界と確認のルールを整理する


コメント
コメント一覧 (2件)
[…] 前回(第8回)では、部屋名とExcelの欄の対応付けを設定ファイル(YAML)に移し、様式の違うテンプレートにもコードを変えずに転記できるようにしました。 […]
[…] 次回(第8回)は「部屋名とExcelの欄の対応付けを設定ファイルで変えられるようにする」です。今回コード内に書いた「C5から下へ順に」という規則をYAMLの設定ファイルに移し、様式が違う取引先にもコードを変えずに対応できるようにします。 […]