CHANGELOG.md

Changes in NBClient {#changelog}

0.10.4

(Full Changelog)

Merged PRs

• Allow display_id to be None #338 (@davidbrochart, @YannickJadoul, @slayoo)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@davidbrochart (activity) | @slayoo (activity) | @YannickJadoul (activity)

0.10.3

(Full Changelog)

Merged PRs

• Drop Python 3.9, test 3.14 and pypy-3.11 #337 (@davidbrochart)
• correct execution count in test for ipython 9.8 and above #335 (@drorspei, @davidbrochart)
• Update contribution with pytest instructions, remove tox. #331 (@dgrahn, @davidbrochart)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@davidbrochart (activity) | @dgrahn (activity) | @drorspei (activity)

0.10.2

(Full Changelog)

Merged PRs

• Drop Python 3.8, test PyPy 3.10 #323 (@davidbrochart)
• Gracefully handle explicit transient=None #322 (@callmephilip)

Contributors to this release

(GitHub contributors page for this release)

@callmephilip | @davidbrochart

0.10.1

(Full Changelog)

Maintenance and upkeep improvements

• Run docs on ubuntu #314 (@blink1073)

Other merged PRs

• avoid deprecation warning for py313 #320 (@lucascolley)

Contributors to this release

(GitHub contributors page for this release)

@blink1073 | @davidbrochart | @lucascolley

0.10.0

(Full Changelog)

Enhancements made

• Optionally write out executed notebook in jupyter-execute #307 (@wpk-nist-gov)

Contributors to this release

(GitHub contributors page for this release)

@blink1073 | @wpk-nist-gov

0.9.1

(Full Changelog)

Maintenance and upkeep improvements

• Update Release Scripts #309 (@blink1073)
• Pin to Pytest 7 #308 (@blink1073)

Other merged PRs

• chore: update pre-commit hooks #305 (@pre-commit-ci)
• chore: update pre-commit hooks #304 (@pre-commit-ci)
• chore: update pre-commit hooks #303 (@pre-commit-ci)
• Bump actions/checkout from 3 to 4 #302 (@dependabot)
• chore: update pre-commit hooks #300 (@pre-commit-ci)

Contributors to this release

(GitHub contributors page for this release)

@blink1073 | @dependabot | @pre-commit-ci

0.9.0

(Full Changelog)

Maintenance and upkeep improvements

• Use jupyter releaser #301 (@blink1073)
• Clean up lint and move tests out of source #299 (@blink1073)
• Adopt ruff format #298 (@blink1073)
• Update typings for mypy 1.6 #297 (@blink1073)
• Adopt sp-repo-review #295 (@blink1073)
• Fix lint error #289 (@blink1073)

Other merged PRs

• Bump actions/checkout from 3 to 4 #293 (@dependabot)

Contributors to this release

(GitHub contributors page for this release)

@blink1073 | @dependabot | @pre-commit-ci

0.8.0

(Full Changelog)

Maintenance and upkeep improvements

• Bump min version support #287 (@blink1073)

Other merged PRs

• Bump actions/checkout from 2 to 3 #275 (@dependabot)

Contributors to this release

(GitHub contributors page for this release)

@blink1073 | @dependabot | @pre-commit-ci

0.7.4

(Full Changelog)

Enhancements made

• include stream output in CellExecutionError #282 (@minrk)

Bugs fixed

• avoid duplicate 'Exception: message' in CellExecutionError #283 (@minrk)

Maintenance and upkeep improvements

• Use local coverage #281 (@blink1073)

Other merged PRs

• Send KeyboardInterrupt a little later in test_run_all_notebooks[Interrupt.ipynb-opts6] #285 (@kxxt)

Contributors to this release

(GitHub contributors page for this release)

@blink1073 | @davidbrochart | @kxxt | @minrk | @pre-commit-ci

0.7.3

(Full Changelog)

Maintenance and upkeep improvements

• Fix test stability #276 (@blink1073)
• Clean up license #274 (@dcsaba89)
• Update codecov link #271 (@blink1073)
• Add spelling and docstring enforcement #269 (@blink1073)
• Adopt ruff and address lint #267 (@blink1073)

Other merged PRs

• Add coalesce_streams #279 (@davidbrochart)

Contributors to this release

(GitHub contributors page for this release)

@blink1073 | @davidbrochart | @dcsaba89 | @pre-commit-ci

0.7.2

(Full Changelog)

Merged PRs

• Allow space after In #264 (@davidbrochart)
• Fix jupyter_core pinning #263 (@davidbrochart)
• Update README, add Python 3.11 #260 (@davidbrochart)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart

0.7.1

(Full Changelog)

Maintenance and upkeep improvements

• CI Refactor #257 (@blink1073)

Other merged PRs

• Remove nest-asyncio #259 (@davidbrochart)
• Add upper bound to dependencies #258 (@davidbrochart)

Contributors to this release

(GitHub contributors page for this release)

@blink1073 | @davidbrochart | @pre-commit-ci

0.7.0

(Full Changelog)

Maintenance and upkeep improvements

• Cleanup CI #254 (@blink1073)
• Handle client 8 support #253 (@blink1073)

Other merged PRs

Contributors to this release

(GitHub contributors page for this release)

@blink1073 | @pre-commit-ci

0.6.8

(Full Changelog)

Merged PRs

• Fix tests compatibility with IPython 8.5.0 #251 (@frenzymadness)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart | @frenzymadness

0.6.7

(Full Changelog)

Merged PRs

• Fix tests for ipywidgets 8 #246 (@frenzymadness)
• [pre-commit.ci] pre-commit autoupdate #236 (@pre-commit-ci)

Contributors to this release

(GitHub contributors page for this release)

@frenzymadness | @pre-commit-ci

0.6.6

(Full Changelog)

Merged PRs

• Start new client if needed in blocking setup_kernel #241 (@davidbrochart)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart

0.6.5

(Full Changelog)

Merged PRs

• Start new client if needed #239 (@davidbrochart)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart

0.6.4

(Full Changelog)

Merged PRs

• Make sure kernel is cleaned up in case an error occurred while starting kernel client #234 (@CiprianAnton)
• Suppress most warnings in tests #232 (@davidbrochart)

Contributors to this release

(GitHub contributors page for this release)

@CiprianAnton | @davidbrochart

0.6.3

(Full Changelog)

Bugs fixed

• Clean up docs and typings #230 (@blink1073)

Documentation improvements

• Clean up docs and typings #230 (@blink1073)

Contributors to this release

(GitHub contributors page for this release)

@blink1073 | @chrisjsewell | @davidbrochart | @meeseeksmachine

0.6.2

(Full Changelog)

Merged PRs

• Fix documentation generation #228 (@davidbrochart)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart

0.6.1

(Full Changelog)

Merged PRs

• [pre-commit.ci] pre-commit autoupdate #225 (@pre-commit-ci)
• Add error_on_interrupt trait #224 (@davidbrochart)
• Fix typo #223 (@davidbrochart)
• Add on_cell_executed hook #222 (@davidbrochart)

Contributors to this release

(GitHub contributors page for this release)

@brichet | @davidbrochart | @pre-commit-ci

0.6.0

(Full Changelog)

Maintenance and upkeep improvements

• Fix typings and update mypy settings #220 (@blink1073)
• Add missing dep on testpath #219 (@blink1073)
• Add more pre-commit hooks and update flake8 #218 (@blink1073)

Documentation improvements

• Clean up docs handling #216 (@blink1073)

Contributors to this release

(GitHub contributors page for this release)

@blink1073

0.5.13

(Full Changelog)

Merged PRs

• Drop ipython_genutils #209 (@davidbrochart)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart

0.5.12

(Full Changelog)

Merged PRs

• Require traitlets>=5.0.0 #204 (@davidbrochart)
• Extend the ignored part of IPython outputs #202 (@frenzymadness)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart | @frenzymadness

0.5.11

(Full Changelog)

Merged PRs

• Pin ipython<8 in tests #198 (@davidbrochart)
• Clear execution metadata, prefer msg header date when recording times #195 (@kevin-bates)
• Client hooks #188 (@devintang3)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart | @devintang3 | @kevin-bates

0.5.10

(Full Changelog)

Merged PRs

• Fix ipywidgets version in tests #192 (@martinRenou)
• Compatibility with IPython 8 where tracebacks are different #190 (@frenzymadness)
• Drop tox #187 (@davidbrochart)
• Update README #185 (@davidbrochart)
• Drop python3.6, test python3.10 #184 (@davidbrochart)
• Fix typos #182 (@kianmeng)
• Use codecov Github action v2 #168 (@takluyver)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart | @frenzymadness | @kianmeng | @martinRenou | @takluyver

0.5.9

(Full Changelog)

Merged PRs

• Remove jupyter-run, keep jupyter-execute #180 (@davidbrochart)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart

0.5.8

No merged PRs

0.5.7

(Full Changelog)

Merged PRs

• Prepare for use with Jupyter Releaser #175 (@davidbrochart)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart

0.5.6

• Changed jupyter execute to jupyter run #173 (@palewire)
• Move IPYKERNEL_CELL_NAME from tox to pytest #172 (@frenzymadness)

0.5.5

• Added CLI to README #170 (@palewire)
• Add "jupyter execute" command-line interface #165 (@palewire)
• Fix: updating buffers overwrote previous buffers #169 (@maartenbreddels)
• Fix tests for ipykernel without debugpy #166 (@frenzymadness)
• gitignore Pipfile #164 (@palewire)
• Fixed CONTRIBUTING.md link #163 (@palewire)
• Fix typo #162 (@The-Compiler)
• Move format & lint to pre-commit #161 (@chrisjsewell)
• Add skip-execution cell tag functionality #151 (@chrisjsewell)

0.5.4

• Replace km.cleanup with km.cleanup_resources #152 (@davidbrochart)
• Use async generator backport only on old python #154 (@mkoeppe)
• Support parsing of IPython dev version #150 (@cphyc)
• Set IPYKERNEL_CELL_NAME = <IPY-INPUT> #147 (@davidbrochart)
• Print useful error message on exception #142 (@certik)

0.5.3

• Fix ipykernel's stop_on_error value to take into account raises-exception tag and force_raise_errors #137

0.5.2

• Set minimum python version supported to 3.6.1 to avoid 3.6.0 issues
• CellExecutionError is now unpickleable
• Added testing for python 3.9
• Changed travis tests to github actions
• Documentation referencing an old model instead of NotebookClient was fixed
• allow_error_names option was added for a more specific scope of allow_errors to be applied

0.5.1

• Update kernel client class JIT if it's the synchronous version
• Several documentation fixes / improvements

0.5.0

• Move language_info retrieval before cell execution #102
• HistoryManager setting for ipython kernels no longer applies twice (fix for 5.0 trailets release)
• Improved error handling around language_info missing
• (async_)start_new_kernel_client is now split into (async_)start_new_kernel and (async_)start_new_kernel_client

0.4.2 - 0.4.3

These patch releases were removed due to backwards incompatible changes that should have been a minor release. If you were using these versions for the couple days they were up, move to 0.5.0 and you shouldn't have any issues.

0.4.1

• Python type hinting added to most interfaces! #83
• Several documentation fixes and improvements were made #86
• An asynchronous heart beat check was added to correctly raise a DeadKernelError when kernels die unexpectantly #90

0.4.0

Major Changes

• Use KernelManager's graceful shutdown rather than KILLing kernels #64
• Mimic an Output widget at the frontend so that the Output widget behaves correctly #68
• Nested asyncio is automatic, and works with Tornado #71
• async_execute now has a reset_kc argument to control if the client is reset upon execution request #53

Fixes

• Fix OSError: [WinError 6] The handle is invalid for windows/python<3.7 #77
• Async wrapper Exceptions no longer loose their caused exception information #65
• extra_arguments are now configurable by config settings #66

Operational

• Cross-OS testing now run on PRs via Github Actions #63

0.3.1

Fixes

• Check that a kernel manager exists before cleaning up the kernel #61
• Force client class to be async when kernel manager is MultiKernelManager #55
• Replace pip install with conda install in Binder #54

0.3.0

Major Changes

• The (async_)start_new_kernel_client method now supports starting a new client when its kernel manager (self.km) is a MultiKernelManager. The method now returns the kernel id in addition to the kernel client. If the kernel manager was a KernelManager, the returned kernel id is None. #51
• Added sphinx-book-theme for documentation. Added a CircleCI job to let us preview the built documentation in a PR. #50
• Added reset_kc option to reset_execution_trackers, so that the kernel client can be reset and a new one created in calls to (async_)execute #44

Docs

• Fixed documentation #46 #47
• Added documentation status badge to the README
• Removed conda from documentation build

0.2.0

Major Changes

• Async support is now available on the client. Methods that support async have an async_ prefix and can be awaited #10 #35 #37 #38
• Dropped support for Python 3.5 due to async compatibility issues #34
• Notebook documents now include the new kernel timing fields #32

Fixes

• Memory and process leaks from nbclient should now be fixed #34
• Notebook execution exceptions now include error information in addition to the message #41

Docs

• Added binder examples / tests #7
• Added changelog to docs #22
• Doc typo fixes #27 #30

0.1.0

• Initial release -- moved out of nbconvert 6.0.0-a0