会社Good Labでエンジニアをしている コータロー です。
日々、Java・SQL・Gitなどの技術情報や、新人エンジニア向けの学習ノウハウ、
AI活用についての情報を発信しています。
Good Labについて気になった方は、コーポレートサイトもぜひご覧ください。
▶コーポレートサイト
はじめに
「Java経験者のためのPython入門」第3回です。前回(第2回)の関数・例外・モジュールを使って、小さな業務ツールを1本作ります。
| 回 | テーマ |
|---|---|
| 第1回 | 基礎文法 ― Java との違いで覚える |
| 第2回 | 関数・例外・モジュール ― def の書き方と、ツールの骨格を読むための知識 |
| 第3回(本記事) | Excel の管理表と pom.xml を突き合わせて、差分を GUI に出すツールを作る |
| 第4回 | 既存ツールを読んで直す(ライブラリの見分け方・EXE 化・Windows での注意・安全な直し方) |
題材は、Excel で管理している利用ライブラリの管理表と、pom.xml に実際に書かれている依存関係を突き合わせ、差分を画面に出すツール です。管理表は人が、pom.xml は開発者が更新するので、放っておくとずれていきます。Excel を読む(openpyxl)・XML を読む(ElementTree)・画面を出す(tkinter)という、Python の業務ツールによくある3点が1本にそろいます。
| 種類 | 動作確認した環境 |
|---|---|
| OS | macOS |
| Python | 3.14.8 |
| ライブラリ | openpyxl 3.1.5 / tkinter(Tk 9.0) |
- 型ヒントの
str | Noneは Python 3.10 以降の書き方です。3.9 以前では、ファイルの先頭にfrom __future__ import annotationsを追加してください。ElementTree の{*}は 3.8 以降です - Windows では検証していません。Windows のパス、Excel で開いたままのファイル、EXE 化などは第4回で扱います
作るもの
比較キーは groupId:artifactId(Maven の座標から version を除いたもの)です。結果を「Excelにだけある(もう使っていない?)」「pomにだけある(管理表に載っていない)」「一致」「版が違う(管理表の承認済みの版と違う)」の4つに分け、件数も出します。
画面には、ファイル選択×2、正規化の有無を切り替えるチェックボックス、比較ボタン、結果の表(ttk.Treeview)、件数表示を置きます。エラーは messagebox で必ず見せ、表は空にします。
ファイル構成と、分ける理由
03_excel_pom_diff/
├── diff_core.py # 読み込み・比較(画面に依存しない)
├── main.py # 画面(tkinter)
├── make_sample_excel.py # サンプルの管理表を作る
└── pom.xml # サンプルの pom.xml
ロジックと画面を分けるのは、画面を出さずに python diff_core.py 管理表.xlsx pom.xml で結果を確かめられ、不具合の切り分けが楽になるからです。バッチなど別の入口からも同じ比較を呼べ、「判定は diff_core.py、見た目は main.py」と直す場所もすぐ決まります。Swing の ActionListener に業務ロジックを書かず Service クラスに切り出すのと同じ考え方です。
準備とサンプルデータ
macOS での準備です(Windows のコマンドは第4回で扱います)。tkinter は標準ライブラリなので、入れるのは openpyxl だけです。
python3 -m venv .venv
source .venv/bin/activate
pip install openpyxl
サンプルの pom.xml です。名前空間・dependencyManagement・プラグイン・プロパティ参照の版・版のない依存・管理表に無い依存(mockito-core)を入れています。
<project xmlns="http://maven.apache.org/POM/4.0.0">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>order-batch</artifactId>
<version>1.0.0</version>
<properties>
<slf4j.version>2.0.16</slf4j.version>
</properties>
<dependencyManagement><!-- 版の宣言だけ -->
<dependencies>
<dependency>
<groupId>org.junit</groupId>
<artifactId>junit-bom</artifactId>
<version>5.11.3</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.5.12</version>
</dependency>
<dependency>
<groupId>com.example.shared</groupId>
<artifactId>shared-util</artifactId>
<version>1.10</version>
</dependency>
<dependency><!-- 版は junit-bom が決める -->
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>5.14.2</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.5.2</version>
</plugin>
</plugins>
</build>
</project>
管理表は openpyxl で作ります。メモ列に、仕込んだ落とし穴を書いています。
"""検証用の管理表 libraries.xlsx を作る。"""
from openpyxl import Workbook
wb = Workbook()
for row in [
["groupId", "artifactId", "version", "メモ"],
["org.slf4j", "slf4j-api", "2.0.16", "版が全角"],
["ch.qos.logback", "logback-classic ", "1.5.6", "末尾に空白"],
["org.junit.jupiter", "junit-jupiter", "5.11.3", "pom 側は版なし"],
["com.example.shared", "shared-util", 1.10, "版を数値で入力"],
["commons-io", "commons-io", "2.16.1", "管理表にだけある"],
[None, None, None, None],
["org.slf4j", "slf4j-api", "2.0.16", "重複"],
]:
wb.active.append(row)
wb.save("libraries.xlsx")
print("libraries.xlsx を作成しました")
以降のスクリプトは、pom.xml・libraries.xlsx と同じフォルダで実行します。
落とし穴1:pom.xml の名前空間で dependency が0件
pom.xml の読み方を確かめるスクリプトです。落とし穴1〜3はこの出力で説明します。
import xml.etree.ElementTree as ET
root = ET.parse("pom.xml").getroot()
NS = "http://maven.apache.org/POM/4.0.0"
print(root.tag)
print("A", len(list(root.iter("dependency"))))
print("B", len(list(root.iter(f"{{{NS}}}dependency"))))
print("C", len(root.findall("m:dependencies/m:dependency", {"m": NS})))
print("D", len(root.findall("{*}dependencies/{*}dependency")))
print("E", len(list(root.iter("{*}dependency"))))
no_ns = ET.fromstring("<project><dependencies><dependency/></dependencies></project>")
print("F", len(no_ns.findall("{*}dependencies/{*}dependency")))
print("G", [e.text for e in root.findall(".//{*}artifactId")])
for dep in root.findall("{*}dependencies/{*}dependency"):
print("H", dep.findtext("{*}artifactId"), repr(dep.findtext("{*}version")))
{http://maven.apache.org/POM/4.0.0}project
A 0
B 6
C 5
D 5
E 0
F 1
G ['order-batch', 'junit-bom', 'slf4j-api', 'logback-classic', 'shared-util', 'junit-jupiter', 'mockito-core', 'maven-surefire-plugin']
H slf4j-api '${slf4j.version}'
H logback-classic '1.5.12'
H shared-util '1.10'
H junit-jupiter None
H mockito-core '5.14.2'
A が0件なのは、ルートの xmlns="http://maven.apache.org/POM/4.0.0" が 既定の名前空間 として子孫すべてに効き、ElementTree がタグ名を {名前空間URI}ローカル名 で持つからです。対処は B〜D の3通りです。
| 書き方 | 特徴 |
|---|---|
B: {URI} を直接書く |
iter() でも使える。長い |
C: namespaces 引数 |
Java の XPath に NamespaceContext を渡すのに近い。xmlns のない pom では0件 |
D: {*} ワイルドカード |
名前空間があってもなくても一致(F)。パス式の機能なので find / findall / findtext / iterfind 専用 |
このツールは D を使います。xmlns を書いていない pom.xml もあり、{*} なら同じコードで読めるからです。ただし E のとおり、iter() に {*} を渡すと0件です。iter() はタグ名をそのまま比べるだけなので、既存コードで iter("{*}...") を見かけたら疑ってください。
落とし穴2:木全体から拾うと、依存でないものが混ざる
B(木全体)は D より1件多くなっています。G のように木全体から拾うと、依存ではないものが3種類混ざります。
-
order-batch: プロジェクト 自身 の座標 -
junit-bom:<dependencyManagement>の中。版を 宣言するだけ で、これだけでは依存は増えない(版を書かない依存に版を供給する役) -
maven-surefire-plugin:<build><plugins>のプラグイン。ビルドの道具でアプリの依存ではない
D の findall("{*}dependencies/{*}dependency") は、呼び出した要素(project)からの相対パスなので、project/dependencies/dependency だけが対象になります。
落とし穴3:版がプロパティ参照・版が書かれていない
H の '${slf4j.version}' は プロパティ参照 で、そのままでは管理表の 2.0.16 と一致しません。<properties> の子要素を辞書にして置き換えます。子要素のタグも {URI}slf4j.version の形なので、tag.split("}")[-1] でローカル名を取り出します。
junit-jupiter は 版が書かれていない ので None です。版は BOM や親 pom が決めるので、pom.xml 1枚からは分かりません。このツールでは「一致」に入れて備考に残します。差分に入れると毎回同じ行が出て、本当の差分が埋もれるからです。実際の版は mvn help:effective-pom(親や BOM を反映した最終的な pom)や mvn dependency:tree(推移的な依存を含む解決結果)で Maven に解決させるのが確実です。このツールが見るのは pom.xml に直接書いた依存だけ です(Gradle の build.gradle はスクリプトなので、gradle dependencies の出力を使うほうが現実的です)。
落とし穴4:Excel の値は「見たまま」とは限らない
openpyxl が返す値の型を確かめます。
from openpyxl import Workbook, load_workbook
wb = Workbook()
for row in [[1.10, "ログ"], [2.0, None], [None, None], ["1.10", None], ['="5.11"&".3"', None]]:
wb.active.append(row)
wb.active.merge_cells("B1:B2") # 「ログ」を2行ぶん結合
wb.save("types.xlsx")
ws = load_workbook("types.xlsx", data_only=True).active
for (value,) in ws.iter_rows(max_col=1, values_only=True):
print(repr(value), type(value).__name__)
print("data_only=False:", repr(load_workbook("types.xlsx").active["A5"].value))
print("結合セル:", repr(ws["B1"].value), repr(ws["B2"].value))
1.1 float
2 int
None NoneType
'1.10' str
None NoneType
data_only=False: '="5.11"&".3"'
結合セル: 'ログ' None
-
数値として入力された版:
1.10はfloatの1.1、2.0はintの2になります。数値として保存された時点で1.10と1.1は同じ数なので、読み込んだ後で元の表記には戻せません。ツールではisinstance(値, (int, float))で見つけて警告し、管理表では版の列の書式を「文字列」にしてから入力してもらう運用で防ぎます(Excel 側の操作は Excel を起動して確かめてはいません) -
数式セル:
data_only=False(既定)では数式の文字列、data_only=Trueでは Excel が最後に保存したときの計算結果 が返ります。openpyxl で作っただけで一度も Excel で保存していないファイルには計算結果がないのでNoneです -
空セル・空行: 空セルは
""ではなくNoneです。途中の空行(3行目)もNoneだけの行として返るので、読み飛ばす処理が要ります -
結合セル: 値は左上(B1)にだけあり、ほかは
Noneです。分類欄などを縦に結合した管理表では、上の値を引き継ぐ処理が要ります -
.xls: openpyxl は古い .xls を読めず、
InvalidFileExceptionになります(後の動作確認を参照)。.xlsx に保存し直してもらいます
Apache POI で getCellType() が NUMERIC か STRING かで分岐した経験があれば、同じ問題です。
落とし穴5:表記ゆれと重複行
前後の空白や全角英数字は、人の目には同じでも文字列としては別物です。また、管理表に同じライブラリが2行あっても、set にした時点で1つに潰れて気付けません。
import unicodedata
from collections import Counter
for s in ["logback-classic ", "2.0.16", " commons-io", "①"]:
print(repr(s), "->", repr(unicodedata.normalize("NFKC", s).strip()))
keys = ["org.slf4j:slf4j-api", "commons-io:commons-io", "org.slf4j:slf4j-api"]
print(len(keys), len(set(keys)), Counter(keys))
'logback-classic ' -> 'logback-classic'
'2.0.16' -> '2.0.16'
'\u3000commons-io' -> 'commons-io'
'①' -> '1'
3 2 Counter({'org.slf4j:slf4j-api': 2, 'commons-io:commons-io': 1})
NFKC は全角英数字・記号・全角スペースを半角にし、strip() が前後の空白を取ります。ただし ① が 1 になるなど、思った以上に変換します。正規化は「何を同じとみなすか」という 仕様の決定 なので、チェックボックスで切り替えられるようにしました。
重複は collections.Counter(要素 → 個数の辞書)で数えます。Java なら Collectors.groupingBy(k -> k, Collectors.counting()) で作る Map<String, Long> です。
diff_core.py(読み込み・比較)
"""管理表(Excel)と pom.xml の依存関係を突き合わせる。
画面なしでも動く: python diff_core.py 管理表.xlsx pom.xml [--raw]
"""
import re
import sys
import unicodedata
import xml.etree.ElementTree as ET
from collections import Counter
from dataclasses import dataclass
from openpyxl import load_workbook
KINDS = ("Excelにだけある", "pomにだけある", "一致", "版が違う")
@dataclass(frozen=True)
class Library:
group_id: str
artifact_id: str
version: str | None # None は「版の記載なし」
@property
def key(self) -> str:
return f"{self.group_id}:{self.artifact_id}"
@dataclass(frozen=True)
class DiffRow:
kind: str
key: str
excel_version: str | None
pom_version: str | None
note: str = ""
def normalize(text: str) -> str:
"""全角英数字を半角に寄せ(NFKC)、前後の空白を取る。"""
return unicodedata.normalize("NFKC", text).strip()
def to_text(value: object, normalize_text: bool) -> str | None:
if value is None or not str(value).strip():
return None # 空・空白だけ
return normalize(str(value)) if normalize_text else str(value)
def read_excel(path: str, normalize_text: bool = True) -> tuple[list[Library], list[str]]:
"""先頭シートを読み、(ライブラリ一覧, 警告一覧) を返す。"""
rows = load_workbook(path, data_only=True).worksheets[0].iter_rows(values_only=True)
header = [normalize(str(h)) if h is not None else "" for h in next(rows, ())]
if not {"groupId", "artifactId", "version"} <= set(header):
raise ValueError("管理表の見出し行に groupId・artifactId・version が必要です")
g, a, v = (header.index(name) for name in ("groupId", "artifactId", "version"))
libs, warnings = [], []
for row_no, row in enumerate(rows, start=2):
group, artifact = to_text(row[g], normalize_text), to_text(row[a], normalize_text)
if group is None or artifact is None:
if group or artifact:
warnings.append(f"{row_no}行目: groupId か artifactId が空です")
continue # 空行
if isinstance(row[v], (int, float)):
warnings.append(f"{row_no}行目: 版が数値です({row[v]!r})。文字列で入力してください")
libs.append(Library(group, artifact, to_text(row[v], normalize_text)))
for key, n in Counter(lib.key for lib in libs).items():
if n > 1:
warnings.append(f"{key} が {n} 行あります(先の行で比較します)")
return libs, warnings
def resolve_version(text: str, props: dict[str, str]) -> str:
"""${名前} を <properties> の値に置き換える。無ければそのまま残す。"""
return re.sub(r"\$\{([^}]+)\}", lambda m: props.get(m.group(1), m.group(0)), text)
def read_pom(path: str, normalize_text: bool = True) -> list[Library]:
"""project/dependencies/dependency だけを読む。"""
root = ET.parse(path).getroot()
props = {p.tag.split("}")[-1]: (p.text or "").strip() for p in root.findall("{*}properties/*")}
libs = []
for dep in root.findall("{*}dependencies/{*}dependency"):
version = dep.findtext("{*}version")
if version is not None:
version = resolve_version(version, props)
libs.append(Library(to_text(dep.findtext("{*}groupId"), normalize_text),
to_text(dep.findtext("{*}artifactId"), normalize_text),
to_text(version, normalize_text)))
return libs
def compare(excel_libs: list[Library], pom_libs: list[Library]) -> list[DiffRow]:
"""groupId:artifactId で突き合わせ、4つに分類する。"""
excel: dict[str, Library] = {}
for lib in excel_libs:
excel.setdefault(lib.key, lib) # 重複したら先の行を使う
pom = {lib.key: lib for lib in pom_libs}
rows = [DiffRow(KINDS[0], k, excel[k].version, None, "もう使っていない?")
for k in excel.keys() - pom.keys()]
rows += [DiffRow(KINDS[1], k, None, pom[k].version, "管理表に載っていない")
for k in pom.keys() - excel.keys()]
for k in excel.keys() & pom.keys():
e_ver, p_ver = excel[k].version, pom[k].version
if p_ver is None:
rows.append(DiffRow(KINDS[2], k, e_ver, p_ver, "pomに版の記載なし(親・BOMで管理)"))
else:
rows.append(DiffRow(KINDS[2] if e_ver == p_ver else KINDS[3], k, e_ver, p_ver))
rows.sort(key=lambda r: (KINDS.index(r.kind), r.key))
return rows
def count_by_kind(rows: list[DiffRow]) -> dict[str, int]:
counts = Counter(r.kind for r in rows)
return {kind: counts[kind] for kind in KINDS}
def run(excel_path: str, pom_path: str, normalize_text: bool = True) -> tuple[list[DiffRow], list[str]]:
"""読み込みから比較まで。画面からもコマンドからもこれを呼ぶ。"""
excel_libs, warnings = read_excel(excel_path, normalize_text)
return compare(excel_libs, read_pom(pom_path, normalize_text)), warnings
if __name__ == "__main__":
rows, warnings = run(sys.argv[1], sys.argv[2], normalize_text="--raw" not in sys.argv)
for w in warnings:
print("警告:", w)
for r in rows:
print(f"[{r.kind}] {r.key!r} {r.excel_version!r} / {r.pom_version!r} {r.note}".rstrip())
print(count_by_kind(rows))
読むときのポイントです。
-
@dataclass(frozen=True)は Java のrecordに近く、コンストラクタ・__eq__・__repr__を自動で作ります。@propertyのkeyは括弧なしで読める getter です - 辞書の
keys()は集合演算ができます。excel.keys() - pom.keys()が「管理表にだけある」、&が「両方にある」です。Java ではSetをコピーしてからremoveAll/retainAllを呼びますが、Python の-/&は新しい集合を返すので元の辞書は変わりません -
excel.setdefault(key, lib)は Java のMap.putIfAbsentです。重複したときは先の行が残ります - 集合の順序は保証されないので、最後に
sortで並べて毎回同じ順で出します - 画面からもコマンドからも
run()だけを呼びます。コマンドの引数チェックは省いています(足りないとIndexError。本格的にするならargparse)
画面なしで動かす
$ python make_sample_excel.py
libraries.xlsx を作成しました
$ python diff_core.py libraries.xlsx pom.xml
警告: 5行目: 版が数値です(1.1)。文字列で入力してください
警告: org.slf4j:slf4j-api が 2 行あります(先の行で比較します)
[Excelにだけある] 'commons-io:commons-io' '2.16.1' / None もう使っていない?
[pomにだけある] 'org.mockito:mockito-core' None / '5.14.2' 管理表に載っていない
[一致] 'org.junit.jupiter:junit-jupiter' '5.11.3' / None pomに版の記載なし(親・BOMで管理)
[一致] 'org.slf4j:slf4j-api' '2.0.16' / '2.0.16'
[版が違う] 'ch.qos.logback:logback-classic' '1.5.6' / '1.5.12'
[版が違う] 'com.example.shared:shared-util' '1.1' / '1.10'
{'Excelにだけある': 1, 'pomにだけある': 1, '一致': 2, '版が違う': 2}
キーと版を !r(repr())で出しているので、空白や全角が混ざれば引用符の中に見えます。--raw を付けると正規化なしで比較します。件数を並べると次のとおりです。
| 分類 | 正規化あり | 正規化なし |
|---|---|---|
| Excelにだけある | 1 | 2 |
| pomにだけある | 1 | 2 |
| 一致 | 2 | 1 |
| 版が違う | 2 | 2 |
正規化なしでは、末尾に空白のある 'ch.qos.logback:logback-classic ' が「Excelにだけある」に、空白のない方が「pomにだけある」に分かれ、全角の '2.0.16' の slf4j-api が「版が違う」に移ります。一方 shared-util の '1.1' と '1.10' は正規化しても直りません。数値として読まれた時点で情報が失われているので、警告を見て管理表を直すしかありません。
main.py(画面)
"""管理表(Excel)と pom.xml の差分を画面に出す(tkinter)。"""
import tkinter as tk
from tkinter import filedialog, messagebox, ttk
import diff_core
COLUMNS = {"kind": "分類", "key": "groupId:artifactId", "excel": "管理表の版", "pom": "pomの版", "note": "備考"}
class DiffApp:
def __init__(self, root: tk.Tk) -> None:
root.title("管理表と pom.xml の差分チェック")
root.columnconfigure(1, weight=1)
root.rowconfigure(3, weight=1)
self.excel_path, self.pom_path = tk.StringVar(), tk.StringVar()
self.normalize = tk.BooleanVar(value=True)
self.summary = tk.StringVar()
for row, (label, var) in enumerate([("管理表", self.excel_path), ("pom.xml", self.pom_path)]):
ttk.Label(root, text=label).grid(row=row, column=0, padx=4)
ttk.Entry(root, textvariable=var, width=60).grid(row=row, column=1, sticky="ew")
ttk.Button(root, text="選択…", command=lambda v=var: self.choose(v)).grid(row=row, column=2)
ttk.Checkbutton(root, text="表記ゆれを正規化する", variable=self.normalize).grid(row=2, column=1, sticky="w")
self.compare_button = ttk.Button(root, text="比較", command=self.run_compare)
self.compare_button.grid(row=2, column=2)
self.tree = ttk.Treeview(root, columns=list(COLUMNS), show="headings")
for col, title in COLUMNS.items():
self.tree.heading(col, text=title)
self.tree.grid(row=3, column=0, columnspan=3, sticky="nsew")
ttk.Label(root, textvariable=self.summary).grid(row=4, column=0, columnspan=3, sticky="w")
def choose(self, var: tk.StringVar) -> None:
path = filedialog.askopenfilename()
if path: # キャンセルすると空文字が返る
var.set(path)
def run_compare(self) -> None:
self.tree.delete(*self.tree.get_children()) # 先に前回の結果を消す
excel, pom = self.excel_path.get().strip(), self.pom_path.get().strip()
if not excel or not pom:
self.summary.set("ファイルが選ばれていません")
messagebox.showwarning("入力不足", "管理表と pom.xml の両方を選んでください")
return
try:
rows, warnings = diff_core.run(excel, pom, self.normalize.get())
except Exception as e: # 画面の最上位なので広く受け、必ず利用者に見せる
self.summary.set("エラーのため比較できませんでした")
messagebox.showerror("比較できませんでした", f"{type(e).__name__}: {e}")
return
for r in rows:
versions = ["-" if v is None else v for v in (r.excel_version, r.pom_version)]
self.tree.insert("", "end", values=(r.kind, r.key, *versions, r.note))
counts = diff_core.count_by_kind(rows)
self.summary.set(" / ".join(f"{kind} {n}件" for kind, n in counts.items()))
if warnings:
messagebox.showwarning("管理表を確認してください", "\n".join(warnings))
if __name__ == "__main__":
root = tk.Tk()
DiffApp(root)
root.mainloop()
| tkinter | Swing |
|---|---|
tk.Tk() / root.mainloop()
|
JFrame / イベントディスパッチスレッド |
ttk.Button(command=...) |
JButton + ActionListener
|
ttk.Treeview |
JTable |
messagebox / filedialog
|
JOptionPane / JFileChooser
|
読むときのポイントです。
-
command=self.run_compareはメソッドそのものを渡します。self.run_compare()と書くと画面を作る時点で1回実行され、戻り値のNoneが渡ってしまいます - ループの中の
lambda v=var: self.choose(v)は、その周回の値を既定引数で固定する 書き方です。lambda: self.choose(var)と書くと、ボタンを押した時点のvar(ループ最後の値)を見るので、どちらのボタンを押しても pom.xml の欄に入ります。Java のラムダは実質的に final な変数しか取り込めないので起きない問題です -
gridは行・列の番号で部品を置き、weight=1を付けた列・行がウィンドウに合わせて伸びます -
run_compare()は最初に表を空にするので、入力不足やエラーでreturnしても古い結果が残りません - tkinter はボタンの処理で起きた例外をコンソールに出すだけで、画面は動き続けます。コンソールがなければ利用者には何も見えないので、画面の最上位で
except Exceptionで受けてmessageboxに出します。diff_core.py側では握りつぶさずに投げています - 数値の版や重複は比較はできるので、結果を出したうえで
showwarningで知らせます
動作確認
ロジックは記事中の出力と一致することを確かめました。画面は実際に起動し、root.after(...) からパスの設定・チェックボックスの切り替え・比較ボタンの invoke() を行い、Treeview の行と件数表示を読み取りました(messagebox は記録用の関数に差し替え)。
- 未選択で比較: 表は空、警告「入力不足」
- 正規化あり: 表は 6 行、件数表示は「Excelにだけある 1件 / pomにだけある 1件 / 一致 2件 / 版が違う 2件」、警告は数値の版と重複の2件
- 正規化なし: 表は 7 行、件数表示は「Excelにだけある 2件 / pomにだけある 2件 / 一致 1件 / 版が違う 2件」
- .xls・壊れた XML・存在しないファイル・管理表の欄に pom.xml: それぞれ
InvalidFileException・ParseError・FileNotFoundError・InvalidFileExceptionをエラー表示し、直前の結果も消えて表は空
ボタンの処理で例外を起こすと、トレースバックが標準エラーに出るだけで画面は動き続けることも確かめました。Windows での動作と見た目は未検証です。
まとめ
- pom.xml は既定の名前空間を持つ。
findall("{*}dependencies/{*}dependency")で場所を限定して読む({*}はiter()では効かない) - 木全体から拾うと、プロジェクト自身・
dependencyManagement・プラグインが混ざる - 版のプロパティ参照は
<properties>から解決する。版のない依存は pom.xml 1枚では決まらない - Excel の版は文字列で入力してもらう。数値の
1.10は1.1になり、元に戻せない - 表記ゆれは NFKC +
strip()、重複はCounterで数える - ロジックと画面を分け、画面の最上位では例外を必ず利用者に見せる
確認問題
問1
難易度:⭐
root.iter("dependency") で pom.xml の依存が1件も取れません。原因は何ですか。また、このツールではどう読んでいますか。
模範解答
ルートに既定の名前空間 xmlns="http://maven.apache.org/POM/4.0.0" があり、タグ名が {http://maven.apache.org/POM/4.0.0}dependency になっているためです。
このツールでは root.findall("{*}dependencies/{*}dependency") で読んでいます。{*} で名前空間を問わず一致させ、パスで project/dependencies/dependency に限定して、dependencyManagement やプラグインを拾わないようにしています。
問2
難易度:⭐⭐
diff_core.py と同じフォルダで次のコードを実行したときの出力は?
from openpyxl import Workbook
import diff_core
wb = Workbook()
for row in [["groupId", "artifactId", "version"], ["com.example", "a", 1.20], ["com.example", "b", 3.0]]:
wb.active.append(row)
wb.save("q2.xlsx")
libs, warnings = diff_core.read_excel("q2.xlsx")
print([lib.version for lib in libs], len(warnings))
模範解答
['1.2', '3'] 2
1.20 は float の 1.2、3.0 は int の 3 として保存・読み込みされ、read_excel() の str() で '1.2' と '3' になります。数値だった2行それぞれに警告が出るので、警告は2件です。
問3
難易度:⭐⭐⭐
ルート直下に <version>3.2.0</version> があり、依存 com.example:app-common の版が <version>${project.version}</version> と書かれた pom.xml を read_pom() で読むと、版が '${project.version}' のまま残ります。プロジェクト自身の版(3.2.0)に解決するには、どこをどう変えますか。
模範解答
read_pom() で props を作った直後に1行足します。
props.setdefault("project.version", (root.findtext("{*}version") or "").strip())
project.version は Maven が用意する組み込みのプロパティで <properties> には現れないので、ルート直下の <version> から補います。setdefault なので <properties> の同名定義が優先されます。変更後の結果です。
[Library(group_id='com.example', artifact_id='app-common', version='3.2.0')]
resolve_version() も main.py も変更不要で、ロジックを diff_core.py に集めた効果です。なお、版を親 pom から継承していてルート直下に <version> がない場合は解決できません。
次回予告
第4回:既存のPythonツールを読んで直す ― ライブラリの見分け方・EXEの正体・Windowsでの注意
参考
- xml.etree.ElementTree - Python ドキュメント
- openpyxl - Tutorial
- unicodedata - Python ドキュメント
- collections.Counter - Python ドキュメント
- tkinter.ttk - Python ドキュメント
- Introduction to the Dependency Mechanism - Apache Maven
@kotaro_ai_lab
AI活用や開発効率化について発信しています。フォローお気軽にどうぞ!