テキスト差分ハイライト

1. アプリ概要

2つのテキストを比較して追加・削除・変更箇所を色付きでハイライト表示するdiffツール。difflib活用。

このアプリはtoolsカテゴリの実践的なPythonアプリです。使用ライブラリは tkinter（標準ライブラリ）、難易度は ★★☆ です。

このアプリは「ツール」カテゴリです。日々の作業を自動化する実用ツールは Python が最も得意とする領域です。短いコードで実用性のある成果物が作れる点が魅力です。tkinter（標準ライブラリ） を活かして実装するこの構造は、他のアプリにも応用が効きます。

コードを読む前に実行することをおすすめします。動いている挙動を先に把握しておくと、解説で出てくる関数や処理がどこに対応するかが頭に入りやすくなります。

応用のヒントは、機能を 1 つ増やす・見た目を整える・例外を一つでも丁寧に扱う、のいずれかから始めるのがおすすめです。

2. 機能一覧

• 「差分を比較」ボタン（compare()）・「クリア」ボタン（clear()）・「サンプル投入」ボタン（load_sample()）で操作
• messagebox.showwarning() によるダイアログ通知
• ウィンドウはタイトル「テキスト差分ハイライト」・サイズ 900x600 で起動

3. 事前準備・環境

Windows 11（実機）で起動と基本操作を確認しています（全機能の網羅テストではありません）。Linux Mint 22.3（仮想マシン）では起動と画面表示を確認しました。macOS は標準ライブラリの範囲で動作する想定ですが、未検証です。

• Python 3.10 以上
• OS: Windows 11（実機で起動・基本操作を確認）・Linux Mint 22.3（仮想マシンで起動・画面表示を確認）

4. 完全なソースコード

import tkinter as tk
from tkinter import ttk, messagebox
import difflib


class App097:
    """テキスト差分ハイライト: 2つのテキストを比較して色付き表示"""

    def __init__(self, root):
        self.root = root
        self.root.title("テキスト差分ハイライト")
        self.root.geometry("900x600")
        self.root.minsize(900, 600)
        self.root.configure(bg="#f8f9fc")
        self._build_ui()

    def _build_ui(self):
        """UI を構築する"""
        # タイトル
        title_frame = tk.Frame(self.root, bg="#3776ab", pady=12)
        title_frame.pack(fill=tk.X)
        tk.Label(
            title_frame, text="テキスト差分ハイライト",
            font=("Noto Sans JP", 16, "bold"),
            bg="#3776ab", fg="white"
        ).pack()

        main = tk.Frame(self.root, bg="#f8f9fc", padx=15, pady=15)
        main.pack(fill=tk.BOTH, expand=True)

        # 入力エリア(左右)
        input_frame = tk.Frame(main, bg="#f8f9fc")
        input_frame.pack(fill=tk.BOTH, expand=True)

        left = ttk.LabelFrame(input_frame, text="テキスト A (変更前)", padding=6)
        left.grid(row=0, column=0, sticky="nsew", padx=(0, 6))
        self.text_a = tk.Text(left, height=10, font=("Consolas", 10), wrap=tk.NONE)
        self.text_a.pack(fill=tk.BOTH, expand=True)

        right = ttk.LabelFrame(input_frame, text="テキスト B (変更後)", padding=6)
        right.grid(row=0, column=1, sticky="nsew", padx=(6, 0))
        self.text_b = tk.Text(right, height=10, font=("Consolas", 10), wrap=tk.NONE)
        self.text_b.pack(fill=tk.BOTH, expand=True)

        input_frame.columnconfigure(0, weight=1)
        input_frame.columnconfigure(1, weight=1)
        input_frame.rowconfigure(0, weight=1)

        # 操作ボタン
        btn = tk.Frame(main, bg="#f8f9fc")
        btn.pack(pady=8)
        ttk.Button(btn, text="差分を比較", command=self.compare).pack(side=tk.LEFT, padx=4)
        ttk.Button(btn, text="クリア", command=self.clear).pack(side=tk.LEFT, padx=4)
        ttk.Button(btn, text="サンプル投入", command=self.load_sample).pack(side=tk.LEFT, padx=4)

        # 結果(色付き diff)
        result_frame = ttk.LabelFrame(main, text="差分結果 (緑=追加 / 赤=削除 / 黄=変更)", padding=6)
        result_frame.pack(fill=tk.BOTH, expand=True)
        self.result_text = tk.Text(result_frame, font=("Consolas", 10), wrap=tk.NONE)
        self.result_text.pack(fill=tk.BOTH, expand=True, side=tk.LEFT)
        scrollbar = ttk.Scrollbar(result_frame, command=self.result_text.yview)
        self.result_text.configure(yscrollcommand=scrollbar.set)
        scrollbar.pack(side=tk.RIGHT, fill=tk.Y)

        # ハイライト用のタグ定義
        self.result_text.tag_configure("add", background="#d4edda", foreground="#155724")
        self.result_text.tag_configure("del", background="#f8d7da", foreground="#721c24")
        self.result_text.tag_configure("chg", background="#fff3cd", foreground="#856404")
        self.result_text.tag_configure("info", foreground="#666")

    def compare(self):
        """差分を計算して色付き表示する"""
        a = self.text_a.get("1.0", tk.END).splitlines()
        b = self.text_b.get("1.0", tk.END).splitlines()
        if not any(a) and not any(b):
            messagebox.showwarning("警告", "比較するテキストを入力してください")
            return
        self.result_text.delete("1.0", tk.END)
        diff = list(difflib.ndiff(a, b))
        added = removed = changed = 0
        for line in diff:
            if not line:
                continue
            tag = None
            prefix = line[:2]
            if prefix == "+ ":
                tag = "add"
                added += 1
            elif prefix == "- ":
                tag = "del"
                removed += 1
            elif prefix == "? ":
                tag = "chg"
                changed += 1
            elif prefix == "  ":
                tag = None  # 変化なし
            self.result_text.insert(tk.END, line + "\n", tag)
        # サマリ
        summary = f"\n--- サマリ: 追加 {added} / 削除 {removed} / 変更ヒント {changed} ---\n"
        self.result_text.insert(tk.END, summary, "info")

    def clear(self):
        """全テキストをクリアする"""
        self.text_a.delete("1.0", tk.END)
        self.text_b.delete("1.0", tk.END)
        self.result_text.delete("1.0", tk.END)

    def load_sample(self):
        """動作確認用サンプルを投入する"""
        sample_a = "りんご\nバナナ\nぶどう\nみかん"
        sample_b = "りんご\nオレンジ\nぶどう\nみかん\nメロン"
        self.text_a.delete("1.0", tk.END)
        self.text_a.insert("1.0", sample_a)
        self.text_b.delete("1.0", tk.END)
        self.text_b.insert("1.0", sample_b)


if __name__ == "__main__":
    root = tk.Tk()
    app = App097(root)
    root.mainloop()

5. コード解説

テキスト差分ハイライト: 2つのテキストを比較して色付き表示のコードを、実際に書かれている実装に沿って解説します。

6. ステップバイステップガイド

このアプリをゼロから自分で作る手順を解説します。コードをコピーするだけでなく、実際に手順を追って自分で書いてみましょう。

1. 1
   ファイルを作成する

   新しいファイルを作成して app097.py と保存します。使うのは difflib・tkinter だけなので、追加インストールは不要です。

2. 2
   クラスの骨格を作る

   App097 クラスを定義し、__init__ と、末尾の root = tk.Tk() ～ mainloop() の最小構成を書いて、まず空のウィンドウが出ることを確認します。

3. 3
   ウィンドウを設定する

   title("テキスト差分ハイライト")・geometry("900x600")・configure(bg="#f8f9fc")・minsize(900, 600) をコンストラクタで設定します。

4. 4
   画面部品を並べる

   _build_ui() の中で、tk.Frame×4・tk.Label・ttk.LabelFrame×3・tk.Text×3・ttk.Button×3・ttk.Scrollbar を作って配置します（掲載コードと同じ並び順で書くとレイアウトが一致します）。まず表示だけ確認しましょう。

5. 5
   イベントを接続する

   「2. 機能一覧」で挙げた各ボタンを command= で対応するメソッド（compare()・clear()・load_sample()）につなぎます。

6. 6
   中心になるメソッドを実装する

   アプリの本体である compare()（30行）・load_sample()（8行）・clear()（5行） を実装します。

7. 7
   動作確認する

   python app097.py で起動し、各ボタンが反応することを確認します。

7. カスタマイズアイデア

基本機能を習得したら、以下のカスタマイズに挑戦してみましょう。

8. よくある問題と解決法

9. 練習問題

アプリの理解を深めるための練習問題です。気になるものから挑戦してみてください（課題3は定型の発展課題です）。どちらの課題も新しいライブラリは要りません（「サンプル投入」→「差分を比較」の順に押すだけで確かめられます）。

1. 課題1：違いが無いときに「差分はありません」と出す

   いまは2つのテキストが同じでも、サマリの数字を読むまで違いが無いことに気づけません。ひと目で分かる知らせを足しましょう。

   期待結果：テキスト A と B の両方に「りんご」とだけ入れて「差分を比較」を押すと、結果欄に「✅ 差分はありません」が出る。その下にはいままでどおり「--- サマリ: 追加 0 / 削除 0 / 変更ヒント 0 ---」が続く

   合格条件

   • 「サンプル投入」→「差分を比較」のときは出ない（追加 2・削除 1 があるため）
   • サマリの行はこれまでどおり最後に出る
   • A と B の両方が空のときは、これまでどおり「比較するテキストを入力してください」の警告だけが出る

   ヒント①（どこを触るか）: 触るのは1か所です。compare() の末尾、サマリの文字列を作っている summary = の行の手前です。
   ヒント②（使うもの）: added と removed はループの中で数え終わっています。if added == 0 and removed == 0: のときに self.result_text.insert(tk.END, "✅ 差分はありません\n", "info") を入れます。タグの "info" は _build_ui() の tag_configure("info", foreground="#666") で用意済みです。
   つまずきやすい点: 判定を if not diff: と書くと、diff には違いの無い行も りんご の形で入っているため条件が成立しません。difflib.ndiff(a, b) が空のリストを返すのは A も B も空のときだけで、その場合は手前の messagebox.showwarning("警告", "比較するテキストを入力してください") で戻っています。行末の空白が違うだけでも追加・削除に数えられる点にも注意してください。

2. 課題2：違いのある行だけを結果に残す

   いまは同じ行も結果欄に並ぶので、長い文章ほど違いを探すのが大変になります。違いのある行だけを残しましょう。

   期待結果：「サンプル投入」→「差分を比較」を押すと、結果欄が - バナナ・+ オレンジ・+ メロン の3行とサマリだけになる。いまは共通の りんご・ ぶどう・ みかん を含めて6行が並ぶ

   合格条件

   • サマリの数字は「追加 2 / 削除 1 / 変更ヒント 0」のまま変わらない
   • 共通の行は1行も出ない
   • 「クリア」を押したときの動きは今までどおり

   ヒント①（どこを触るか）: 触るのは1か所です。compare() の elif prefix == " ": の分岐（tag = None # 変化なし の行）です。
   ヒント②（使うもの）: この分岐の中を continue にすると、その行は結果欄への追加へ進まずに次の行の処理へ飛びます。数え上げの added += 1 などは別の分岐にあるので、サマリの数字はそのままです。
   つまずきやすい点: continue を break と書くと、最初の共通行（サンプルでは りんご）でループが終わり、そのあとの - バナナ などが1行も出ません。エラーは出ず、サマリまで「追加 0 / 削除 0」になるので、比較そのものが失敗したように見えます。

3. 課題3：保存機能の追加

   処理結果をファイルに保存する機能を追加しましょう。