##// END OF EJS Templates
Improve typing and MIME hook API for inspector (#14342)...
Improve typing and MIME hook API for inspector (#14342) Fixes https://github.com/ipython/ipython/issues/14339 ### Additions Adds `InfoDict` type to improve the typing of `info()` result. Adds missing `"subclasses"` to `info_fields` list (these were added to the field list in https://github.com/ipython/ipython/pull/11486 but we forgot to update `info_fields` variable at the time) - the newly added `InfoDict` type will ensure that this won't happen again. Adds `InspectorHookData` dataclass which is passed to the MIME hooks which now should expect a single argument. Having a single dataclass argument enables us to deprecate individual fields, or add new fields without breaking the existing hooks. The old hooks will still work (if any are out there since this mechanism got just added in the previous point version). ### Deletions A comment over `info_fields` gets deleted: - Contrarily to the comment (which is getting deleted in this PR), `info_fields` were not defining the order of display since at least 2015 (https://github.com/ipython/ipython/pull/7903 - I did not feel the need to go further in the history to find when exactly it happened). - Also contrarily to this comment, current Jupyter messaging spec does not define the contents of `info_fields` (I guess this was lost during IPython/Jupyter split), but the newly added `InfoDict` at least properly annotates their type (if you know where I can find the old IPython messaging spec with the descriptions I can add these as doc comments). Unused `cast_unicode` import gets deleted. If someone imported it from here... well they really should not have. ### Deprecations - mime hooks taking two arguments (`obj, info`)

File last commit:

r28404:a6441287
r28661:2084e7f3 merge
Show More
display.py
44 lines | 1.5 KiB | text/x-python | PythonLexer
"""Public API for display tools in IPython.
"""
# -----------------------------------------------------------------------------
# Copyright (C) 2012 The IPython Development Team
#
# Distributed under the terms of the BSD License. The full license is in
# the file COPYING, distributed as part of this software.
# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------
# Imports
# -----------------------------------------------------------------------------
from IPython.core.display_functions import *
from IPython.core.display import (
display_pretty as display_pretty,
display_html as display_html,
display_markdown as display_markdown,
display_svg as display_svg,
display_png as display_png,
display_jpeg as display_jpeg,
display_latex as display_latex,
display_json as display_json,
display_javascript as display_javascript,
display_pdf as display_pdf,
DisplayObject as DisplayObject,
TextDisplayObject as TextDisplayObject,
Pretty as Pretty,
HTML as HTML,
Markdown as Markdown,
Math as Math,
Latex as Latex,
SVG as SVG,
ProgressBar as ProgressBar,
JSON as JSON,
GeoJSON as GeoJSON,
Javascript as Javascript,
Image as Image,
set_matplotlib_formats as set_matplotlib_formats,
set_matplotlib_close as set_matplotlib_close,
Video as Video,
)
from IPython.lib.display import *