##// END OF EJS Templates
upstream » ipython
RSS

Clone from https://github.com/ipython/ipython.git

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`)
Matthias Bussonnier - - Load All Authors

File last commit:

r27411:5b8c2f31
r28661:2084e7f3 merge
Show More
index.rst
73 lines | 1.8 KiB | text/x-rst | RstLexer
/ docs / source / whatsnew / index.rst
History | Source | Raw |Copy content |Copy permalink
Brian Granger
Cleanup of docs....
 r2275 .. Developers should add in this file, during each release cycle, information
.. about important changes they've made, in a summary format that's meant for
.. end users. For each release we normally have three sections: features, bug
.. fixes and api breakage.
.. Please remember to credit the authors of the contributions by name,
.. especially when they are new users or developers who do not regularly
.. participate in IPython's development.
.. _whatsnew_index:
=====================
What's new in IPython
=====================
Matthias Bussonnier
fix comments
 r24539 ..
Paul Ivanov
release 7.0.0b1
 r24556 this will appear in the docs if we are not releasing a version (ie if
`_version_extra` in release.py is an empty string)
Matthias Bussonnier
update release process
 r24536
.. only:: ipydev
Matthias Bussonnier
typos
 r24546 Development version in-progress features:
Matthias Bussonnier
update release process
 r24536
.. toctree::
Matthias Bussonnier
Add debug and fix build hopefully
 r24542
Matthias Bussonnier
update release process
 r24536 development
Brian Granger
Work on documentation....
 r2276 This section documents the changes that have been made in various versions of
IPython. Users should consult these pages to learn about new features, bug
fixes and backwards incompatibilities. Developers should summarize the
development work they do here in a user friendly format.
Brian Granger
Cleanup of docs....
 r2275 .. toctree::
:maxdepth: 1
Matthias Bussonnier
vmove to version8.rst
 r27307 version8
Matthias Bussonnier
gen stats
 r27411 github-stats-8
Matthias Bussonnier
Start to updates the what's new / changelog....
 r24535 version7
Paul Ivanov
add preliminary 7.0 release stats
 r24555 github-stats-7
Matthias Bussonnier
relist version 6 in docs
 r23532 version6
Matthias Bussonnier
Update stats and docs for 6.0 release.
 r23559 github-stats-6
Matthias Bussonnier
Documentation overhaul....
 r22588 version5
Fernando Perez
Update release instructions for stats inclusion in whatsnew section.
 r22674 github-stats-5
Min RK
prepare what's new for 4.0
 r21595 version4
github-stats-4
Min RK
init what's new for 3.0...
 r20271 version3
github-stats-3
Jonathan Frederic
A couple more @takluyver suggested changes.
 r20514 version3_widget_migration
MinRK
add what's new for 2.0
 r16144 version2.0
github-stats-2.0
MinRK
start 1.0 whatsnew
 r11587 version1.0
github-stats-1.0
Fernando Perez
Add new screenshots for release notes.x
 r7765 version0.13
MinRK
add GitHub stats for 0.13
 r7759 github-stats-0.13
Fernando Perez
Complete what's new for 0.12.
 r5790 version0.12
github-stats-0.12
MinRK
move 0.11 whatsnew into version0.11
 r4166 version0.11
Fernando Perez
Split closed issues list into standalone file, minor doc updates.
 r4449 github-stats-0.11
Brian Granger
Cleanup of docs....
 r2275 version0.10
version0.9
version0.8
Matthias Bussonnier
prepare whats new in 7.6
 r25060
..
this makes a hidden toctree that keeps sphinx from complaining about
documents included nowhere when building docs for stable
We place it at the end as it will still be reachable via prev/next links.
.. only:: ipystable
.. toctree::
:hidden:
development