philiprehberger-diff-strings 0.1.5

Show character-level differences between two strings with colored terminal output

philiprehberger-diff-strings

Show character-level differences between two strings with colored terminal output.

Install

pip install philiprehberger-diff-strings

Usage

from philiprehberger_diff_strings import diff

print(diff("hello world", "hello there"))

Character-level diff

from philiprehberger_diff_strings import diff

# Colored output (default)
print(diff("the cat sat", "the bat sat"))

# Plain text output
print(diff("the cat sat", "the bat sat", color=False))

Programmatic diff

from philiprehberger_diff_strings import char_diff

changes = char_diff("abc", "adc")
# [Match(text='a'), Replace(old='b', new='d'), Match(text='c')]

Word-level diff

from philiprehberger_diff_strings import word_diff

print(word_diff("the quick brown fox", "the slow brown dog", color=False))

Similarity ratio

from philiprehberger_diff_strings import similarity

score = similarity("hello", "hallo")  # 0.8

Test assertions

from philiprehberger_diff_strings import assert_strings_equal

assert_strings_equal("expected output", "expected output")  # passes
assert_strings_equal("expected", "actual")  # raises AssertionError with diff

API

Function	Description
diff(a, b, *, color=True)	Character-level diff as a string
char_diff(a, b)	Programmatic diff returning a list of Change objects
word_diff(a, b, *, color=True)	Word-level diff as a string
similarity(a, b)	Similarity ratio between 0.0 and 1.0
assert_strings_equal(expected, actual, *, msg="")	Assert equal or raise with diff

Change types

Type	Fields	Description
Match(text)	text: str	Unchanged text
Insert(text)	text: str	Text added in the second string
Delete(text)	text: str	Text removed from the first string
Replace(old, new)	old: str, new: str	Text that changed between strings

Development

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

License

MIT