Fix Markdown and JSON __repr__ to return actual data#15230
Open
asgharale wants to merge 2 commits into
Open
Conversation
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.
Problem
MarkdownandJSONdisplay objects had no__repr__, so they fellback to
DisplayObject.__repr__which returns the unhelpful<IPython.core.display.Markdown object>string. This caused nbconvertoutput and terminal reprs to show garbage instead of actual content.
Changes
Markdown.__repr__returningself.dataJSON.__repr__returningjson.dumps(self.data, indent=2)(as requested by @Carreau in Add a 'text/plain' repr to Markdown and JSON #14150)
test_geojsonto assert the correct repr outputNotes
maintainer feedback requesting
json.dumpswith indentationtest_display_formatter_active_types_configfailure is apre-existing Windows environment issue unrelated to this PR
Closes #12895