Merge branch 'master' into patch-1

Author: danielfrg

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.3.0
+current_version = 0.3.1
 commit = True
 tag = True
 tag_name = {new_version}

MANIFEST.in

@@ -36,7 +36,7 @@ global-exclude .ipynb_checkpoints
 # Binder files to be excluded
 exclude binder
 recursive-exclude binder *.ipynb
-recursive-exclude binder *.txt
+recursive-exclude binder *.yml
 
 # Exclude CI/CD files
 prune .circleci

binder/environment.yml

@@ -0,0 +1,10 @@
+name: nbclient
+channels:
+  - conda-forge
+dependencies:
+  - numpy
+  - pandas
+  - matplotlib
+  - nteract-scrapbook
+  - nbformat
+  - nbclient

binder/requirements.txt

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.3.1
+
+### Fixes
+
+- Check that a kernel manager exists before cleaning up the kernel [#61](https://github.com/jupyter/nbclient/pull/61)
+- Force client class to be async when kernel manager is MultiKernelManager [#55](https://github.com/jupyter/nbclient/pull/55)
+- Replace pip install with conda install in Binder [#54](https://github.com/jupyter/nbclient/pull/54)
+
 ## 0.3.0
 
 ### Major Changes

docs/changelog.md

@@ -36,6 +36,7 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.mathjax',
     'sphinx.ext.napoleon',
+    'myst_parser',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -44,7 +45,7 @@
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-source_suffix = ['.rst', '.md', '.ipynb']
+source_suffix = ['.rst', '.md']
 
 # The master toctree document.
 master_doc = 'index'

docs/conf.py

@@ -2,3 +2,4 @@ Sphinx>=1.7
 sphinx-book-theme
 mock
 moto
+myst-parser

docs/requirements-doc.txt

@@ -1 +1 @@
-version = '0.3.0'
+version = '0.3.1'

nbclient/_version.py

@@ -388,6 +388,9 @@ async def async_start_new_kernel_client(self, **kwargs):
             except AttributeError:
                 raise AttributeError('self.km={} has no client() or get_kernel() method, '
                                      'what is this?'.format(self.km))
+            # since self.km is a MultiKernelManager, it might not be async
+            # so let's ensure the client is async
+            km.client_class = 'jupyter_client.asynchronous.AsyncKernelClient'
 
         self.kc = km.client()
         await ensure_async(self.kc.start_channels())
@@ -467,7 +470,7 @@ async def async_execute(self, **kwargs):
             The executed notebook.
         """
         reset_kc = kwargs.pop('reset_kc', False)
-        if reset_kc:
+        if reset_kc and self.km:
             await self._async_cleanup_kernel()
         self.reset_execution_trackers()
 

nbclient/client.py

@@ -20,6 +20,7 @@
 import IPython
 from traitlets import TraitError
 from nbformat import NotebookNode
+from jupyter_client.asynchronous import AsyncKernelClient
 from jupyter_client import KernelManager, MultiKernelManager
 from jupyter_client.kernelspec import KernelSpecManager
 from nbconvert.filters import strip_ansi
@@ -424,8 +425,8 @@ def test_startnewkernel_with_multikernelmanager():
     kc, kernel_id = executor.start_new_kernel_client()
     # a multi kernel manager always gives back an id to the started kernel
     assert kernel_id is not None
-    # prove it initalized client
-    assert kc is not None
+    # prove it initalized an async client
+    assert isinstance(kc, AsyncKernelClient)
     # since we are not using the setup_kernel context manager,
     # cleanup has to be done manually
     kc.shutdown()