Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add KernelSpecManager.get_all_specs #93

Merged
merged 5 commits into from
Nov 27, 2015
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 23 additions & 10 deletions jupyter_client/kernelspec.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,17 +138,10 @@ def find_kernel_specs(self):
return d
# TODO: Caching?

def get_kernel_spec(self, kernel_name):
"""Returns a :class:`KernelSpec` instance for the given kernel_name.

Raises :exc:`NoSuchKernel` if the given kernel name is not found.
def _get_kernel_spec_by_name(self, kernel_name, resource_dir):
""" Returns a :class:`KernelSpec` instance for a given kernel_name
and resource_dir.
"""
d = self.find_kernel_specs()
try:
resource_dir = d[kernel_name.lower()]
except KeyError:
raise NoSuchKernel(kernel_name)

if kernel_name == NATIVE_KERNEL_NAME:
try:
from ipykernel.kernelspec import RESOURCES, get_kernel_dict
Expand All @@ -161,6 +154,26 @@ def get_kernel_spec(self, kernel_name):

return self.kernel_spec_class.from_resource_dir(resource_dir)

def get_kernel_spec(self, kernel_name):
"""Returns a :class:`KernelSpec` instance for the given kernel_name.

Raises :exc:`NoSuchKernel` if the given kernel name is not found.
"""
d = self.find_kernel_specs()
try:
resource_dir = d[kernel_name.lower()]
except KeyError:
raise NoSuchKernel(kernel_name)

return self._get_kernel_spec_by_name(kernel_name, resource_dir)

def find_all_specs(self):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's call this get_all_specs. That way get_ returns kernelspec objects, while find_ returns locations on disk.

And don't forget to add a docstring.

d = self.find_kernel_specs()
return {kname: {
"resource_dir": d[kname],
"spec": self._get_kernel_spec_by_name(kname, d[kname]).to_dict()
} for kname in d}

def _get_destination_dir(self, kernel_name, user=False, prefix=None):
if user:
return os.path.join(self.user_kernel_dir, kernel_name)
Expand Down
5 changes: 1 addition & 4 deletions jupyter_client/kernelspecapp.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,7 @@ def _kernel_spec_manager_default(self):

def start(self):
paths = self.kernel_spec_manager.find_kernel_specs()
specs = {kname: {
"resources_dir": paths[kname],
"spec": self.kernel_spec_manager.get_kernel_spec(kname).to_dict()
} for kname in paths}
specs = self.kernel_spec_manager.find_all_specs()
if not self.json_output:
if not specs:
print("No kernels available")
Expand Down
5 changes: 5 additions & 0 deletions jupyter_client/tests/test_kernelspec.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@ def test_get_kernel_spec(self):
self.assertEqual(ks.argv, sample_kernel_json['argv'])
self.assertEqual(ks.display_name, sample_kernel_json['display_name'])
self.assertEqual(ks.env, {})

def test_find_all_specs(self):
kernels = self.ksm.find_all_specs()
self.assertEqual(kernels['sample']['resource_dir'], self.sample_kernel_dir)
self.assertIsNotNone(kernels['sample']['spec'])

def test_kernel_spec_priority(self):
td = TemporaryDirectory()
Expand Down