Skip to content

Commit 76b0e3f

Browse files
committed
Prepare docs for 4.2
- changelog highlights - document get_all_specs
1 parent a3f74f2 commit 76b0e3f

File tree

3 files changed

+28
-1
lines changed

3 files changed

+28
-1
lines changed

docs/api/kernelspec.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ kernelspec - discovering kernels
3535

3636
.. automethod:: find_kernel_specs
3737

38+
.. automethod:: get_all_specs
39+
3840
.. automethod:: get_kernel_spec
3941

4042
.. automethod:: install_kernel_spec

docs/changelog.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@
44
Changes in Jupyter Client
55
=========================
66

7+
4.2
8+
===
9+
10+
4.2.0
11+
-----
12+
13+
`4.2.0 on GitHub <https://github.com/jupyter/jupyter_client/milestones/4.2>`__
14+
15+
- added :command:`jupyter kernelspec remove` for removing kernelspecs
16+
- allow specifying the environment for kernel processes via the ``env`` argument
17+
- added ``name`` field to connection files identifying the kernelspec name,
18+
so that consumers of connection files (alternate frontends) can identify the kernelspec in use
19+
- added :meth:`KernelSpecManager.get_all_specs` for getting all kernelspecs more efficiently
20+
- various improvements to error messages and documentation
21+
722
4.1
823
===
924

jupyter_client/kernelspec.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,17 @@ def get_kernel_spec(self, kernel_name):
177177
return self._get_kernel_spec_by_name(kernel_name, resource_dir)
178178

179179
def get_all_specs(self):
180-
"""Returns a dict mapping kernel names and resource directories.
180+
"""Returns a dict mapping kernel names to kernelspecs.
181+
182+
Returns a dict of the form::
183+
184+
{
185+
'kernel_name': {
186+
'resource_dir': '/path/to/kernel_name',
187+
'spec': {"the spec itself": ...}
188+
},
189+
...
190+
}
181191
"""
182192
d = self.find_kernel_specs()
183193
return {kname: {

0 commit comments

Comments
 (0)