Conversation
…oks#1203) json.dumps of front-matter mappings/lists raised TypeError for nested date/datetime values. Stringify those with default=str, and catch TypeError so a YAML date used as a mapping key warns instead of aborting the build.
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
1 participant
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.
Fixes #1203.
dict_to_fm_field_listalready treats top-level YAMLdate/datetimescalars as displayable values, but a date one level down in a mapping or sequence reachedjson.dumpswith nodefault=handler. That raisesTypeError(Object of type date is not JSON serializable), which was not in the existingexcept (ValueError, RecursionError), so the Sphinx/docutils build aborted even with--keep-going.This serializes nested values with
default=str(same string form as a top-level date afterstr(value)), and treats remainingTypeErrors — e.g. a YAML date used as a mapping key — as the existing “could not be serialized” warning.Tests
tests/test_docutils.py::test_topmatter_nested_dates_do_not_crash— nested date in a mapping, nested date in a sequence, nested datetimetests/test_docutils.py::test_topmatter_date_mapping_key_warns— date-as-key warns instead of crashingpytest tests/test_docutils.py— 39 passed.