(2026年10月29日 追記:記事どおりに再現できるよう、必要なコードと手順を追加しました)
前回(第10回)では、図面を社外に出さない「ローカル完結モード」と「外部AIモード」を設定画面で切り替え、APIキーをOSの資格情報ストアに保存できるようにしました。
最終回の第11回は、Pythonで作ったツールをPyInstallerでexe化し、Pythonを入れていない担当者のPCへ配布するための仕上げと、連載全体のまとめです。ポイントは次の3つです。
- 同梱ファイル(部屋名辞書など)の場所を、exeでもソース実行でも同じ関数で解決する
- Tesseract OCR本体はexeに含めず「インストールしてもらう」前提にし、場所を設定画面で指定できるようにする
- exeを配って終わりにせず、精度の限界と最終確認のルールをセットで渡す
このリポジトリで確認できる範囲
PyInstallerはクロスコンパイル(別のOS向けの実行ファイルを作ること)ができません。公式のREADMEにも「Windowsのアプリを作るにはWindowsで動かす」とあります。開発環境はLinuxのため、確認できたのはLinux向けにビルドした実行ファイルの起動と動作までです。
📰 出典:PyInstaller README(v6.19.0)
仕組みの説明:exeは起動のたびに一時フォルダへ展開される
PyInstallerは、スクリプトとライブラリ・Python本体を1つのフォルダ(onedir)か1つの実行ファイル(onefile)にまとめます。今回は配りやすいonefileです。onefileのexeは、起動のたびに中身を一時フォルダ(_MEIxxxxxx)へ展開してから動きます。公式ドキュメントには、そのぶん起動が少し遅いこと、強制終了すると一時フォルダが残ること、問題を調べるならonedirの方が簡単なことが書かれています。
📰 出典:PyInstaller「What PyInstaller Does and How It Does It」(v6.19.0)
そこで問題になるのが、app/config/rooms.yaml(部屋名辞書)のような同梱ファイルの場所です。exeでは展開先が sys._MEIPASS に入り、sys.frozen も設定されます。「exeなら _MEIPASS、ソース実行ならプロジェクトのフォルダ」を返す関数を1か所に用意しました。
📰 出典:PyInstaller「Run-time Information」(v6.19.0)
実装
ファイル構成(第11回時点の差分)
app/
├ __init__.py … 変更:版(__version__ = "1.0.0")。画面タイトル・exeのバージョン情報に使う
├ main.py … 変更:python app/main.py で直接起動できるよう検索パスを修正
├ core/
│ ├ resources.py … 新規:同梱ファイルの場所(_MEIPASS)とTesseractの場所
│ ├ ocr_local.py … 変更:Tesseractのフルパスを設定できるように
│ ├ settings.py … 変更:設定に tesseract_path を追加
│ ├ room_matcher.py / mapping.py … 変更:YAMLの場所を resources.py で解決
└ ui/
├ settings_dialog.py … 変更:「ローカルOCR(Tesseractの場所)」欄
└ main_window.py … 変更:起動時・設定変更時にTesseractを探して設定、タイトルに版
build/madori_ocr.spec … 新規:PyInstallerのビルド設定
tools/make_icon.py / make_release.py … 新規:アイコン・配布物(配布フォルダとzip)の作成
tests/test_resources.py … 新規25件(test_settings.py にも5件追加)
tests/conftest.py … 変更:Tesseractの場所の設定をテストごとに元に戻す
requirements-dev.txt … 新規:pyinstaller==6.19.0 ほか
requirements.txt … 変更:コメントのみ(PyInstallerは requirements-dev.txt に分けた)
.gitignore … 変更:ビルドの中間ファイル・dist を追跡しない
同梱ファイルの場所を1つの関数で決める(app/core/resources.py)
# app/core/resources.py(抜粋)
PROJECT_ROOT = Path(__file__).resolve().parents[2]
ROOMS_YAML = ("app", "config", "rooms.yaml")
def is_frozen(frozen: bool | None = None, meipass: str | None = None) -> bool:
"""PyInstallerでまとめたexeとして動いているか(`sys.frozen` と `sys._MEIPASS` の両方があるか)。"""
is_bundled = getattr(sys, "frozen", False) if frozen is None else frozen
bundle = getattr(sys, "_MEIPASS", None) if meipass is None else meipass
return bool(is_bundled) and bool(bundle)
def bundle_dir(frozen: bool | None = None, meipass: str | None = None) -> Path:
if is_frozen(frozen, meipass):
bundle = getattr(sys, "_MEIPASS", "") if meipass is None else meipass
return Path(bundle)
return PROJECT_ROOT
def resource_path(*parts: str, frozen: bool | None = None, meipass: str | None = None) -> Path:
if not parts:
raise ValueError("ファイル名を指定してください。")
for part in parts:
if not part or Path(part).is_absolute() or ".." in Path(part).parts:
raise ValueError(f"同梱ファイルの指定が不正です: {part!r}")
return bundle_dir(frozen, meipass).joinpath(*parts)
引数で差し替えられるので、exe化しなくてもpytestで「exeとして動いている場合」を確かめられます。なお一時フォルダは終了時に消えるため、利用者が編集するファイルや出力を展開先に置いてはいけません(設定は第10回から %APPDATA%\MadoriOCR に保存しています)。
Tesseractは「インストールしてもらう」前提にし、場所を指定できるようにする
Tesseract OCR本体と日本語データはPythonのパッケージではないため、PyInstallerは同梱しません。埋め込み文字のある図面はTesseractなしで読めること、同梱するとTesseractの更新のたびにexeを配り直すことになることから、利用者のPCにインストールしてもらう前提にしました。ただ、インストールしてもPATH(コマンドを探す場所の一覧)に入らないことがあるため、次の順に探して pytesseract に設定します。
# app/core/resources.py(抜粋)
def find_tesseract(configured: str = "", *, platform=None, environ=None, app_directory=None,
which=shutil.which, is_file=Path.is_file) -> TesseractLocation:
exe = tesseract_exe_name(platform) # Windowsは tesseract.exe
value = validate_tesseract_path(configured)
if value: # 1. 設定画面で指定した場所(無ければほかは探さない)
candidate = Path(value)
for path in (candidate, candidate / exe):
if is_file(path):
return TesseractLocation(path, TESSERACT_FROM_SETTINGS)
return TesseractLocation(None, None, missing_configured=value)
base = app_dir() if app_directory is None else app_directory
bundled = base / APP_DIR_TESSERACT_FOLDER / exe # 2. exeと同じフォルダの tesseract\
if is_file(bundled):
return TesseractLocation(bundled, TESSERACT_FROM_APP_DIR)
found = which("tesseract") # 3. PATH
if found:
return TesseractLocation(Path(found), TESSERACT_FROM_PATH)
for candidate in standard_tesseract_paths(platform, environ): # 4. C:\Program Files\Tesseract-OCR など
if is_file(candidate):
return TesseractLocation(candidate, TESSERACT_FROM_STANDARD)
return TesseractLocation(None, None)
# app/core/ocr_local.py(抜粋)
def configure_tesseract(path: str | Path | None) -> None:
pytesseract.pytesseract.tesseract_cmd = str(path) if path else DEFAULT_TESSERACT_CMD
設定した場所に無いときは、PATH上の別のTesseractを黙って使わず「見つかりません」と表示します(精度の違いの原因を追えなくなるため)。Tesseractが無いPCで埋め込み文字の無いページを読んだときも、「0件」だけでなく理由と設定方法を表示します。Windows用インストーラーは、Tesseractの公式ドキュメントでUB Mannheim(マンハイム大学図書館)作成のものが案内されています。
📰 出典:Tesseract ドキュメント「Installation」
ビルド設定(build/madori_ocr.spec)
specファイルはPythonとして実行される設定ファイルです。
# build/madori_ocr.spec(抜粋)
ROOT = Path(SPECPATH).resolve().parent
APP_NAME = "MadoriOCR"
# 版は app/__init__.py の __version__ だけを正とし、画面のタイトルとexeのバージョン情報をそろえる
_match = re.search(r'^__version__ = "(\d+)\.(\d+)\.(\d+)"', (ROOT / "app" / "__init__.py").read_text(encoding="utf-8"), re.M)
VERSION = tuple(int(n) for n in _match.groups()) + (0,)
datas = [
(str(ROOT / "app" / "config" / "rooms.yaml"), "app/config"),
(str(ROOT / "app" / "config" / "mapping.example.yaml"), "app/config"),
]
a = Analysis(
[str(ROOT / "app" / "main.py")],
pathex=[str(ROOT)],
datas=datas,
excludes=["pytest", "ruff", "_pytest"],
)
pyz = PYZ(a.pure)
version_info = make_version_info() if sys.platform == "win32" else None
exe = EXE(
pyz, a.scripts, a.binaries, a.datas, [],
name=APP_NAME,
upx=False, # 実行ファイルの圧縮(UPX)は使わない
console=False, # --windowed 相当:黒いコンソール画面を出さない
icon=[str(icon_file)] if icon_file.is_file() else None,
version=version_info,
)
console=False:--windowedと同じ。コンソール画面が出ない代わりにsys.stdout・sys.stderrがNoneになる、と公式ドキュメントで注意されています(Linuxでは無視されます)upx=False:UPXで圧縮するとDLLが壊れることがある、と公式ドキュメントにあるため使いません- バージョン情報:エクスプローラーのプロパティに出る版を
app/__init__.pyから作ります。作成に使う部品がWindowsでだけ入るpefileを読み込むため、LinuxではModuleNotFoundErrorで止まりました。Windowsのときだけ作るようにしています
📰 出典:PyInstaller「Using PyInstaller」(v6.19.0)
📰 出典:PyInstaller「Common Issues and Pitfalls」(v6.19.0)
keyring(第10回)の資格情報マネージャー用の部品は自動解析では見つかりませんが、PyInstaller 6.19.0同梱の設定(フック)が集めることをソースで確認しました。
Windowsでのビルド手順
REM Windows(コマンドプロンプト。プロジェクトのルートで)
py -3.13 -m venv .venv-build
.venv-build\Scripts\activate
pip install -r requirements-dev.txt
python tools\make_icon.py
pyinstaller --noconfirm --clean build\madori_ocr.spec
python tools\make_release.py
ビルド用のパッケージは、アプリの実行には要らないので requirements-dev.txt に分けます(新しく作ります)。
# requirements-dev.txt
# ビルド(exe化)用の追加パッケージ(第11回)。アプリ本体の依存は requirements.txt。
# pip install -r requirements-dev.txt
#
# PyInstallerはクロスコンパイルできないため、Windows向けのexeはWindows上で、この仮想環境を作ってビルドする。
# バージョンは記事の公開日(2026-02-25)時点でPyPIに存在したものに固定している
# (`pip index versions pyinstaller`・PyPI JSON APIの upload_time で確認)。
-r requirements.txt
# PyInstaller 6.19.0(2026-02-14公開)。ライセンスはGPL-2.0以降+例外(作ったexeは自由なライセンスで配布できる)
pyinstaller==6.19.0
# PyInstallerが各ライブラリをまとめるための設定集(フック)。6.19.0 は 2026.0 以上を要求する。
# 2026.1 は 2026-02-18公開(未固定だと、ビルドした日の最新版が入り、結果が変わりうるため固定する)
pyinstaller-hooks-contrib==2026.1
tools\make_release.py は、exe・利用者向けの説明・転記の設定ファイルの例・サンプル・ライブラリのライセンス文・exeのハッシュ値(SHA-256)をまとめた配布フォルダとzipを作ります。
この回で追加・変更するファイル
新しく作るファイルの全体です。まず、同梱ファイルとTesseractの場所を決める app/core/resources.py です。
app/core/resources.py を新しく作ります(全文)。
app/core/resources.py の全文(204行)
# app/core/resources.py
"""同梱ファイルの場所と、Tesseract OCR本体の場所を決める(第11回)。
PyInstallerでexe化すると、`app/config/rooms.yaml` のような同梱ファイルは
exeの中に詰め込まれ、起動のたびに一時フォルダ(`_MEIxxxxxx`)へ展開される。
展開先はPyInstallerの起動処理(ブートローダー)が `sys._MEIPASS` に入れ、
`sys.frozen` も設定する(PyInstaller公式ドキュメント「Run-time Information」)。
- 同梱ファイル(読み取り専用):exeなら `sys._MEIPASS`、ソース実行ならプロジェクトの
ルート(このファイルの2つ上のフォルダ)を基準に探す → `resource_path()`
- exeの置き場所(利用者に見えるフォルダ):exeなら `sys.executable` のフォルダ、
ソース実行ならプロジェクトのルート → `app_dir()`
(一時フォルダはアプリの終了時に消えるため、利用者が編集するファイルや出力をそこに置かない)
Tesseract OCR本体(`tesseract.exe`)はPythonのパッケージではないため、exeには含めず
「インストールしてもらう」前提にしている。見つける順番は `find_tesseract()` を参照。
tkinterなどGUIライブラリはimportしない。`sys.frozen`・`_MEIPASS`・OS・環境変数は
引数で差し替えられるので、exe化しなくても pytest で両方の場合を確かめられる。
"""
from __future__ import annotations
import os
import shutil
import sys
from collections.abc import Callable, Mapping
from dataclasses import dataclass
from pathlib import Path
#: ソースから実行したときのプロジェクトのルート(`app/` の親フォルダ)
PROJECT_ROOT = Path(__file__).resolve().parents[2]
#: 部屋名辞書・転記の設定ファイルのサンプル(exeにも同梱する。`build/madori_ocr.spec` の datas)
ROOMS_YAML = ("app", "config", "rooms.yaml")
MAPPING_EXAMPLE_YAML = ("app", "config", "mapping.example.yaml")
#: Tesseractをどこで見つけたか
TESSERACT_FROM_SETTINGS = "settings" # 設定画面で指定した場所
TESSERACT_FROM_APP_DIR = "app_dir" # exeと同じフォルダの tesseract\ に置いたもの
TESSERACT_FROM_PATH = "path" # 環境変数PATHから見つかったもの
TESSERACT_FROM_STANDARD = "standard" # Windowsの標準的なインストール先
#: exeと同じフォルダに置く場合のフォルダ名(`<exeのフォルダ>\tesseract\tesseract.exe`)
APP_DIR_TESSERACT_FOLDER = "tesseract"
#: 設定画面で指定できるパスの長さの上限
MAX_TESSERACT_PATH_LENGTH = 1024
def is_frozen(frozen: bool | None = None, meipass: str | None = None) -> bool:
"""PyInstallerでまとめたexeとして動いているか(`sys.frozen` と `sys._MEIPASS` の両方があるか)。"""
is_bundled = getattr(sys, "frozen", False) if frozen is None else frozen
bundle = getattr(sys, "_MEIPASS", None) if meipass is None else meipass
return bool(is_bundled) and bool(bundle)
def bundle_dir(frozen: bool | None = None, meipass: str | None = None) -> Path:
"""同梱ファイルの基準フォルダ。exeなら展開先(`sys._MEIPASS`)、ソース実行ならプロジェクトのルート。"""
if is_frozen(frozen, meipass):
bundle = getattr(sys, "_MEIPASS", "") if meipass is None else meipass
return Path(bundle)
return PROJECT_ROOT
def resource_path(*parts: str, frozen: bool | None = None, meipass: str | None = None) -> Path:
"""同梱ファイルのパスを返す(例:`resource_path(*ROOMS_YAML)`)。
`..` や絶対パスで基準フォルダの外を指すことはできない(`ValueError`)。
"""
if not parts:
raise ValueError("ファイル名を指定してください。")
for part in parts:
if not part or Path(part).is_absolute() or ".." in Path(part).parts:
raise ValueError(f"同梱ファイルの指定が不正です: {part!r}")
return bundle_dir(frozen, meipass).joinpath(*parts)
def app_dir(
frozen: bool | None = None,
meipass: str | None = None,
executable: str | None = None,
) -> Path:
"""利用者から見えるアプリの置き場所。exeならexeのあるフォルダ、ソース実行ならプロジェクトのルート。"""
if is_frozen(frozen, meipass):
exe = sys.executable if executable is None else executable
return Path(exe).resolve().parent
return PROJECT_ROOT
# --- Tesseract OCR本体の場所 ----------------------------------------------------------
@dataclass(frozen=True)
class TesseractLocation:
"""Tesseractを探した結果。見つからなければ `path` は None。"""
path: Path | None
source: str | None
#: 設定画面で指定した場所に無かった場合、その指定値(画面での案内用)
missing_configured: str = ""
@property
def found(self) -> bool:
return self.path is not None
def tesseract_exe_name(platform: str | None = None) -> str:
"""Tesseract本体の実行ファイル名(Windowsは tesseract.exe)。"""
plat = sys.platform if platform is None else platform
return "tesseract.exe" if plat.startswith("win") else "tesseract"
def standard_tesseract_paths(
platform: str | None = None,
environ: Mapping[str, str] | None = None,
) -> list[Path]:
"""Windowsで Tesseract のインストーラーが使うことの多いインストール先の候補(Windows以外は空)。
Windows用インストーラー(UB Mannheim版)の既定は `C:\\Program Files\\Tesseract-OCR`。
利用者ごとにインストールした場合に備えて `%LOCALAPPDATA%\\Programs` も見る。
"""
plat = sys.platform if platform is None else platform
if not plat.startswith("win"):
return []
env = os.environ if environ is None else environ
exe = tesseract_exe_name(plat)
candidates: list[Path] = []
for var, sub in (
("ProgramFiles", ("Tesseract-OCR",)),
("ProgramFiles(x86)", ("Tesseract-OCR",)),
("LOCALAPPDATA", ("Programs", "Tesseract-OCR")),
):
base = env.get(var, "").strip()
if base:
candidates.append(Path(base).joinpath(*sub, exe))
return candidates
def validate_tesseract_path(text: str) -> str:
"""設定画面で入力されたTesseractの場所を検証し、前後の空白と引用符を除いて返す(空欄は「自動で探す」)。"""
value = text.strip().strip('"').strip()
if not value:
return ""
if len(value) > MAX_TESSERACT_PATH_LENGTH:
raise ValueError(f"Tesseractの場所が長すぎます({MAX_TESSERACT_PATH_LENGTH}文字まで)。")
if any(ord(ch) < 0x20 for ch in value):
raise ValueError("Tesseractの場所に改行などの制御文字が含まれています。")
return value
def find_tesseract(
configured: str = "",
*,
platform: str | None = None,
environ: Mapping[str, str] | None = None,
app_directory: Path | None = None,
which: Callable[[str], str | None] = shutil.which,
is_file: Callable[[Path], bool] = Path.is_file,
) -> TesseractLocation:
"""Tesseract本体を次の順に探す。
1. 設定画面で指定した場所(指定があるのに見つからなければ、ほかは探さずに「見つからない」を返す。
指定と違うTesseractが黙って使われないようにするため)。フォルダを指定した場合はその中の実行ファイル
2. アプリと同じフォルダの `tesseract\\tesseract.exe`(配布フォルダに同梱した場合)
3. 環境変数PATH(`tesseract` コマンド)
4. Windowsの標準的なインストール先(`standard_tesseract_paths()`)
"""
exe = tesseract_exe_name(platform)
value = validate_tesseract_path(configured)
if value:
candidate = Path(value)
for path in (candidate, candidate / exe): # 後者はフォルダを指定された場合
if is_file(path):
return TesseractLocation(path, TESSERACT_FROM_SETTINGS)
return TesseractLocation(None, None, missing_configured=value)
base = app_dir() if app_directory is None else app_directory
bundled = base / APP_DIR_TESSERACT_FOLDER / exe
if is_file(bundled):
return TesseractLocation(bundled, TESSERACT_FROM_APP_DIR)
found = which("tesseract")
if found:
return TesseractLocation(Path(found), TESSERACT_FROM_PATH)
for candidate in standard_tesseract_paths(platform, environ):
if is_file(candidate):
return TesseractLocation(candidate, TESSERACT_FROM_STANDARD)
return TesseractLocation(None, None)
def describe_tesseract_location(location: TesseractLocation) -> str:
"""画面に出す説明文。"""
labels = {
TESSERACT_FROM_SETTINGS: "設定で指定した場所",
TESSERACT_FROM_APP_DIR: "アプリと同じフォルダ",
TESSERACT_FROM_PATH: "環境変数PATH",
TESSERACT_FROM_STANDARD: "標準のインストール先",
}
if location.path is not None:
return f"使用中:{location.path}({labels.get(location.source or '', '')})"
if location.missing_configured:
return f"指定した場所にTesseractが見つかりません:{location.missing_configured}"
return "Tesseractが見つかりません(スキャン図面のOCRは使えません。埋め込み文字の読み取りは使えます)"
上で抜粋したビルド設定の全体です。build フォルダを作って置きます。
build/madori_ocr.spec を新しく作ります(全文)。
build/madori_ocr.spec の全文(130行)
# build/madori_ocr.spec
# -*- mode: python ; coding: utf-8 -*-
# 間取りOCR転記ツールを PyInstaller 6.19.0 で1つの実行ファイルにまとめる設定(第11回)。
#
# 使い方(プロジェクトのルートで。Windows向けのexeはWindowsで、Linux向けはLinuxでビルドする。
# PyInstallerはクロスコンパイルできない):
# pip install -r requirements-dev.txt
# python tools/make_icon.py # 任意:アイコン build/madori_ocr.ico を作る
# pyinstaller --noconfirm --clean build/madori_ocr.spec
# → dist/MadoriOCR.exe(Linuxでは dist/MadoriOCR)。中間ファイルは build/madori_ocr/
#
# specファイルはPythonのコードとして実行される。SPECPATH(このファイルのあるフォルダ)は
# PyInstallerが用意する変数。
import re
import sys
from pathlib import Path
ROOT = Path(SPECPATH).resolve().parent # noqa: F821(SPECPATHはPyInstallerが定義する)
APP_NAME = "MadoriOCR"
# 版は app/__init__.py の __version__ だけを正とし、画面のタイトルとexeのバージョン情報をそろえる
_match = re.search(r'^__version__ = "(\d+)\.(\d+)\.(\d+)"', (ROOT / "app" / "__init__.py").read_text(encoding="utf-8"), re.M)
if _match is None:
raise SystemExit("app/__init__.py に __version__ = \"X.Y.Z\" が見つかりません")
VERSION = tuple(int(n) for n in _match.groups()) + (0,)
VERSION_TEXT = ".".join(str(n) for n in VERSION[:3])
# --- 同梱するファイル(exeの中に入り、起動時に sys._MEIPASS の下へ展開される) ---
# (元のファイル, 展開先のフォルダ)。展開先は app/core/resources.py の resource_path() が探す場所と同じ構成にする
datas = [
(str(ROOT / "app" / "config" / "rooms.yaml"), "app/config"),
(str(ROOT / "app" / "config" / "mapping.example.yaml"), "app/config"),
]
# 架空のサンプル(Excelテンプレート)と、利用者が書き換える転記の設定ファイルの例は、exeの中ではなく
# 配布フォルダに「見えるファイル」として置く(tools/make_release.py)。exeの中は起動のたびに
# 一時フォルダへ展開され、終了時に消えるため、利用者が編集・保存する場所には使えない。
# --- importの自動解析で見つからないモジュール ---
# keyring のバックエンド(Windowsの資格情報マネージャー用 keyring.backends.Windows など)は
# エントリーポイント経由で読み込まれるため、import文を追っても見つからない。PyInstaller本体に同梱の
# hook-keyring.py が keyring.backends 以下とメタデータを集めるので、ここでは追加しない。
hiddenimports = []
a = Analysis( # noqa: F821
[str(ROOT / "app" / "main.py")],
pathex=[str(ROOT)], # `import app...` を解決できるようにプロジェクトのルートを加える
binaries=[],
datas=datas,
hiddenimports=hiddenimports,
hookspath=[],
runtime_hooks=[],
# 開発・テスト用のパッケージは同梱しない(importされていなければ入らないが、念のため明示)
excludes=["pytest", "ruff", "_pytest"],
noarchive=False,
optimize=0,
)
pyz = PYZ(a.pure) # noqa: F821
def make_version_info():
"""Windowsのバージョン情報(エクスプローラーのプロパティ→詳細に出る)を作る。
PyInstaller.utils.win32.versioninfo は pefile(Windowsでだけ自動で入る依存)をimportするため、
Windows以外でビルドするときは呼ばない(Linuxで試したところ ModuleNotFoundError: pefile で止まった)。
"""
from PyInstaller.utils.win32.versioninfo import (
FixedFileInfo,
StringFileInfo,
StringStruct,
StringTable,
VarFileInfo,
VarStruct,
VSVersionInfo,
)
return VSVersionInfo(
ffi=FixedFileInfo(filevers=VERSION, prodvers=VERSION),
kids=[
StringFileInfo(
[
StringTable(
"041104B0", # 日本語(0x0411)・Unicode(1200=0x04B0)
[
StringStruct("CompanyName", "(配布元の会社名)"),
StringStruct("FileDescription", "間取りOCR転記ツール"),
StringStruct("FileVersion", VERSION_TEXT),
StringStruct("InternalName", APP_NAME),
StringStruct("OriginalFilename", f"{APP_NAME}.exe"),
StringStruct("ProductName", "間取りOCR転記ツール"),
StringStruct("ProductVersion", VERSION_TEXT),
],
)
]
),
VarFileInfo([VarStruct("Translation", [0x0411, 1200])]),
],
)
version_info = make_version_info() if sys.platform == "win32" else None
icon_file = Path(SPECPATH) / "madori_ocr.ico" # noqa: F821(tools/make_icon.py で作る。無ければ既定のアイコン)
exe = EXE( # noqa: F821
pyz,
a.scripts,
a.binaries,
a.datas,
[],
name=APP_NAME,
debug=False,
bootloader_ignore_signals=False,
strip=False,
# UPX(実行ファイルの圧縮)は使わない。DLLを壊すことがあると公式ドキュメントにあり、
# 起動時間・誤検知の切り分けも難しくなるため
upx=False,
upx_exclude=[],
runtime_tmpdir=None,
# --windowed 相当:Windowsで黒いコンソール画面を出さない(sys.stdout/stderr は None になる)
console=False,
# 起動時の例外は、コンソールが無くてもダイアログで表示する(既定値。明示しておく)
disable_windowed_traceback=False,
argv_emulation=False,
target_arch=None,
codesign_identity=None,
entitlements_file=None,
icon=[str(icon_file)] if icon_file.is_file() else None,
version=version_info,
)
exeのアイコン(build/madori_ocr.ico)を作るスクリプトと、ビルドした実行ファイルから配布フォルダとzipを作るスクリプトです。
tools/make_icon.py を新しく作ります(全文)。
# tools/make_icon.py
"""exeのアイコン(build/madori_ocr.ico)を Pillow で描いて作る(第11回)。
実在の製品・会社のロゴは使わず、間取り図と表をイメージした図形だけで描く。
Windowsのエクスプローラーは表示の大きさに応じて使うサイズを選ぶため、
16〜256pxの複数サイズを1つの .ico に入れる。
python tools/make_icon.py # → build/madori_ocr.ico
"""
from __future__ import annotations
import argparse
from pathlib import Path
from PIL import Image, ImageDraw
ROOT = Path(__file__).resolve().parents[1]
DEFAULT_OUTPUT = ROOT / "build" / "madori_ocr.ico"
ICON_SIZES = [(16, 16), (24, 24), (32, 32), (48, 48), (64, 64), (128, 128), (256, 256)]
def draw_icon(size: int = 256) -> Image.Image:
"""青い角丸の背景に、白い間取り(部屋の区切り)と緑の表のマスを描く。"""
img = Image.new("RGBA", (size, size), (0, 0, 0, 0))
d = ImageDraw.Draw(img)
s = size / 256
d.rounded_rectangle((8 * s, 8 * s, 248 * s, 248 * s), radius=40 * s, fill=(31, 95, 191, 255))
line = max(1, round(10 * s))
white = (255, 255, 255, 255)
# 間取り(外枠と間仕切り)
d.rectangle((40 * s, 40 * s, 170 * s, 170 * s), outline=white, width=line)
d.line((40 * s, 105 * s, 120 * s, 105 * s), fill=white, width=line)
d.line((120 * s, 40 * s, 120 * s, 140 * s), fill=white, width=line)
# 表(Excelへの転記をイメージ)
green = (46, 160, 90, 255)
d.rectangle((130 * s, 140 * s, 220 * s, 220 * s), fill=white)
for row in range(3):
y0 = (148 + row * 24) * s
d.rectangle((138 * s, y0, 212 * s, y0 + 16 * s), fill=green)
return img
def main(argv: list[str] | None = None) -> None:
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument("-o", "--output", type=Path, default=DEFAULT_OUTPUT)
args = parser.parse_args(argv)
args.output.parent.mkdir(parents=True, exist_ok=True)
draw_icon().save(args.output, format="ICO", sizes=ICON_SIZES)
print(f"アイコンを作成しました: {args.output}")
if __name__ == "__main__":
main()
tools/make_release.py を新しく作ります(全文)。
tools/make_release.py の全文(173行)
# tools/make_release.py
"""ビルドしたexeから、担当者に配る配布フォルダとzipを作る(第11回)。
pyinstaller --noconfirm --clean build/madori_ocr.spec
python tools/make_release.py
→ dist/MadoriOCR-<版>/ と dist/MadoriOCR-<版>.zip
配布フォルダの中身:
MadoriOCR.exe(Linuxでは MadoriOCR)
はじめにお読みください.txt …… 必要なもの(Tesseract)・初回起動・確認のルール
mapping.example.yaml ………… 転記の設定ファイルの例(コピーして書き換える)
samples/ …………………………… 架空のExcelテンプレート
THIRD-PARTY-LICENSES/ ……… exeに含まれるライブラリのライセンス文(インストール済みパッケージから収集)
SHA256SUMS.txt ………………… exeのハッシュ値(受け取った人が、配布元と同じファイルか確かめる用)
ライセンス文は「このPCにインストールされているパッケージのメタデータ」から集めるため、
ビルドに使ったのと同じ仮想環境で実行する。集めた内容が十分かどうか(とくに外部へ配布する
場合)は、各ライブラリの公式情報で確認すること。
"""
from __future__ import annotations
import argparse
import hashlib
import re
import shutil
import sys
from importlib import metadata
from pathlib import Path
ROOT = Path(__file__).resolve().parents[1]
sys.path.insert(0, str(ROOT))
from app import APP_NAME, __version__ # noqa: E402
#: 開発用で、exeには入らないパッケージ
DEV_ONLY = {"pytest", "ruff"}
_LICENSE_FILE = re.compile(r"(LICEN[CS]E|COPYING|NOTICE|AUTHORS)", re.IGNORECASE)
README_TEXT = """間取りOCR転記ツール {version}
■ 必要なもの
- Windows 10 / 11(64bit)
- スキャン図面(文字が埋め込まれていないPDF)を読む場合のみ:Tesseract OCR 本体と日本語データ
(インストール時に追加言語で Japanese を選ぶ)。見つからない場合は「設定...」で tesseract.exe の場所を指定します。
CADソフトから書き出したPDF(文字が埋め込まれているもの)は、Tesseractが無くても読み取れます。
■ 起動
- {exe} をダブルクリックします。1つのファイルに全部をまとめているため、起動のたびに一時フォルダへ
展開してから画面が開きます。最初の起動は数秒〜十数秒かかることがあります。
- 設定は %APPDATA%\\MadoriOCR\\settings.json、APIキー(外部AIを使う場合のみ)は
Windowsの資格情報マネージャーに保存されます。この版のフォルダを置き換えても設定は残ります。
■ 使うときのルール(必ずお読みください)
- 読み取り結果(OCR・外部AI)には誤りが含まれることがあります。転記前の確認画面で、
図面と見比べて1件ずつ確認してから転記してください。
- 一括処理の「成功」は機械的な確認に通っただけです。出力したExcelを必ず開いて確認してください。
- 外部AIモードは、図面を社外のAIサービスへ送信します。社内ルールで許可された図面・PCだけで使ってください。
■ 版の確認
- 画面のタイトルに版(v{version})が出ます。問い合わせのときは版をお知らせください。
- 受け取ったexeが配布元と同じものかは、SHA256SUMS.txt のハッシュ値と比べて確かめられます
(PowerShell: Get-FileHash .\\{exe} -Algorithm SHA256)。
"""
def runtime_distributions(requirements: Path) -> list[metadata.Distribution]:
"""requirements.txt の実行時パッケージと、その依存を(インストール済みのメタデータから)たどって返す。"""
from packaging.markers import default_environment
from packaging.requirements import Requirement
env = default_environment()
pending: list[str] = []
for line in requirements.read_text(encoding="utf-8").splitlines():
line = line.split("#", 1)[0].strip()
if line:
name = Requirement(line).name
if name.lower() not in DEV_ONLY:
pending.append(name)
seen: dict[str, metadata.Distribution] = {}
while pending:
name = pending.pop()
key = re.sub(r"[-_.]+", "-", name).lower()
if key in seen:
continue
try:
dist = metadata.distribution(name)
except metadata.PackageNotFoundError:
continue
seen[key] = dist
for spec in dist.requires or []:
req = Requirement(spec)
if req.marker is None or req.marker.evaluate({**env, "extra": ""}):
pending.append(req.name)
return sorted(seen.values(), key=lambda d: d.metadata["Name"].lower())
def copy_licenses(dists: list[metadata.Distribution], out_dir: Path) -> list[str]:
"""各パッケージのライセンス文を out_dir/<名前>-<版>/ にコピーし、一覧の行を返す。"""
lines = []
for dist in dists:
name, version = dist.metadata["Name"], dist.version
license_name = dist.metadata.get("License-Expression") or ""
if not license_name:
first_line = (dist.metadata.get("License") or "").strip().splitlines()
license_name = first_line[0][:80] if first_line else "(メタデータに記載なし)"
copied = 0
for file in dist.files or []:
if _LICENSE_FILE.search(file.name) and not file.name.endswith(".py"):
src = Path(str(dist.locate_file(file)))
if src.is_file():
dest = out_dir / f"{name}-{version}" / file.name
dest.parent.mkdir(parents=True, exist_ok=True)
shutil.copyfile(src, dest)
copied += 1
note = "" if copied else " ※ライセンス文のファイルが見つかりません。公式ページで確認してください"
lines.append(f"{name} {version} {license_name}{note}")
return lines
def build_release(dist_dir: Path, requirements: Path) -> Path:
exe_name = f"{APP_NAME}.exe" if sys.platform.startswith("win") else APP_NAME
exe = dist_dir / exe_name
if not exe.is_file():
raise SystemExit(f"{exe} がありません。先に pyinstaller --noconfirm --clean build/madori_ocr.spec を実行してください。")
release = dist_dir / f"{APP_NAME}-{__version__}"
if release.exists():
shutil.rmtree(release)
release.mkdir(parents=True)
shutil.copy2(exe, release / exe_name)
shutil.copyfile(ROOT / "app" / "config" / "mapping.example.yaml", release / "mapping.example.yaml")
(release / "samples").mkdir()
for sample in sorted((ROOT / "samples").glob("*.xlsx")):
shutil.copyfile(sample, release / "samples" / sample.name)
(release / "はじめにお読みください.txt").write_text(
README_TEXT.format(version=__version__, exe=exe_name), encoding="utf-8-sig", newline="\r\n"
)
licenses = release / "THIRD-PARTY-LICENSES"
licenses.mkdir()
lines = copy_licenses(runtime_distributions(requirements), licenses)
python_line = f"Python {sys.version.split()[0]} PSF-2.0(exeにPython本体が含まれます)"
(licenses / "一覧.txt").write_text(
"exeに含まれる主なパッケージとライセンス(ビルド環境のメタデータから自動収集)\n"
"Tesseract OCR 本体はこの配布物に含めていません(利用者がインストールする前提)。\n\n"
+ "\n".join([python_line, *lines])
+ "\n",
encoding="utf-8-sig",
newline="\r\n",
)
digest = hashlib.sha256((release / exe_name).read_bytes()).hexdigest()
(release / "SHA256SUMS.txt").write_text(f"{digest} {exe_name}\n", encoding="ascii")
archive = shutil.make_archive(str(release), "zip", root_dir=dist_dir, base_dir=release.name)
print(f"配布フォルダ: {release}")
print(f"zip: {archive}")
print(f"SHA-256: {digest}")
return release
def main(argv: list[str] | None = None) -> None:
parser = argparse.ArgumentParser(description="配布フォルダとzipを作る")
parser.add_argument("--dist", type=Path, default=ROOT / "dist")
parser.add_argument("--requirements", type=Path, default=ROOT / "requirements.txt")
args = parser.parse_args(argv)
build_release(args.dist, args.requirements)
if __name__ == "__main__":
main()
既存のファイルへの変更です。版の番号は app/__init__.py に置きます。
app/__init__.py に次の変更を加えます(+ が追加、- が削除)。
--- a/app/__init__.py
+++ b/app/__init__.py
@@ -1,2 +1,9 @@
# app/__init__.py
"""間取りOCR転記ツールのアプリケーションパッケージ。"""
+
+#: アプリの版(第11回)。画面のタイトル・exeのバージョン情報(`build/madori_ocr.spec` が
+#: この行を読み取る)・配布フォルダ名に使う。更新版を配るときはここだけを書き換える。
+__version__ = "1.0.0"
+
+#: exe・配布フォルダ・設定フォルダ(Windows)の名前
+APP_NAME = "MadoriOCR"
python app/main.py と直接指定しても起動できるようにします(上の「なお」で触れた修正です)。
app/main.py に次の変更を加えます(+ が追加、- が削除)。
--- a/app/main.py
+++ b/app/main.py
@@ -1,7 +1,9 @@
# app/main.py
"""アプリケーションのエントリーポイント。
-プロジェクトのルート(`app/` フォルダがあるフォルダ)で `python -m app.main` として起動する。
+ソースから起動する場合は、プロジェクトのルート(`app/` フォルダがあるフォルダ)で `python -m app.main`
+または `python app/main.py`。配布用には第11回で PyInstaller により単一のexe
+(`build/madori_ocr.spec`)にまとめ、このファイルがexeの起動処理になる。
Linux開発環境で起動そのものを試す場合は、tkinterと
Xサーバーが必要なため `xvfb-run python -m app.main` を使う
(画面が実際に正しく描画されるかはWindows実機での確認が必要。詳細は記事参照)。
@@ -9,9 +11,18 @@ Xサーバーが必要なため `xvfb-run python -m app.main` を使う
from __future__ import annotations
-import tkinter as tk
+import sys
+from pathlib import Path
-from app.ui.main_window import build_main_window
+if __package__ in (None, "") and not getattr(sys, "frozen", False):
+ # `python app/main.py` のようにファイルを直接実行すると、検索パスの先頭が `app/` になり
+ # `app` パッケージをimportできない(第11回で修正)。プロジェクトのルートを先頭に加える。
+ # exe(sys.frozen)では、PyInstallerがまとめたモジュールから読み込むので不要。
+ sys.path.insert(0, str(Path(__file__).resolve().parents[1]))
+
+import tkinter as tk # noqa: E402
+
+from app.ui.main_window import build_main_window # noqa: E402
def main() -> None:
app/core/ocr_local.py に次の変更を加えます(+ が追加、- が削除)。
--- a/app/core/ocr_local.py
+++ b/app/core/ocr_local.py
@@ -36,6 +36,7 @@ from __future__ import annotations
import io
import shutil
from dataclasses import dataclass
+from pathlib import Path
import pytesseract
from PIL import Image, ImageFilter
@@ -76,16 +77,38 @@ class OcrError(RuntimeError):
"""Tesseract本体が見つからない、またはOCR処理中にエラーが起きた場合に送出する例外。"""
+#: `configure_tesseract()` で場所を指定していないときに使うコマンド名(PATHから探す)
+DEFAULT_TESSERACT_CMD = "tesseract"
+
+
+def configure_tesseract(path: str | Path | None) -> None:
+ """pytesseractが呼び出すTesseract本体の場所を設定する(第11回)。
+
+ exeを配る先のPCでは、Tesseractのインストール先がPATHに入っていないことが多い。
+ `app/core/resources.find_tesseract()` で見つけた `tesseract.exe` のフルパスを渡すと、
+ 以後のOCRはそれを使う。`None` を渡すとPATHから探す既定の動きに戻る。
+ """
+ pytesseract.pytesseract.tesseract_cmd = str(path) if path else DEFAULT_TESSERACT_CMD
+
+
+def tesseract_command() -> str:
+ """pytesseractが現在呼び出すTesseract本体(コマンド名またはフルパス)。"""
+ return str(pytesseract.pytesseract.tesseract_cmd)
+
+
def is_tesseract_available() -> bool:
"""Tesseract OCR本体(`tesseract`コマンド)がこの環境で実行できるかを返す。
+ 第11回から、`configure_tesseract()` でフルパスを指定していればそのファイルを確認する
+ (`shutil.which()` はフルパスを渡すと、実行できるファイルならそのまま返す)。
+
`pytesseract`はTesseract本体を呼び出すだけの薄いラッパーで、本体は
別途OSにインストールする必要がある。CI・開発環境によっては本体が
インストールされていないことがあるため、呼び出し側(テスト・GUI)が
事前にこの関数で確認し、無い場合はOCR機能自体をスキップ・無効化できる
ようにしている。
"""
- return shutil.which("tesseract") is not None
+ return shutil.which(tesseract_command()) is not None
def is_ocr_language_available(lang: str = DEFAULT_OCR_LANG) -> bool:
@@ -201,9 +224,9 @@ def ocr_image_to_words(
"""
if not is_tesseract_available():
raise OcrError(
- "Tesseract OCR本体が見つかりません。Tesseractをインストールし、`tesseract`コマンドに"
- "PATHを通してください(Windows: 公式に案内されているインストーラー、"
- "Linux: `apt-get install tesseract-ocr tesseract-ocr-jpn`)。"
+ "Tesseract OCR本体が見つかりません。Tesseractをインストールするか、「設定...」で"
+ "tesseract.exe の場所を指定してください"
+ "(Windows: 公式に案内されているインストーラー、Linux: `apt-get install tesseract-ocr tesseract-ocr-jpn`)。"
)
config = f"--psm {psm} --dpi {dpi}"
app/core/settings.py に次の変更を加えます(+ が追加、- が削除)。
--- a/app/core/settings.py
+++ b/app/core/settings.py
@@ -38,6 +38,8 @@ import keyring
import keyring.errors
from keyring.backends import fail as keyring_fail
+from app.core.resources import validate_tesseract_path
+
logger = logging.getLogger(__name__)
#: 読み取りモード。既定はローカル完結(図面を社外に送らない)
@@ -94,6 +96,8 @@ class AppSettings:
ai_model: str = ""
#: 起動時に読み込む転記の設定ファイル(第8回のYAML)。空なら読み込まない
default_mapping_path: str = ""
+ #: Tesseract OCR本体(tesseract.exe)の場所(第11回)。空なら自動で探す(`app/core/resources.find_tesseract()`)
+ tesseract_path: str = ""
@property
def external_ai_allowed(self) -> bool:
@@ -164,10 +168,15 @@ def validate_settings(settings: AppSettings) -> AppSettings:
"""設定値を検証し、正規化した `AppSettings` を返す。"""
if settings.read_mode not in READ_MODES:
raise SettingsError(f"読み取りモードの値が不正です({', '.join(READ_MODES)} のいずれか)。")
+ try:
+ tesseract_path = validate_tesseract_path(settings.tesseract_path)
+ except ValueError as exc:
+ raise SettingsError(str(exc)) from None
return replace(
settings,
ai_model=validate_model_id(settings.ai_model),
default_mapping_path=settings.default_mapping_path.strip(),
+ tesseract_path=tesseract_path,
)
@@ -202,7 +211,9 @@ def load_settings(path: str | Path | None = None) -> AppSettings:
raise SettingsError(f"対応していない設定ファイルの版です(version: {SETTINGS_VERSION} のみ対応)。")
values: dict[str, str] = {}
- for name in ("read_mode", "ai_model", "default_mapping_path"):
+ # 第11回で tesseract_path を追加した。第10回の版で保存した設定ファイル(この項目が無い)も
+ # そのまま読める(無い項目は既定値)。項目を増やしただけなので version は 1 のまま
+ for name in ("read_mode", "ai_model", "default_mapping_path", "tesseract_path"):
if name not in data:
continue
if not isinstance(data[name], str):
@@ -224,6 +235,7 @@ def save_settings(settings: AppSettings, path: str | Path | None = None) -> Path
"read_mode": checked.read_mode,
"ai_model": checked.ai_model,
"default_mapping_path": checked.default_mapping_path,
+ "tesseract_path": checked.tesseract_path,
}
text = json.dumps(data, ensure_ascii=False, indent=2) + "\n"
try:
app/core/room_matcher.py に次の変更を加えます(+ が追加、- が削除)。
--- a/app/core/room_matcher.py
+++ b/app/core/room_matcher.py
@@ -33,10 +33,12 @@ from typing import Any
import yaml
+from app.core.resources import ROOMS_YAML, resource_path
from app.core.text_extractor import ExtractedWord
#: 部屋名辞書の既定の配置場所(`app/config/rooms.yaml`)
-DEFAULT_ROOMS_YAML_PATH = Path(__file__).resolve().parent.parent / "config" / "rooms.yaml"
+#: exe化(第11回)したときは、exeの展開先(`sys._MEIPASS`)の中を指す(`app/core/resources.py`)
+DEFAULT_ROOMS_YAML_PATH = resource_path(*ROOMS_YAML)
#: 部屋名候補として許容するフォントサイズの既定範囲(ポイント単位)。
#: 図面上の部屋名ラベルは実務上おおむね8〜40pt程度に収まることが多く、
app/core/mapping.py に次の変更を加えます(+ が追加、- が削除)。
--- a/app/core/mapping.py
+++ b/app/core/mapping.py
@@ -50,10 +50,11 @@ 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.resources import MAPPING_EXAMPLE_YAML, resource_path
from app.core.room_matcher import RoomDictionary
-#: 設定ファイルのサンプルの配置場所(`app/config/mapping.example.yaml`)
-EXAMPLE_MAPPING_PATH = Path(__file__).resolve().parent.parent / "config" / "mapping.example.yaml"
+#: 設定ファイルのサンプルの配置場所(exe化したときは展開先の中。`app/core/resources.py`)
+EXAMPLE_MAPPING_PATH = resource_path(*MAPPING_EXAMPLE_YAML)
LAYOUT_SEQUENTIAL = "sequential"
LAYOUT_FIXED = "fixed"
app/ui/settings_dialog.py に次の変更を加えます(+ が追加、- が削除)。
app/ui/settings_dialog.py の差分(100行)
--- a/app/ui/settings_dialog.py
+++ b/app/ui/settings_dialog.py
@@ -6,6 +6,7 @@
- APIキー:OSの資格情報ストア(Windowsでは資格情報マネージャー)への保存・削除。
入力欄は伏せ字で、保存済みのキーは画面に一切表示しない(状態だけを出す)
- 起動時に読み込む転記の設定ファイル(第8回のYAML)
+- Tesseract OCR本体(tesseract.exe)の場所(第11回。空欄なら自動で探す)
「OK」で `AppSettings` を返し、保存は呼び出し側(メイン画面)が `save_settings()` で行う。
APIキーの「保存」「削除」は資格情報ストアへすぐに反映する(OK/キャンセルとは別)。
@@ -20,6 +21,7 @@ from pathlib import Path
from tkinter import filedialog, messagebox, ttk
from app.core.ocr_ai import DEFAULT_AI_MODEL
+from app.core.resources import describe_tesseract_location, find_tesseract, tesseract_exe_name
from app.core.settings import (
MODE_EXTERNAL_AI,
MODE_LOCAL,
@@ -36,6 +38,7 @@ from app.core.settings import (
DIALOG_TITLE = "設定"
MAPPING_FILETYPES = [("転記の設定ファイル(YAML)", "*.yaml *.yml")]
+TESSERACT_FILETYPES = [("Tesseract OCR本体", tesseract_exe_name()), ("すべてのファイル", "*")]
#: 入力欄に表示する伏せ字の文字
_MASK_CHAR = "●"
@@ -55,9 +58,13 @@ class SettingsDialog(tk.Toplevel):
self.api_key_var = tk.StringVar(value="")
self.key_status_var = tk.StringVar(value="")
self.mapping_var = tk.StringVar(value=settings.default_mapping_path)
+ self.tesseract_var = tk.StringVar(value=settings.tesseract_path)
+ self.tesseract_status_var = tk.StringVar(value="")
self._build_widgets()
self._refresh_key_status()
+ self._refresh_tesseract_status()
+ self.tesseract_var.trace_add("write", lambda *_a: self._refresh_tesseract_status())
self.protocol("WM_DELETE_WINDOW", self._on_cancel)
self.bind("<Escape>", lambda _e: self._on_cancel())
@@ -128,12 +135,24 @@ class SettingsDialog(tk.Toplevel):
side="left", padx=(4, 0)
)
+ # 第11回:Tesseract OCR本体の場所。exeを配る先のPCではPATHが通っていないことがあるため指定できるようにする
+ ocr = ttk.LabelFrame(body, text="ローカルOCR(Tesseract OCR本体の場所。空欄なら自動で探す)", padding=10)
+ ocr.grid(row=3, column=0, sticky="ew", pady=(12, 0))
+ ocr.columnconfigure(0, weight=1)
+ ttk.Entry(ocr, textvariable=self.tesseract_var, width=60).grid(row=0, column=0, sticky="ew")
+ ocr_buttons = ttk.Frame(ocr)
+ ocr_buttons.grid(row=0, column=1, sticky="e", padx=(6, 0))
+ ttk.Button(ocr_buttons, text="選ぶ...", command=self._on_choose_tesseract).pack(side="left")
+ ttk.Button(ocr_buttons, text="自動", command=lambda: self.tesseract_var.set("")).pack(side="left", padx=(4, 0))
+ self.tesseract_status_label = ttk.Label(ocr, textvariable=self.tesseract_status_var, foreground="#555555")
+ self.tesseract_status_label.grid(row=1, column=0, columnspan=2, sticky="w", pady=(6, 0))
+
ttk.Label(body, text=f"設定の保存先:{self._settings_path}", foreground="#555555").grid(
- row=3, column=0, sticky="w", pady=(12, 0)
+ row=4, column=0, sticky="w", pady=(12, 0)
)
buttons = ttk.Frame(body)
- buttons.grid(row=4, column=0, sticky="e", pady=(12, 0))
+ buttons.grid(row=5, column=0, sticky="e", pady=(12, 0))
ttk.Button(buttons, text="キャンセル", command=self._on_cancel).pack(side="right")
ttk.Button(buttons, text="OK", command=self._on_ok).pack(side="right", padx=(0, 6))
@@ -181,6 +200,24 @@ class SettingsDialog(tk.Toplevel):
if path:
self.mapping_var.set(path)
+ def _on_choose_tesseract(self) -> None:
+ path = filedialog.askopenfilename(
+ title="Tesseract OCR本体(tesseract.exe)を選択", filetypes=TESSERACT_FILETYPES, parent=self
+ )
+ if path:
+ self.tesseract_var.set(path)
+
+ def _refresh_tesseract_status(self) -> None:
+ """入力中の場所でTesseractが見つかるかを表示する(保存はOKを押したとき)。"""
+ try:
+ location = find_tesseract(self.tesseract_var.get())
+ except ValueError as exc:
+ self.tesseract_status_var.set(str(exc))
+ self.tesseract_status_label.configure(foreground="#b00020")
+ return
+ self.tesseract_status_var.set(describe_tesseract_location(location))
+ self.tesseract_status_label.configure(foreground="#1f5fbf" if location.found else "#b00020")
+
def _collect(self) -> AppSettings:
"""画面の入力から `AppSettings` を作って検証する(不正なら `SettingsError`)。"""
model = validate_model_id(self.model_var.get())
@@ -189,6 +226,7 @@ class SettingsDialog(tk.Toplevel):
read_mode=self.mode_var.get(),
ai_model=model,
default_mapping_path=self.mapping_var.get(),
+ tesseract_path=self.tesseract_var.get(),
)
)
app/ui/main_window.py に次の変更を加えます(+ が追加、- が削除)。
--- a/app/ui/main_window.py
+++ b/app/ui/main_window.py
@@ -92,8 +92,10 @@ from app.core.settings import (
redact_secrets,
save_settings,
)
-from app.core.ocr_local import OcrError, is_tesseract_available, ocr_rendered_page
+from app import __version__
+from app.core.ocr_local import OcrError, configure_tesseract, is_tesseract_available, ocr_rendered_page
from app.core.pdf_loader import PdfDocument, PdfLoadError
+from app.core.resources import TesseractLocation, describe_tesseract_location, find_tesseract
from app.core.review_model import ReviewedRoom, ReviewError, ReviewList
from app.core.room_matcher import RoomCandidate, RoomDictionaryError, filter_room_candidates, load_room_dictionary
from app.core.text_extractor import ExtractedWord, extract_words
@@ -102,7 +104,8 @@ from app.ui.preview_canvas import PreviewCanvas
from app.ui.review_dialog import open_review_dialog
from app.ui.settings_dialog import open_settings_dialog
-WINDOW_TITLE = "間取りOCR転記ツール"
+#: 第11回から版を表示する(利用者に「どの版を使っているか」を確認してもらえるように)
+WINDOW_TITLE = f"間取りOCR転記ツール v{__version__}"
WINDOW_SIZE = "760x980"
PDF_FILETYPES = [("PDFファイル", "*.pdf")]
@@ -502,6 +505,12 @@ class MainWindow(ttk.Frame):
# OCR機能自体が使えない環境(Tesseract本体未インストール)では、
# 埋め込み文字が無かった場合そのまま「検出0件」として扱う。
on_detected([], "embedded")
+ # 第11回:exeを配った先で「0件」の理由が分かるよう、Tesseractが無いことを表示する
+ self.status_var.set(
+ "このページには埋め込み文字がありません。"
+ + describe_tesseract_location(self.tesseract_location)
+ + "。「設定...」でTesseractの場所を指定できます。"
+ )
return
try:
@@ -579,13 +588,24 @@ class MainWindow(ttk.Frame):
# --- 設定(第10回) ------------------------------------------------------------
def _apply_settings(self) -> None:
- """設定を画面に反映する。ローカル完結モードなら「外部AI」の選択肢を無効にし、ローカルに戻す。"""
+ """設定を画面に反映する。ローカル完結モードなら「外部AI」の選択肢を無効にし、ローカルに戻す。
+
+ 第11回:Tesseractの場所(設定→アプリと同じフォルダ→PATH→標準のインストール先)もここで決める。
+ """
+ self.tesseract_location = self._find_tesseract()
+ configure_tesseract(self.tesseract_location.path)
if self.settings.external_ai_allowed:
self.ai_radio.configure(state="normal", text=AI_RADIO_TEXT_ALLOWED)
else:
self.ai_radio.configure(state="disabled", text=AI_RADIO_TEXT_DISABLED)
self.read_mode_var.set(READ_MODE_LOCAL)
+ def _find_tesseract(self) -> TesseractLocation:
+ try:
+ return find_tesseract(self.settings.tesseract_path)
+ except ValueError:
+ return TesseractLocation(None, None, missing_configured=self.settings.tesseract_path)
+
def _load_default_mapping(self) -> None:
"""設定画面で指定した「起動時に読み込む転記の設定ファイル」を読み込む(無ければ何もしない)。"""
path = self.settings.default_mapping_path
@@ -622,7 +642,8 @@ class MainWindow(ttk.Frame):
if mapping_changed:
self._load_default_mapping()
mode = "外部AIを許可" if new_settings.external_ai_allowed else "ローカル完結"
- self.status_var.set(f"設定を保存しました(読み取りモード:{mode})。")
+ ocr = "OCR:使用可" if self.tesseract_location.found else "OCR:Tesseractが見つかりません"
+ self.status_var.set(f"設定を保存しました(読み取りモード:{mode}/{ocr})。")
def _on_detect_text(self) -> None:
"""表示中のページの文字を検出し、検出枠をプレビューに重ねて表示する。
requirements.txt に次の変更を加えます(+ が追加、- が削除)。
--- a/requirements.txt
+++ b/requirements.txt
@@ -2,6 +2,8 @@
# 間取りOCR転記ツール(madori-ocr連載)の依存パッケージ。
# バージョンは、各回の記事の公開日の時点でPyPIに存在するものに固定している
# (`pip index versions <pkg>` で確認済み)。
+#
+# 第11回:exe化に使う PyInstaller は、アプリの実行には不要なため requirements-dev.txt に分けた。
pytest==9.0.2
ruff==0.14.11
.gitignore に次の変更を加えます(+ が追加、- が削除)。
--- a/.gitignore
+++ b/.gitignore
@@ -30,3 +30,8 @@ output/
# 第9回:一括処理の出力フォルダ・ログ(顧客の図面由来のファイル名を含みうる)
転記結果_*/
batch_log.txt
+
+# 第11回:PyInstallerの中間ファイル・ビルド結果・配布用zip、生成したアイコン(build/madori_ocr.spec はコミットする)
+/build/*
+!/build/madori_ocr.spec
+/dist/
テストです。resources.py のテストを新しく作り、共通設定と設定のテストに今回の分を足します。
tests/test_resources.py を新しく作ります(全文)。
tests/test_resources.py の全文(211行)
# tests/test_resources.py
"""`app/core/resources.py`(同梱ファイルとTesseractの場所)のテスト(第11回)。
exe化したときの `sys.frozen`・`sys._MEIPASS` や、WindowsのOS名・環境変数は引数で
差し替えられるので、Linux上のpytestでも「exeとして動いている場合」「Windowsの場合」を確かめられる。
"""
from __future__ import annotations
import sys
from pathlib import Path, PureWindowsPath
import pytest
from app.core import ocr_local
from app.core.mapping import EXAMPLE_MAPPING_PATH
from app.core.resources import (
MAPPING_EXAMPLE_YAML,
PROJECT_ROOT,
ROOMS_YAML,
TESSERACT_FROM_APP_DIR,
TESSERACT_FROM_PATH,
TESSERACT_FROM_SETTINGS,
TESSERACT_FROM_STANDARD,
TesseractLocation,
app_dir,
bundle_dir,
describe_tesseract_location,
find_tesseract,
is_frozen,
resource_path,
standard_tesseract_paths,
tesseract_exe_name,
validate_tesseract_path,
)
from app.core.room_matcher import DEFAULT_ROOMS_YAML_PATH
# --- 同梱ファイル ------------------------------------------------------------------
def test_source_run_uses_project_root() -> None:
"""ソースから実行(pytest)しているときは、プロジェクトのルートを基準にする。"""
assert not is_frozen()
assert bundle_dir() == PROJECT_ROOT
assert (PROJECT_ROOT / "app" / "__init__.py").is_file()
assert resource_path(*ROOMS_YAML) == PROJECT_ROOT / "app" / "config" / "rooms.yaml"
def test_bundled_files_exist_when_run_from_source() -> None:
"""exeに同梱するファイル(`build/madori_ocr.spec` の datas)がソースの中に実在する。"""
assert resource_path(*ROOMS_YAML).is_file()
assert resource_path(*MAPPING_EXAMPLE_YAML).is_file()
assert DEFAULT_ROOMS_YAML_PATH == resource_path(*ROOMS_YAML)
assert EXAMPLE_MAPPING_PATH == resource_path(*MAPPING_EXAMPLE_YAML)
def test_frozen_uses_meipass(tmp_path: Path) -> None:
"""exe(sys.frozen と _MEIPASS あり)なら、展開先の一時フォルダを基準にする。"""
meipass = str(tmp_path / "_MEI12345")
assert is_frozen(frozen=True, meipass=meipass)
assert bundle_dir(frozen=True, meipass=meipass) == Path(meipass)
assert resource_path(*ROOMS_YAML, frozen=True, meipass=meipass) == Path(meipass) / "app" / "config" / "rooms.yaml"
def test_frozen_attributes_read_from_sys(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
"""引数を省略すると、実際の `sys.frozen`・`sys._MEIPASS`(PyInstallerが設定する)を見る。"""
monkeypatch.setattr(sys, "frozen", True, raising=False)
monkeypatch.setattr(sys, "_MEIPASS", str(tmp_path), raising=False)
assert is_frozen()
assert resource_path("app", "config", "rooms.yaml") == tmp_path / "app" / "config" / "rooms.yaml"
@pytest.mark.parametrize(("frozen", "meipass"), [(True, ""), (False, "/tmp/_MEI1")])
def test_not_frozen_unless_both_are_set(frozen: bool, meipass: str) -> None:
"""`sys.frozen` だけ・`_MEIPASS` だけ(他のexe化ツール等)では、ソース実行として扱う。"""
assert not is_frozen(frozen=frozen, meipass=meipass)
assert bundle_dir(frozen=frozen, meipass=meipass) == PROJECT_ROOT
@pytest.mark.parametrize("parts", [(), ("..", "secret.txt"), ("app", "..", "..", "x"), ("/etc/passwd",), ("",)])
def test_resource_path_rejects_outside_paths(parts: tuple[str, ...]) -> None:
with pytest.raises(ValueError):
resource_path(*parts)
def test_app_dir_is_exe_folder_when_frozen(tmp_path: Path) -> None:
"""exeなら、一時フォルダではなく exe のあるフォルダ(利用者に見える場所)。"""
exe = tmp_path / "配布" / "MadoriOCR.exe"
exe.parent.mkdir()
exe.write_bytes(b"")
assert app_dir(frozen=True, meipass=str(tmp_path / "_MEI1"), executable=str(exe)) == exe.parent
assert app_dir(frozen=False, meipass=None, executable=str(exe)) == PROJECT_ROOT
# --- Tesseractの場所 ------------------------------------------------------------------
def _files(*paths: str | Path):
existing = {str(p) for p in paths}
return lambda path: str(path) in existing
def test_exe_name_depends_on_os() -> None:
assert tesseract_exe_name("win32") == "tesseract.exe"
assert tesseract_exe_name("linux") == "tesseract"
def test_standard_paths_on_windows() -> None:
env = {
"ProgramFiles": r"C:\Program Files",
"ProgramFiles(x86)": r"C:\Program Files (x86)",
"LOCALAPPDATA": r"C:\Users\taro\AppData\Local",
}
paths = [PureWindowsPath(p) for p in standard_tesseract_paths("win32", env)]
assert paths == [
PureWindowsPath(r"C:\Program Files\Tesseract-OCR\tesseract.exe"),
PureWindowsPath(r"C:\Program Files (x86)\Tesseract-OCR\tesseract.exe"),
PureWindowsPath(r"C:\Users\taro\AppData\Local\Programs\Tesseract-OCR\tesseract.exe"),
]
assert standard_tesseract_paths("linux", env) == []
assert standard_tesseract_paths("win32", {}) == []
def test_configured_path_wins(tmp_path: Path) -> None:
configured = tmp_path / "Tesseract-OCR" / "tesseract.exe"
location = find_tesseract(
str(configured),
platform="win32",
environ={},
app_directory=tmp_path,
which=lambda _name: "/usr/bin/tesseract",
is_file=_files(configured),
)
assert location == TesseractLocation(configured, TESSERACT_FROM_SETTINGS)
def test_configured_folder_is_accepted(tmp_path: Path) -> None:
"""設定でフォルダ(C:\\Program Files\\Tesseract-OCR)を指定しても、中の tesseract.exe を使う。"""
folder = tmp_path / "Tesseract-OCR"
location = find_tesseract(
str(folder), platform="win32", environ={}, app_directory=tmp_path, is_file=_files(folder / "tesseract.exe")
)
assert location.path == folder / "tesseract.exe"
assert location.source == TESSERACT_FROM_SETTINGS
def test_missing_configured_path_does_not_fall_back(tmp_path: Path) -> None:
"""設定した場所に無いときは、PATH上の別のTesseractを黙って使わない。"""
location = find_tesseract(
str(tmp_path / "nothing.exe"),
platform="win32",
environ={},
app_directory=tmp_path,
which=lambda _name: "/usr/bin/tesseract",
is_file=_files("/usr/bin/tesseract"),
)
assert not location.found
assert location.missing_configured == str(tmp_path / "nothing.exe")
assert "見つかりません" in describe_tesseract_location(location)
def test_search_order_without_setting(tmp_path: Path) -> None:
"""設定が空なら、アプリと同じフォルダ → PATH → 標準のインストール先の順。"""
app_folder = tmp_path / "MadoriOCR"
bundled = app_folder / "tesseract" / "tesseract.exe"
standard = Path(r"C:\Program Files") / "Tesseract-OCR" / "tesseract.exe"
env = {"ProgramFiles": r"C:\Program Files"}
kwargs = {"platform": "win32", "environ": env, "app_directory": app_folder}
everything = find_tesseract("", which=lambda _n: r"D:\bin\tesseract.exe", is_file=_files(bundled, standard), **kwargs)
assert (everything.path, everything.source) == (bundled, TESSERACT_FROM_APP_DIR)
on_path = find_tesseract("", which=lambda _n: r"D:\bin\tesseract.exe", is_file=_files(standard), **kwargs)
assert (on_path.path, on_path.source) == (Path(r"D:\bin\tesseract.exe"), TESSERACT_FROM_PATH)
installed = find_tesseract("", which=lambda _n: None, is_file=_files(standard), **kwargs)
assert (installed.path, installed.source) == (standard, TESSERACT_FROM_STANDARD)
nothing = find_tesseract("", which=lambda _n: None, is_file=_files(), **kwargs)
assert nothing == TesseractLocation(None, None)
assert "OCRは使えません" in describe_tesseract_location(nothing)
@pytest.mark.parametrize(
("text", "expected"),
[("", ""), (" ", ""), ('"C:\\Tesseract-OCR\\tesseract.exe"', "C:\\Tesseract-OCR\\tesseract.exe"), (" /usr/bin/tesseract ", "/usr/bin/tesseract")],
)
def test_validate_tesseract_path(text: str, expected: str) -> None:
assert validate_tesseract_path(text) == expected
@pytest.mark.parametrize("text", ["C:\\a\nb.exe", "C:\\" + "a" * 1100])
def test_validate_tesseract_path_rejects(text: str) -> None:
with pytest.raises(ValueError):
validate_tesseract_path(text)
# --- pytesseract への反映(app/core/ocr_local.py) ---------------------------------------
def test_configure_tesseract_sets_full_path(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
exe = tmp_path / "tesseract.exe"
ocr_local.configure_tesseract(exe)
assert ocr_local.tesseract_command() == str(exe)
asked: list[str] = []
monkeypatch.setattr("app.core.ocr_local.shutil.which", lambda name: asked.append(name) or name)
assert ocr_local.is_tesseract_available()
assert asked == [str(exe)] # PATHの "tesseract" ではなく、指定したフルパスを確認する
ocr_local.configure_tesseract(None)
assert ocr_local.tesseract_command() == ocr_local.DEFAULT_TESSERACT_CMD
tests/conftest.py に次の変更を加えます(+ が追加、- が削除)。
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -5,6 +5,9 @@ APIキーの保存先(keyring)は、実行するPCのOSの資格情報スト
テストが開発者の本物の資格情報を読んだり書き換えたりしないよう、すべてのテストで
keyring のバックエンドをメモリ上の実装に差し替える(`keyring.set_keyring()`)。
Linuxのサーバー・CIのように資格情報ストアが使えない環境でも同じように動く。
+
+第11回:Tesseractの場所(pytesseractのモジュール変数 `tesseract_cmd`)を変えるテストが
+ほかのテストに影響しないよう、テストごとに元に戻す。
"""
from __future__ import annotations
@@ -15,6 +18,7 @@ import keyring
import keyring.backend
import keyring.errors
import pytest
+import pytesseract
class MemoryKeyring(keyring.backend.KeyringBackend):
@@ -49,3 +53,13 @@ def memory_keyring(monkeypatch: pytest.MonkeyPatch) -> Iterator[MemoryKeyring]:
yield backend
finally:
keyring.set_keyring(previous)
+
+
+@pytest.fixture(autouse=True)
+def restore_tesseract_cmd() -> Iterator[None]:
+ """テストの中で `configure_tesseract()` を呼んでも、終わったら元の設定に戻す(第11回)。"""
+ previous = pytesseract.pytesseract.tesseract_cmd
+ try:
+ yield
+ finally:
+ pytesseract.pytesseract.tesseract_cmd = previous
tests/test_settings.py に次の変更を加えます(+ が追加、- が削除)。
--- a/tests/test_settings.py
+++ b/tests/test_settings.py
@@ -87,6 +87,7 @@ def test_save_and_load_round_trip(tmp_path: Path) -> None:
read_mode=MODE_EXTERNAL_AI,
ai_model="claude-haiku-4-5-20251001",
default_mapping_path="C:/設定/mapping.yaml",
+ tesseract_path="C:/Program Files/Tesseract-OCR/tesseract.exe",
)
saved = save_settings(original, path)
assert saved == path and path.exists()
@@ -97,6 +98,7 @@ def test_save_and_load_round_trip(tmp_path: Path) -> None:
"read_mode": "external_ai",
"ai_model": "claude-haiku-4-5-20251001",
"default_mapping_path": "C:/設定/mapping.yaml",
+ "tesseract_path": "C:/Program Files/Tesseract-OCR/tesseract.exe",
}
assert [p.name for p in path.parent.iterdir()] == ["settings.json"] # 一時ファイルが残らない
@@ -323,3 +325,38 @@ def test_batch_processing_never_calls_external_ai() -> None:
source = (CODE_DIR / "app" / "core" / "batch.py").read_text(encoding="utf-8")
assert "ocr_ai" not in source
assert settings_module.MODE_LOCAL == "local"
+
+
+# --- 第11回:Tesseractの場所 ------------------------------------------------------------
+
+
+def test_settings_saved_by_version_10_still_load(tmp_path: Path) -> None:
+ """第10回の版で保存した(tesseract_path の無い)設定ファイルを、更新版がそのまま読める。"""
+ path = tmp_path / "settings.json"
+ path.write_text(
+ json.dumps({"version": 1, "read_mode": "external_ai", "ai_model": "", "default_mapping_path": ""}),
+ encoding="utf-8",
+ )
+ loaded = load_settings(path)
+ assert loaded.external_ai_allowed
+ assert loaded.tesseract_path == ""
+
+
+def test_tesseract_path_is_trimmed_and_unquoted(tmp_path: Path) -> None:
+ """エクスプローラーの「パスのコピー」で付く前後の引用符・空白は外して保存する。"""
+ path = tmp_path / "settings.json"
+ save_settings(AppSettings(tesseract_path=' "D:\\Tools\\Tesseract-OCR\\tesseract.exe" '), path)
+ assert load_settings(path).tesseract_path == "D:\\Tools\\Tesseract-OCR\\tesseract.exe"
+
+
+@pytest.mark.parametrize("value", ["C:/tesseract\n.exe", "x" * 1025])
+def test_invalid_tesseract_path_is_rejected(tmp_path: Path, value: str) -> None:
+ with pytest.raises(SettingsError):
+ save_settings(AppSettings(tesseract_path=value), tmp_path / "settings.json")
+
+
+def test_tesseract_path_must_be_string_in_file(tmp_path: Path) -> None:
+ path = tmp_path / "settings.json"
+ path.write_text(json.dumps({"version": 1, "tesseract_path": 123}), encoding="utf-8")
+ with pytest.raises(SettingsError, match="tesseract_path"):
+ load_settings(path)
動かしてみる
pytest
ruff check .
python app/main.py
pytest で「382 passed」と表示されれば完了です。exeのビルドは、上の「Windowsでのビルド手順」のとおり、ビルド用の仮想環境(.venv-build)で行います。ビルドの前に、配布物に入れるサンプル(第7・8回の samples/room_list_template.xlsx・samples/floor_plan_sheet.xlsx)があることを確かめてください。無ければ python tools/make_sample_template.py と python tools/make_sample_template.py --floor-plan で作れます。
動作確認の方法
pytest は382件すべて成功しました(第10回までの352件に30件追加)。ruff check . もエラーはありません。_MEIPASS の有無、Tesseractを探す順番、第10回の版で保存した設定ファイルがそのまま読めることなどを確かめています。Linuxでは同じspecでビルドしました(Python 3.12)。
| 確認したこと | 結果(Linux・4vCPU) |
|---|---|
| ビルド | 約39秒、1ファイル約58MB |
| 同梱ファイル | 展開先に rooms.yaml などがあり、終了後に一時フォルダが消える |
| 起動 | Xvfb(仮想ディスプレイ)上で3回起動し、ウィンドウ表示まで1.6〜1.7秒 |
| コア処理 | 同じ設定の確認用ビルドで第9回の架空サンプル8件を一括処理し、ソース実行と同じ結果 |
次は、ビルドしたLinux版の「設定…」画面です(開発環境(Linux)での確認画面です。Windows実機では見た目が異なります)。

なお、第10回までは python -m app.main で起動していました。python app/main.py のようにファイルを直接指定すると、検索パスの都合で app パッケージを読み込めずに失敗するため、今回 app/main.py を直して、どちらの書き方でも起動できるようにしました(このファイルはexeの起動処理にもなります)。
確認できていないこと
- Windows実機でのビルド・起動時間・アイコンとバージョン情報の表示、Microsoft Defender等の反応
- Windows版Tesseractの自動検出、exeと同じフォルダに置いた場合の日本語データの読み込み
- Python 3.13系での動作(検証は3.11/3.12)
つまずきやすい点・配布時の注意
- 初回起動が遅い:展開のぶん待ち時間があり、ウイルス対策ソフトの検査でさらに延びることがあります。説明書に「十数秒かかることがある」と書いておくと二重起動を防げます
- 誤検知が起こりうる:一般に、署名の無い自作のexeはウイルス対策ソフトに疑われたり、Windowsの警告が出たりすることがあると言われます。誤検知はMicrosoftの提出窓口から報告できます。社内配布なら情シスに除外設定や配布方法を相談するのが確実です
- コード署名:署名すると「誰が作ったか」「改ざんされていないか」を確かめられるようになります。警告が必ず消えるわけではありませんが、社外へ配るなら検討の価値があります(証明書には費用と審査が必要)
- 更新版の配り方:版を
app/__init__.pyで上げると画面のタイトルに出ます。設定は%APPDATA%にあるのでexeを差し替えても残ります。版ごとのフォルダで配り、古い版も残しておくと戻せます
📰 出典:Microsoft「Submit a file for malware analysis」
ライセンス:社内で使うか、社外へ配るかで考え方が変わる
| 対象 | ライセンス | 配布時の考え方 |
|---|---|---|
| PyMuPDF | AGPL-3.0 またはArtifex社の商用ライセンス | exeを社外へ配布・販売する場合は、AGPLの条件(ソースコードの提供など)を満たすか、商用ライセンスを検討 |
| Tesseract | Apache-2.0 | 同梱する場合はライセンス文を配布物に含める |
| PyInstaller | GPL-2.0以降+例外 | 作ったアプリは自由なライセンスで配布できる |
PyMuPDFの公式ドキュメントでは、AGPLの条件を満たせない場合はArtifex社へ商用ライセンスを問い合わせるよう案内されています。社内だけで使うか、取引先へ配る・販売するかで必要な対応が変わります。個別の判断は弁護士などの専門家に確認してください。
📰 出典:Tesseract LICENSE
連載のまとめ:完成したツールでできること・できないこと
| 回 | 内容 |
|---|---|
| 第0回 | 要件整理とPython開発環境、tkinterの最初の画面 |
| 第1回 | PDFの図面ページを画面にプレビュー表示する |
| 第2回 | 図面に埋め込まれた文字を抽出し、ハイライトする |
| 第3回 | 部屋名らしき文字列を絞り込むルール |
| 第4回 | スキャン図面向けのローカルOCR |
| 第5回 | 外部AIの画像解析で精度を底上げする |
| 第6回 | 検出結果を人が確認・修正する画面 |
| 第7回 | 指定のExcelフォーマットの決まった欄へ転記する |
| 第8回 | 対応付けを設定ファイルで変えられるようにする |
| 第9回 | 複数のPDFをまとめて処理する |
| 第10回 | ローカル完結モードと外部AIモードの切り替え |
| 第11回 | exe化と配布、運用ルールの整理(この記事) |
できること:埋め込み文字・ローカルOCR・(許可時のみ)外部AIでの部屋名の読み取り、人による確認・修正、書式を残したExcelへの転記、様式ごとの対応付けの切り替え、フォルダ単位の一括処理、exeでの配布。
できないこと:手書き・縦書き・かすれの強い図面の安定した読み取り、部屋名以外(階・面積)の転記、欄が足りない場合の行追加、外部AIでの一括処理。実在の図面での精度は測っておらず、Windows実機での確認も残っています。
精度の限界と、最終確認の運用ルール
OCRも外部AIも誤読をゼロにはできません(第9回の低解像度の架空スキャンでも7部屋中1部屋を取りこぼしました)。「誤りは起きる」前提で運用を決めておきます。
- 転記前に、確認画面で図面と見比べて1件ずつ確認する
- 一括処理の「成功」は機械的な確認に通っただけ。出力したExcelを開いて確認する
- 「要確認」の件数と理由を記録し、辞書(rooms.yaml)の追加や運用の見直しに使う
- 誤転記が見つかったときの連絡先と、直し方(再実行か手修正か)を決めておく
発注者向けメモ
exeと一緒に「精度の限界」と「最終確認の運用ルール」を納品してもらう
exeだけでは「どの図面なら読めるか」「誰がどこまで確認するか」が決まりません。曖昧なままだと、誤転記のとき「不具合か運用の漏れか」で揉めがちです。次をセットで納品してもらうのがおすすめです。
- 自社の実際の図面で測った、読み取れた割合と「要確認」の割合
- 読めない図面の例と、そのときの手順
- 最終確認のルール(上の4項目のような内容)
- 配布手順(Tesseract・初回起動・更新版の差し替え)とライセンスの一覧
内製するか、外注するかの判断ポイント
| 観点 | 内製が向く | 外注が向く |
|---|---|---|
| 様式・図面の種類 | 少なく、変化もゆっくり | 多い、取引先ごとに違う |
| 配布範囲 | 社内の数人 | 社外・多拠点(署名・サポートが必要) |
| 体制 | Pythonを保守できる人が社内にいる | 担当者の異動・退職で止まるおそれがある |
最初は外注で作り、辞書・対応付けの追加は社内で行う分け方も現実的です。
保守で発生すること(契約前に範囲を決める)
- ライブラリの更新:不具合・脆弱性の修正のたびに、ビルドと動作確認が必要です
- Windowsの更新:大型更新後に、起動・ファイル選択・資格情報の保存を確認します
- AIモデルの提供終了:Anthropicの公式ドキュメントでは、非推奨になると後継モデルと提供終了日が示され、提供終了後のモデルへのリクエストは失敗すると説明されています。モデルIDは設定画面で変えられますが、後継モデルでの精度確認は必要です
📰 出典:Anthropic「Model deprecations」
- ☐ 精度の実測結果と最終確認のルールを納品物に含めたか
- ☐ 社外へ配る場合、PyMuPDFのライセンスの扱いを専門家に確認したか
- ☐ ライブラリ・Windows・AIモデルの更新への対応を、保守契約の範囲に入れたか
開発会社への質問例
- 「ウイルス対策ソフトに止められたとき、どう切り分けますか?」
- 「Tesseractは同梱ですか、インストール前提ですか?」
- 「自社の図面で精度を測った結果を、納品前に見せてもらえますか?」
まとめ
第11回では、PyInstaller 6.19.0のspecファイルを書き、同梱ファイルを sys._MEIPASS を考慮して解決し、Tesseractの場所を設定できるようにしました。Linux向けのビルドと起動は確認できましたが、Windows実機での確認は残っています。
全12回で、図面PDFの表示から読み取り・確認・転記・一括処理・配布までを作りました。AIやOCRは「確認を減らす道具」であって「確認をなくす道具」ではありません。ツールと運用ルールをセットで整えることが、長く使える自動化の近道です。連載にお付き合いいただき、ありがとうございました。
この連載の記事一覧
この記事は連載「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件)
[…] 次回(第11回・最終回)は「Windows向けにexe化して配布し、運用時の注意点を整理する」です。PyInstallerで単一のexeにまとめ、配布・初回起動時の注意点と、精度の限界を踏まえた最終チェック体制を整理します。 […]