Modernizing difflib.HtmlDiff for HTML Output
#134580
Labels
Comments
hugovk
added a commit
that referenced
this issue
May 28, 2025
Co-authored-by: Hugo van Kemenade <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Feature or enhancement
Proposal:
Previously, I added dark mode support to the HTML export feature of
difflib, and during that process, I uncovered several issues.By opening the browser's developer tools (F12) and inspecting the generated HTML, you can observe a number of warnings, such as:
I initially addressed these warnings in the same pull request that added dark mode support. However, we later decided it would be better to split these changes into a separate PR—each PR should serve a single purpose. As a result, the warning fixes were rolled back from that submission. (see #129940 (comment))
Recently, I resumed working on this issue. I discovered that a large portion of these browser warnings stem from the legacy nature of the generated HTML. For example, the first line of the html still uses:
And elements like:
These are artifacts from the HTML4 era—a specification that was finalized more than two decades ago. While HTML5 remains backward-compatible with this syntax, I believe updating to modern HTML5 conventions is the right move. In 2025, there's no need to worry about browsers lacking HTML5 support.
For instance, HTML5 removes the need for lengthy DTD declarations (see here), simplifying the doctype to just
<!DOCTYPE html>. This also makes the resulting HTML cleaner and easier to maintain.With that in mind, I’m proposing to modernize
difflib.HtmlDiff, not just updating the HTML structure to HTML5, but also refining the CSS for improved styling.Take the current layout, for example: it’s not easy to distinguish line numbers from content maybe it's not very user-friendly.
In the revised version, the diff content has been slightly enlarged for better readability. Line numbers are bolded and given more horizontal space, preventing them from blending into the content and causing visual confusion.
Additionally, the legend section has been visually enhanced—now more intuitive and aesthetically pleasing. And, of course, all browser warnings have been eliminated!
Before:
After:
Has this already been discussed elsewhere?
This is a minor feature, which does not need previous discussion elsewhere
Links to previous discussion of this feature:
No response
Linked PRs
difflib.HtmlDifffor HTML Output #134581The text was updated successfully, but these errors were encountered: