Creates diffs of XML files
Project description
xmldiff
xmldiff is a library and a command-line utility for making diffs out of XML. This may seem like something that doesn’t need a dedicated utility, but change detection in hierarchical data is very different from change detection in flat data. XML type formats are also not only used for computer readable data, it is also often used as a format for hierarchical data that can be rendered into human readable formats. A traditional diff on such a format would tell you line by line the differences, but this would not be be readable by a human. This library provides tools to make human readable diffs in those situations.
Quick usage
xmldiff is both a command-line tool and a Python library. To use it from the command-line, just run xmldiff with two input files:
$ xmldiff file1.xml file2.xml
As a library:
from lxml import etree
from xmldiff import main, formatting
differ = diff.Differ()
diff = main.diff_files('file1.xml', 'file2.xml',
formatter=formatting.XMLFormatter())
print(diff)
There is also a method diff_trees() that take two lxml trees, and a method diff_texts() that will take strings containing XML.
Changes from xmldiff 1.x
A complete, ground up, pure-Python rewrite
Easier to maintain, the code is less complex and more Pythonic, and uses more custom classes instead of just nesting lists and dicts.
Fixes the problems with certain large files and solves the memory leaks.
A nice, easy to use Python API for using it as a library.
Adds support for showing the diffs in different formats, mainly one where differences are marked up in the XML, useful for making human readable diffs.
These formats can show text differences in a semantically meaningful way.
2.0 is urrently significantly slower than xmldiff 1.x, but this may change in the future. Currently we make no effort to make xmldiff 2.0 fast, we concentrate on making it correct and usable.
Contributors
Lennart Regebro, lregebro@shoobx.com (main author)
Stephan Richter, srichter@shoobx.com
The diff algorithm is based on “Change Detection in Hierarchically Structured Information”, and the text diff is using Google’s diff_match_patch algorithm.
Changes
2.0b3 (2018-09-11)
Replaced the example RMLFormatter with a more generic HTML formatter, although it only handles HTML snippets at the moment.
Added a RenameNodeAction, to get rid of an edge case of a node tail appearing twice.
2.0b2 (2018-09-06)
Documentation
The diff formatter now handles the –keep-whitespace argument
Added a --version argument
2.0b1 (2018-09-03)
A complete, bottom-up, pure-python rewrite
New easy API
New output formats:
A list of actions (similar but not compatible with the old format)
XML with changes marked though tags and attributes
RML aware XML where tags containing text are semantically diffed, useful for human output such as converting to HTML or PDF
100% test coverage
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for xmldiff-2.0b3-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a7c2efc42f6b2e47af36d905521a0e97c5f469d3d8c4243b87db9281c056c5de |
|
| MD5 | 810ffd544e5de013bbc0ad49258d017c |
|
| BLAKE2b-256 | 0a0cfa7d475d3be9c376bb46fa7d0db1f70ee7cbce8d7328de750d06c72c1f8a |
