初心者向け No.097

テキスト差分ハイライト

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

🎯 難易度: ★★☆ 📦 ライブラリ: tkinter(標準ライブラリ) ⏱️ 制作時間: 30〜90分

1. アプリ概要

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

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

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

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

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

2. 機能一覧

  • テキスト差分ハイライトのメイン機能
  • 直感的なGUIインターフェース
  • 入力値のバリデーション
  • エラーハンドリング
  • 結果の見やすい表示
  • クリア機能付き

3. 事前準備・環境

ℹ️
動作確認環境

Python 3.10 以上 / Windows・Mac・Linux すべて対応

以下の環境で動作確認しています。

  • Python 3.10 以上
  • OS: Windows 10/11・macOS 12+・Ubuntu 20.04+

4. 完全なソースコード

💡
コードのコピー方法

右上の「コピー」ボタンをクリックするとコードをクリップボードにコピーできます。

追加インストール不要(標準ライブラリのみ使用)
app097.py
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.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. コード解説

テキスト差分ハイライトのコードを詳しく解説します。クラスベースの設計で各機能を整理して実装しています。

クラス設計とコンストラクタ

App097クラスにアプリの全機能をまとめています。__init__でウィンドウ設定、_build_ui()でUI構築、process()でメイン処理を担当します。責任の分離により、コードが読みやすくなります。

※ 該当部分のコード本体は 「4. 完全なソースコード」 をご参照ください(重複表示を避けるため再掲を省略しています)。

UIレイアウトの構築

LabelFrameで入力エリアと結果エリアを視覚的に分けています。pack()で縦に並べ、expand=Trueで結果エリアが画面いっぱいに広がるよう設定しています。

※ 該当部分のコード本体は 「4. 完全なソースコード」 をご参照ください(重複表示を避けるため再掲を省略しています)。

イベント処理

ボタンのcommand引数でクリックイベントを、bind('')でEnterキーイベントを処理します。どちらの操作でも同じprocess()が呼ばれ、コードの重複を避けられます。

※ 該当部分のコード本体は 「4. 完全なソースコード」 をご参照ください(重複表示を避けるため再掲を省略しています)。

Textウィジェットでの結果表示

tk.Textウィジェットをstate=DISABLED(読み取り専用)で作成し、更新時はNORMALに変更してinsert()で内容を書き込み、再びDISABLEDに戻します。

※ 該当部分のコード本体は 「4. 完全なソースコード」 をご参照ください(重複表示を避けるため再掲を省略しています)。

例外処理とエラーハンドリング

try-exceptでValueErrorとExceptionを捕捉し、messagebox.showerror()でエラーメッセージを表示します。予期しないエラーも処理することで、アプリの堅牢性が向上します。

※ 該当部分のコード本体は 「4. 完全なソースコード」 をご参照ください(重複表示を避けるため再掲を省略しています)。

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

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

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

    新しいファイルを作成して app097.py と保存します。

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

    App097クラスを定義し、__init__とmainloop()の最小構成を作ります。

  3. 3
    タイトルバーを作る

    Frameを使ってカラーバー付きのタイトルエリアを作ります。

  4. 4
    入力フォームを実装する

    LabelFrameとEntryウィジェットで入力エリアを作ります。

  5. 5
    処理ロジックを実装する

    _execute()メソッドにメインロジックを実装します。

  6. 6
    結果表示を実装する

    TextウィジェットかLabelに結果を表示する_show_result()を実装します。

  7. 7
    エラー処理を追加する

    try-exceptとmessageboxでエラーハンドリングを追加します。

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

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

💡 ダークモードを追加する

bg色・fg色を辞書で管理し、ボタン1つでダークモード・ライトモードを切り替えられるようにしましょう。

💡 データの保存機能

処理結果をCSV・TXTファイルに保存する機能を追加しましょう。filedialog.asksaveasfilename()でファイル保存ダイアログが使えます。

💡 設定ダイアログ

フォントサイズや色などの設定をユーザーが変更できるオプションダイアログを追加しましょう。

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

❌ 日本語フォントが表示されない

原因:システムに日本語フォントが見つからない場合があります。

解決法:font引数を省略するかシステムに合ったフォントを指定してください。

❌ ライブラリのインポートエラー

原因:必要なライブラリがインストールされていません。

解決法:pip install コマンドで必要なライブラリをインストールしてください。

❌ ウィンドウサイズが合わない

原因:画面解像度や表示スケールによって異なる場合があります。

解決法:root.geometry()で適切なサイズに調整してください。

9. 練習問題

アプリの理解を深めるための練習問題です。

  1. 課題1:機能拡張

    テキスト差分ハイライトに新しい機能を1つ追加してみましょう。

  2. 課題2:UIの改善

    色・フォント・レイアウトを変更して、より使いやすいUIにカスタマイズしましょう。

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

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

🚀
次に挑戦するアプリ

このアプリをマスターしたら、次のアプリに挑戦しましょう。