Skip to main content

htmlcompare

A Python library to ensure two HTML documents are "equal". Currently the functionality is very limited but the idea is that the library should ignore differences automatically when these are not relevant for HTML semantics (e.g. <img style=""> is the same as <img>, style="color: black; font-weight: bold" is equal to style="font-weight:bold;color:black;").

Usage

import htmlcompare

diff = htmlcompare.compare_html('<div>', '<p>')
is_same = bool(diff)

To ease testing the library provides some helpers

from htmlcompare import assert_different_html, assert_same_html

assert_different_html('<br>', '<p>')
assert_same_html('<div />', '<div></div>')

Implemented Features

  • ignores whitespace between HTML tags
  • <div /> is treated like <div></div>
  • ordering of HTML attributes does not matter: <div class="…" style="…" /> is treated equal to <div style="…" class="…" />
  • HTML comments are ignored (yes, also conditional comments unfortunately)
  • ordering of CSS classes inside class attribute does not matter: <div class="foo bar" /> is the same as <div class="bar foo" />.
  • a style or class attribute with empty content (e.g. style="") is considered the same as an absent style/class attribute.
  • inline style declarations and <style> tags are parsed with an actual CSS parser: ordering, whitespace and trailing semicolons do not matter
  • 0px is considered equal to 0 in inline CSS.
  • conditional comments (<!--[if !mso]>...) are considered when checking for equality. Regular comments will be ignored by default.

Limitations / Plans

No validation of conditional comments. Not sure which library I can use here but at some point I'll likely need this as well.

JavaScript - for obvious reasons it will be impossible to implement perfect JS comparison but it might be possible to run some kind of "beautifier" to take care of insignificant stylistic changes. However I don't need this feature so this is unlikely to get implemented (unless contributed by someone else).

Custom hooks could help adapting the comparison to your specific needs. However I don't know which API would be best so this will wait until there are real-world use cases.

Better API: The current API is very minimal and implements just what I needed right now. I hope to improve the API once I use this project in more complex scenarios.

Other projects

xmldiff is a well established project to compare two XML documents. However it seems as if the code does not contain knowledge about specific HTML semantics (e.g. CSS, empty attributes, insignificant attribute order).

Misc

The code is licensed under the MIT license. It requires Python 3.9+.

Metadata

Release files for HTMLCompare 0.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for HTMLCompare 0.4.1
File Size Uploaded Provenance Actions
htmlcompare-0.4.1.tar.gz 21.4 kB Without provenance Details for htmlcompare-0.4.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for HTMLCompare 0.4.1
File Interpreter ABI Platform Actions
htmlcompare-0.4.1-py3-none-any.whl Python 3 none any Details for htmlcompare-0.4.1-py3-none-any.whl

Total release size: 46.9 kB

Release files / htmlcompare-0.4.1.tar.gz

Download URL htmlcompare-0.4.1.tar.gz
Size 21.4 kB
Tags Source
SHA-256 checksum
How to use checksums
faa78519919e2b9036ae4574b401cc59667278c671827e1e2adb1d40d1a5d79a
BLAKE2b-256 checksum
How to use checksums
2f5a3746bbd342203df46c96f7409261acc97007cd80ec9e4c53ea120d925c05
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.2

Release files / htmlcompare-0.4.1-py3-none-any.whl

Download URL htmlcompare-0.4.1-py3-none-any.whl
Size 25.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
50e0d0f44a5f037145792cfb184c10cae7172e68ba9fcf5c76b0324ec5c1c634
BLAKE2b-256 checksum
How to use checksums
536e8e6247c25df493a5708e00ad795b807ac68fe577e7d11baadfd30420b79a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.2

Security for HTMLCompare 0.4.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page