philiprehberger-json-diff 0.5.0

Readable JSON comparison with colorized terminal output.

philiprehberger-json-diff

Readable JSON comparison with colorized terminal output.

Installation

pip install philiprehberger-json-diff

Usage

from philiprehberger_json_diff import diff, format_diff, diff_summary

old = {"name": "Alice", "age": 30, "city": "NYC"}
new = {"name": "Alice", "age": 31, "country": "US"}

changes = diff(old, new)

# Pretty-print with colors
print(format_diff(changes))

# Get a summary
summary = diff_summary(changes)
# {"added": 1, "removed": 1, "modified": 1, "unchanged": 0}

Nested Comparison

from philiprehberger_json_diff import diff

old = {"user": {"name": "Alice", "settings": {"theme": "dark"}}}
new = {"user": {"name": "Alice", "settings": {"theme": "light"}}}

changes = diff(old, new)
# Reports: modified user.settings.theme: "dark" -> "light"

Ignore Paths

from philiprehberger_json_diff import diff

changes = diff(old, new, ignore={"user.settings.theme"})

Wildcard Ignore Patterns

from philiprehberger_json_diff import diff

old = {"a": {"metadata": {"ts": 1}}, "b": {"metadata": {"ts": 2}}}
new = {"a": {"metadata": {"ts": 99}}, "b": {"metadata": {"ts": 99}}}

# Ignore metadata fields at any depth
changes = diff(old, new, ignore={"*.metadata.*"})

Filter by paths

from philiprehberger_json_diff import diff_paths

old = {
    "users": {"alice": {"email": "[e-mail]"}, "bob": {"email": "[e-mail]"}},
    "config": {"timeout": 30, "retries": 3},
}
new = {
    "users": {"alice": {"email": "[e-mail]"}, "bob": {"email": "[e-mail]"}},
    "config": {"timeout": 60, "retries": 3},
}

# Watch only specific subtrees — wildcards work just like ignore patterns
changes = diff_paths(old, new, ["users.*.email", "config.timeout"])
# Reports: users.alice.email, users.bob.email, config.timeout

Structural Diff Mode

from philiprehberger_json_diff import diff

old = {"a": 1, "b": "hello", "c": 3}
new = {"a": "one", "b": "world", "d": 4}

result = diff(old, new, mode="structural")
result.key_additions   # [Change(path='d', ...)]
result.key_removals    # [Change(path='c', ...)]
result.value_changes   # [Change(path='b', ...)]
result.type_changes    # [Change(path='a', ...)]

Apply Patch

from philiprehberger_json_diff import diff, apply_patch

old = {"name": "Alice", "age": 30}
new = {"name": "Bob", "age": 31}

changes = diff(old, new)
result = apply_patch(old, changes)
# result == {"name": "Bob", "age": 31}

JSON Patch (RFC 6902)

from philiprehberger_json_diff import diff, to_json_patch

old = {"name": "Alice", "age": 30}
new = {"name": "Bob", "age": 31, "active": True}

patch = to_json_patch(diff(old, new))
# [
#   {"op": "replace", "path": "/age", "value": 31},
#   {"op": "replace", "path": "/name", "value": "Bob"},
#   {"op": "add", "path": "/active", "value": True},
# ]

# Round-trip: apply the patch to reconstruct `new` from `old`
from philiprehberger_json_diff import apply_json_patch

apply_json_patch(old, patch) == new  # True

Array Diff Strategies

from philiprehberger_json_diff import diff, ArrayStrategy

old = {"tags": ["python", "json", "diff"]}
new = {"tags": ["diff", "json", "python"]}

# Default: order-sensitive (reports changes at each index)
changes = diff(old, new)

# Order-insensitive: treats arrays as unordered collections
changes = diff(old, new, array_strategy=ArrayStrategy.ORDER_INSENSITIVE)
# No changes reported — same elements, different order

HTML Output

from philiprehberger_json_diff import diff, format_html

changes = diff(old, new)
html = format_html(changes)
# Returns an HTML <table> with rows classed "added", "removed", or "modified"

API

Function / Class	Description
diff(a, b, ignore, mode, array_strategy)	Compare two dicts/lists, returns list of Change objects or StructuralDiff
diff_paths(a, b, paths, *, array_strategy)	Compare two dicts/lists and return only changes matching the supplied glob-style path patterns
format_diff(changes, color)	Format changes as readable string with optional ANSI colors
format_html(changes)	Format changes as an HTML table for web UIs
diff_summary(changes)	Return dict with counts by change type
to_json_patch(changes)	Convert changes to RFC 6902 JSON Patch format
apply_json_patch(target, ops)	Apply RFC 6902 ops (add/remove/replace) to a target — inverse of to_json_patch
apply_patch(target, changes)	Apply a diff result as a patch to reconstruct the modified object
Change	Dataclass with path, change_type, old_value, new_value
ChangeType	Enum: ADDED, REMOVED, MODIFIED, UNCHANGED
StructuralDiff	Dataclass with key_additions, key_removals, value_changes, type_changes
ArrayStrategy	Enum: ORDER_SENSITIVE, ORDER_INSENSITIVE

Development

pip install -e .
python -m pytest tests/ -v

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT