Repository navigation
Preserve whitespace when serializing without indentation, and do so by default - #26
Merged
Merged
Conversation
The serializer dropped whitespace-only text nodes and trimmed trailing whitespace from all other text nodes, regardless of the indent setting. Even with indent=0, this changed the meaning of the document: "<b>a</b> <i>b</i>" serialized as "<b>a</b><i>b</i>", and <pre>, <textarea>, <script>, and <style> contents lost their trailing whitespace. With indent=0, write text nodes unchanged. Pretty-printing with a nonzero indent still discards and trims whitespace as before. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Anders Kaseorg <andersk@mit.edu>
serialize() and serialize_bytes() pretty-printed with indent=4 by default, which adds and removes whitespace and so can change the meaning of the document: it changes the rendering of whitespace between inline elements, and the contents of <pre>, <textarea>, and <script> elements. Like other HTML and XML libraries, serialize the document exactly by default, with indent=0, and document that a nonzero indent doesn't preserve the document's meaning. Update the examples in the documentation and README, several of which showed pretty-printed output, and add a warning about pretty-printing. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Anders Kaseorg <andersk@mit.edu>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The serializer dropped whitespace-only text nodes and trimmed trailing whitespace from all other text nodes, regardless of the
indentsetting. Even withindent=0, this changed the meaning of the document:"<b>a</b> <i>b</i>"serialized as"<b>a</b><i>b</i>", and<pre>,<textarea>,<script>, and<style>contents lost their trailing whitespace.With
indent=0, write text nodes unchanged. Pretty-printing with a nonzero indent still discards and trims whitespace as before.Like other HTML and XML libraries, serialize the document exactly by default, with
indent=0, and document that a nonzero indent doesn't preserve the document's meaning.