- Set
debugOptionsfor breakpoints in python standard library source #812 (@echarles) - Send
omit_sectionsto IPython to choose which sections of documentation you do not want #809 (@fasiha)
- Added missing
exceptionPathsfield todebugInforeply #814 (@JohanMabille)
- Test
jupyter_kernel_testas downstream #813 (@blink1073) - Remove
nosedependency #808 (@Kojoley) - Add explicit encoding to open calls in debugger #807 (@dlukes)
(GitHub contributors page for this release)
@blink1073 | @dlukes | @echarles | @fasiha | @JohanMabille | @Kojoley
- Fix the temp file name created by the debugger #801 (@eastonsuo)
- Enforce labels on PRs #803 (@blink1073)
- Unpin
IPython, and remove some dependencies on it. #796 (@Carreau)
(GitHub contributors page for this release)
@blink1073 | @Carreau | @eastonsuo
- Fix rich variables inspection #793 (@fcollonval)
- Do not call
setQuitOnLastWindowClosed()on aQCoreApplication#791 (@stukowski)
- Drop
ipython_genutilsrequirement #792 (@penguinolog)
(GitHub contributors page for this release)
@ccordoba12 | @fcollonval | @penguinolog | @stukowski
- Enabled rich rendering of variables in the debugger #787 (@JohanMabille)
- Remove setting of the eventloop function in the InProcessKernel #781 (@rayosborn)
(GitHub contributors page for this release)
@emuccino | @JohanMabille | @rayosborn
(GitHub contributors page for this release)
- Make
json_cleana no-op forjupyter-client>= 7 #708 (@martinRenou)
- Do not assume kernels have loops #766 (@Carreau)
- Fix undefined variable #765 (@martinRenou)
- Make
ipykernelwork withoutdebugpy#767 (@frenzymadness) - Stop using deprecated
recv_multipartwhen using in-process socket. #762 (@Carreau) - Update some warnings with instructions and version number. #761 (@Carreau)
(GitHub contributors page for this release)
@Carreau | @frenzymadness | @martinRenou | @minrk
(GitHub contributors page for this release)
- Add deep variable inspection #753 (@JohanMabille)
- Add
IPKernelApp.capture_fd_outputconfig to disable FD-level capture #752 (@minrk)
- Remove more
nosetest references #750 (@blink1073) - Remove
noseskipIfin favor ofpytest#748 (@Carreau) - Remove more
nose#747 (@Carreau) - Set up release helper plumbing #745 (@afshin)
- Test downstream projects #635 (@davidbrochart)
(GitHub contributors page for this release)
@afshin | @blink1073 | @Carreau | @ccordoba12 | @davidbrochart | @JohanMabille | @kevin-bates | @minrk | @SylvainCorlay
- Remove some more dependency on nose/iptest #743 (@Carreau)
- Remove block param from get_msg() #736 (@davidbrochart)
- Implemented
richInspectVariablerequest handler #734 (@JohanMabille)
- Fix exception raised by
OutStream.write#726 (@SimonKrughoff)
- Add watchfd keyword to InProcessKernel OutStream initialization #727 (@rayosborn)
- Fix typo in eventloops.py #711 (@selasley)
- [bugfix] fix in setup.py (comma before appnope) #709 (@jstriebel)
- Add upper bound to dependency versions. #714 (@martinRenou)
- Replace non-existing function. #723 (@Carreau)
- Remove unused variables #722 (@Carreau)
- Do not use bare except #721 (@Carreau)
- misc whitespace and line too long #720 (@Carreau)
- Formatting: remove semicolon #719 (@Carreau)
- Clean most flake8 unused import warnings. #718 (@Carreau)
- Minimal flake8 config #717 (@Carreau)
- Remove CachingCompiler's filename_mapper #710 (@martinRenou)
- Fix Tk and asyncio event loops #704 (@ccordoba12)
- Stringify variables that are not json serializable in inspectVariable #702 (@JohanMabille)
IPykernel 6.0 is the first major release in about two years, that brings a number of improvements, code cleanup, and new features to IPython.
You should be able to view all closed issues and merged Pull Request for this milestone on GitHub, as for any major releases, we advise greater care when updating that for minor release and welcome any feedback (~50 Pull-requests).
IPykernel 6 should contain all changes of the 5.x series, in addition to the following non-exhaustive changes.
-
Support for the debugger protocol, when using
JupyterLab,RetroLabor any frontend supporting the debugger protocol you should have access to the debugger functionalities. -
The control channel on IPykernel 6.0 is run in a separate thread, this may change the order in which messages are processed, though this change was necessary to accommodate the debugger.
-
We now have a new dependency:
matplotlib-inline, this helps to separate the circular dependency between IPython/IPykernel and matplotlib. -
All outputs to stdout/stderr should now be captured, including subprocesses and output of compiled libraries (blas, lapack....). In notebook server, some outputs that would previously go to the notebooks logs will now both head to notebook logs and in notebooks outputs. In terminal frontend like Jupyter Console, Emacs or other, this may ends up as duplicated outputs.
-
coroutines are now native (async-def) , instead of using tornado's
@gen.coroutine -
OutStreams can now be configured to report
istty() == True, while this should make some output nicer (for example colored), it is likely to break others. Use with care.
- Implementation of the debugger #597 (@JohanMabille)
- Make the
isattymethod ofOutStreamreturntrue#683 (@peendebak) - Allow setting cell name #652 (@davidbrochart)
- Try to capture all file descriptor output and err #630 (@Carreau)
- Implemented
inspectVariablesrequest #624 (@JohanMabille) - Specify
ipykernelin kernelspec #616 (@SylvainCorlay) - Use
matplotlib-inline#591 (@martinRenou) - Run control channel in separate thread #585 (@SylvainCorlay)
- Remove references to deprecated
ipyparallel#695 (@minrk) - Return len of item written to
OutStream#685 (@Carreau) - Call metadata methods on abort replies #684 (@minrk)
- Fix keyboard interrupt issue in
dispatch_shell#673 (@marcoamonteiro) - Update
Triomode for compatibility withTrio >= 0.18.0#627 (@mehaase) - Follow up
DeprecationWarningFix #617 (@afshin) - Flush control stream upon shutdown #611 (@SylvainCorlay)
- Fix Handling of
shell.should_run_async#605 (@afshin) - Deacrease lag time for eventloop #573 (@impact27)
- Fix "Socket operation on nonsocket" in downstream
nbclienttest. #641 (@SylvainCorlay) - Stop control thread before closing sockets on it #659 (@minrk)
- Fix debugging with native coroutines #651 (@SylvainCorlay)
- Fixup master build #649 (@SylvainCorlay)
- Fix parent header retrieval #639 (@davidbrochart)
- Add missing self #636 (@Carreau)
- Backwards compat with older versions of zmq #665 (@mlucool)
- Remove pin on Jedi because that was already fixed in IPython #692 (@ccordoba12)
- Remove deprecated source parameter since 4.0.1 (2015) #690 (@Carreau)
- Remove deprecated
SocketABCsince 4.5.0 #689 (@Carreau) - Remove deprecated profile options of
connect.py#688 (@Carreau) - Remove
ipykernel.codeutildeprecated since IPykernel 4.3.1 (Feb 2016) #687 (@Carreau) - Keep preferring
SelectorEventLoopon Windows #669 (@minrk) - Add
Kernel.get_parentto matchset_parent#661 (@minrk) - Flush control queue prior to handling shell messages #658 (@minrk)
- Add
Kernel.get_parent_header#657 (@minrk) - Build docs only on Ubuntu: add jobs to check docstring formatting. #644 (@Carreau)
- Make deprecated
shell_streamswritable #638 (@minrk) - Use channel
get_msghelper method #634 (@davidbrochart) - Use native coroutines instead of tornado coroutines #632 (@SylvainCorlay)
- Make less use of
ipython_genutils#631 (@SylvainCorlay) - Run GitHub Actions on all branches #625 (@afshin)
- Move Python-specific bits to ipkernel #610 (@SylvainCorlay)
- Update Python Requirement to 3.7 #608 (@afshin)
- Replace import item from
ipython_genutilsto traitlets. #601 (@Carreau) - Some removal of
ipython_genutils.py3compat. #600 (@Carreau) - Fixup
get_parent_headercall #662 (@SylvainCorlay) - Update of
ZMQInteractiveshell. #643 (@Carreau) - Removed filtering of stack frames for testing #633 (@JohanMabille)
- Added 'type' field to variables returned by
inspectVariablesrequest #628 (@JohanMabille) - Changed default timeout to 0.0 seconds for
stop_on_error_timeout#618 (@MSeal) - Attempt longer timeout #615 (@SylvainCorlay)
- Clean up release process and add tests #596 (@afshin)
- Kernelspec: ensure path is writable before writing
kernel.json. #593 (@jellelicht) - Add
configure_inline_supportand call it in the shell #590 (@martinRenou)
- Misc Updates to changelog for 6.0 #686 (@Carreau)
- Add 5.5.x Changelog entries #672 (@blink1073)
- Build docs only on ubuntu: add jobs to check docstring formatting. #644 (@Carreau)
- DOC: Autoreformat all docstrings. #642 (@Carreau)
- Bump Python to 3.8 in
readthedocs.yml#612 (@minrk) - Fix typo #663 (@SylvainCorlay)
- Add release note to 5.5.0 about
stop_on_error_timeout#613 (@glentakahashi) - Move changelog to standard location #604 (@afshin)
- Add changelog for 5.5 #594 (@blink1073)
- Change to markdown for changelog #595 (@afshin)
Kernels now support only a single shell stream, multiple streams will now be ignored. The attributeKernel.shell_streams(plural) is deprecated in ipykernel 6.0. UseKernel.shell_stream(singular)Kernel._parent_headeris deprecated, even though it was private. Use.get_parent()now.
ipykernel.codeutilswas deprecated since 4.x series (2016) and has been removed, please import similar functionalities fromipyparallel- remove
find_connection_fileandprofileargument ofconnect_qtconsoleandget_connection_info, deprecated since IPykernel 4.2.2 (2016).
(GitHub contributors page for this release)
@afshin | @blink1073 | @Carreau | @ccordoba12 | @davidbrochart | @dsblank | @glentakahashi | @impact27 | @ivanov | @jellelicht | @jkablan | @JohanMabille | @kevin-bates | @marcoamonteiro | @martinRenou | @mehaase | @minrk | @mlucool | @MSeal | @peendebak | @SylvainCorlay | @tacaswell
- Keep preferring SelectorEventLoop on Windows. #669
- Import
configure_inline_supportfrommatplotlib_inlineif available #654
- Revert Backport of #605: Fix Handling of
shell.should_run_async#622
Note: This release was deleted from PyPI since it had breaking changes.
- Changed default timeout to 0.0 seconds for stop_on_error_timeout. #618
Note: This release was deleted from PyPI since it had breaking changes.
- Fix Handling of
shell.should_run_async. #605
- kernelspec: ensure path is writable before writing
kernel.json. #593 - Add
configure_inline_supportand call it in the shell. #590 - Fix
stop_on_error_timeoutto now properly abortexecute_request's that fall within the timeout after an error. #572
- Rework
wait_for_readylogic. #578
- Revert "Fix stop_on_error_timeout blocking other messages in queue". #570
- Invalid syntax in
ipykernel/log.py. #567
5.4.0 is generally focused on code quality improvements and tornado asyncio compatibility.
- Add github actions, bail on asyncio patch for tornado 6.1. #564
- Start testing on Python 3.9. #551
- Fix stack levels for ipykernel's deprecation warnings and stop using some deprecated APIs. #547
- Add env parameter to kernel installation #541
- Fix stop_on_error_timeout blocking other messages in queue. #539
- Remove most of the python 2 compat code. #537
- Remove u-prefix from strings. #538
- Only run Qt eventloop in the shell stream. #531
- Fix QSocketNotifier in the Qt event loop not being disabled for the control channel. #525
- Restore timer based event loop as a Windows-compatible fallback. #523
- Fix #520: run post_execute and post_run_cell on async cells #521
- Fix exception causes in zmqshell.py #516
- Make pdb on Windows interruptible #490
5.3.0 Adds support for Trio event loops and has some bug fixes.
- Fix ipython display imports #509
- Skip test_unc_paths if OS is not Windows #507
- Allow interrupting input() on Windows, as part of effort to make pdb interruptible #498
- Add Trio Loop #479
- Flush from process even without newline #478
- Handle system commands that use UNC paths on Windows #500
- Add offset argument to seek in io test #496
5.2.0 Includes several bugfixes and internal logic improvements.
- Produce better traceback when kernel is interrupted #491
- Add
InProcessKernelClient.control_channelfor compatibility with jupyter-client v6.0.0 #489 - Drop support for Python 3.4 #483
- Work around issue related to Tornado with python3.8 on Windows (#480, #481)
- Prevent entering event loop if it is None #464
- Use
shell.input_transformer_managerwhen available #411
5.1.4 Includes a few bugfixes, especially for compatibility with Python 3.8 on Windows.
- Fix pickle issues when using inline matplotlib backend #476
- Fix an error during kernel shutdown #463
- Fix compatibility issues with Python 3.8 (#456, #461)
- Remove some dead code (#474, #467)
5.1.3 Includes several bugfixes and internal logic improvements.
- Fix comm shutdown behavior by adding a
deletingoption toclosewhich can be set to prevent registering new comm channels during shutdown (#433, #435) - Fix
Heartbeat._bind_socketto return on the first bind (#431) - Moved
InProcessKernelClient.flushtoDummySocket(#437) - Don't redirect stdout if nose machinery is not present (#427)
- Rename
_asyncio.pyto_asyncio_utils.pyto avoid name conflicts on Python 3.6+ (#426) - Only generate kernelspec when installing or building wheel (#425)
- Fix priority ordering of control-channel messages in some cases #443
5.1.2 fixes some socket-binding race conditions that caused testing failures in nbconvert.
- Fix socket-binding race conditions (#412, #419)
- Add a no-op
flushmethod toDummySocketand comply with stream API (#405) - Update kernel version to indicate kernel v5.3 support (#394)
- Add testing for upcoming Python 3.8 and PEP 570 positional parameters (#396, #408)
5.1.1 fixes a bug that caused cells to get stuck in a busy state.
- Flush after sending replies #390
5.1.0 fixes some important regressions in 5.0, especially on Windows.
- Fix message-ordering bug that could result in out-of-order executions, especially on Windows #356
- Fix classifiers to indicate dropped Python 2 support #354
- Remove some dead code #355
- Support rich-media responses in
inspect_requests(tooltips) #361
- Drop support for Python 2.
ipykernel5.0 requires Python >= 3.4 - Add support for IPython's asynchronous code execution #323
- Update release process in
CONTRIBUTING.md#339
- Fix compatibility with IPython 7.0 #348
- Fix compatibility in cases where sys.stdout can be None #344
- Python 3.3 is no longer supported #336
- Flush stdout/stderr in KernelApp before replacing #314
- Allow preserving stdout and stderr in KernelApp #315
- Override writable method on OutStream #316
- Add metadata to help display matplotlib figures legibly #336
- Fix compatibility issue with qt eventloop and pyzmq 17 #307.
- set zmq.ROUTER_HANDOVER socket option when available to workaround libzmq reconnect bug #300.
- Fix sdists including absolute paths for kernelspec files, which prevented installation from sdist on Windows #306.
- Cleanly shutdown integrated event loops when shutting down the kernel. #290
%gui qtnow uses Qt 5 by default rather than Qt 4, following a similar change in terminal IPython. #293- Fix event loop integration for
asynciowhen run with Tornado 5, which uses asyncio where available. #296
- Add event loop integration for
asyncio. - Use the new IPython completer API.
- Add support for displaying GIF images (mimetype
image/gif). - Allow the kernel to be interrupted without killing the Qt console.
- Fix
is_completeresponse with cell magics. - Clean up encoding of bytes objects.
- Clean up help links to use
httpsand improve display titles. - Clean up ioloop handling in preparation for tornado 5.
- Fix eventloop-integration bug preventing Qt windows/widgets from displaying with ipykernel 4.6.0 and IPython ≥ 5.2.
- Avoid deprecation warnings about naive datetimes when working with jupyter_client ≥ 5.0.
-
Add to API
DisplayPublisher.publishtwo new fully backward-compatible keyword-args:update: booltransient: dict
-
Support new
transientkey indisplay_datamessages spec forpublish. For a display data message,transientcontains data that shouldn't be persisted to files or documents. Add adisplay_idto thistransientdict bydisplay(obj, display_id=\...) -
Add
ipykernel_launchermodule which removes the current working directory fromsys.pathbefore launching the kernel. This helps to reduce the cases where the kernel won't start because there's arandom.py(or similar) module in the current working directory. -
Add busy/idle messages on IOPub during processing of aborted requests
-
Add active event loop setting to GUI, which enables the correct response to IPython's
is_event_loop_running_xxx -
Include IPython kernelspec in wheels to reduce reliance on "native kernel spec" in jupyter_client
-
Modify
OutStreamto inherit fromTextIOBaseinstead of object to improve API support and error reporting -
Fix IPython kernel death messages at start, such as "Kernel Restarting..." and "Kernel appears to have died", when parent-poller handles PID 1
-
Various bugfixes
- Fix bug when instantiating Comms outside of the IPython kernel (introduced in 4.5.1).
- Add missing
streamparameter to overriddengetpass - Remove locks from iopub thread, which could cause deadlocks during debugging
- Fix regression where KeyboardInterrupt was treated as an aborted request, rather than an error
- Allow instantiating Comms outside of the IPython kernel
- Use figure.dpi instead of savefig.dpi to set DPI for inline figures
- Support ipympl matplotlib backend (requires IPython update as well to fully work)
- Various bugfixes, including fixes for output coming from threads,
and
inputwhen called with non-string prompts, which stdlib allows.
- Fix circular import of matplotlib on Python 2 caused by the inline backend changes in 4.4.0.
- Use
MPLBACKEND
environment variable to tell matplotlib >= 1.5 use use the inline
backend by default. This is only done if MPLBACKEND is not already
set and no backend has been explicitly loaded, so setting
MPLBACKEND=Qt4Aggor calling%matplotlib notebookormatplotlib.use('Agg')will take precedence. - Fixes for logging problems caused by 4.3, where logging could go to the terminal instead of the notebook.
- Add
--sys-prefixand--profilearguments toipython kernel install. - Allow Comm (Widget) messages to be sent from background threads.
- Select inline matplotlib backend by default if
%matplotlibmagic ormatplotlib.use()are not called explicitly (for matplotlib >= 1.5). - Fix some longstanding minor deviations from the message protocol (missing status: ok in a few replies, connect_reply format).
- Remove calls to NoOpContext from IPython, deprecated in 5.0.
- Use a nonempty dummy session key for inprocess kernels to avoid security warnings.
- Fix Windows Python 3.5 incompatibility caused by faulthandler patch in 4.3
-
Publish all IO in a thread, via
IOPubThread. This solves the problem of requiringsys.stdout.flushto be called in the notebook to produce output promptly during long-running cells. -
Remove references to outdated IPython guiref in kernel banner.
-
Patch faulthandler to use
sys.__stderr__instead of forwardedsys.stderr, which has no fileno when forwarded. -
Deprecate some vestiges of the Big Split:
ipykernel.find_connection_fileis deprecated. Usejupyter_client.find_connection_fileinstead.
- Various pieces of code specific to IPython parallel are deprecated in ipykernel and moved to ipyparallel.
- Don't show interactive debugging info when kernel crashes
- Fix handling of numerical types in json_clean
- Testing fixes for output capturing
- Fix default display name back to "Python X" instead of "pythonX"
- Support sending a full message in initial opening of comms (metadata, buffers were not previously allowed)
- When using
ipython kernel install --nameto install the IPython kernelspec, default display-name to the same value as--name.
- Fix missing
ipykernel.__version__on Python 2. - Fix missing
target_namewhen opening comms from the frontend.
- add
ipython kernel installentrypoint for installing the IPython kernelspec - provisional implementation of
comm_inforequest/reply for msgspec v5.1
4.0 is the first release of ipykernel as a standalone package.