Merge pull request #5827 from takluyver/kernelspec-rest-api
Kernel specs REST API
Min RK
12 years ago
commit
99f52dee68
@ -0,0 +1,27 @@
|
||||
from tornado import web
|
||||
from ..base.handlers import IPythonHandler
|
||||
from ..services.kernelspecs.handlers import kernel_name_regex
|
||||
|
||||
class KernelSpecResourceHandler(web.StaticFileHandler, IPythonHandler):
|
||||
SUPPORTED_METHODS = ('GET', 'HEAD')
|
||||
|
||||
def initialize(self):
|
||||
web.StaticFileHandler.initialize(self, path='')
|
||||
|
||||
@web.authenticated
|
||||
def get(self, kernel_name, path, include_body=True):
|
||||
ksm = self.kernel_spec_manager
|
||||
try:
|
||||
self.root = ksm.get_kernel_spec(kernel_name).resource_dir
|
||||
except KeyError:
|
||||
raise web.HTTPError(404, u'Kernel spec %s not found' % kernel_name)
|
||||
self.log.debug("Serving kernel resource from: %s", self.root)
|
||||
return web.StaticFileHandler.get(self, path, include_body=include_body)
|
||||
|
||||
@web.authenticated
|
||||
def head(self, kernel_name, path):
|
||||
self.get(kernel_name, path, include_body=False)
|
||||
|
||||
default_handlers = [
|
||||
(r"/kernelspecs/%s/(?P<path>.*)" % kernel_name_regex, KernelSpecResourceHandler),
|
||||
]
|
||||
@ -0,0 +1,50 @@
|
||||
"""Tornado handlers for kernel specifications."""
|
||||
|
||||
# Copyright (c) IPython Development Team.
|
||||
# Distributed under the terms of the Modified BSD License.
|
||||
import json
|
||||
from tornado import web
|
||||
|
||||
from ...base.handlers import IPythonHandler, json_errors
|
||||
|
||||
|
||||
class MainKernelSpecHandler(IPythonHandler):
|
||||
SUPPORTED_METHODS = ('GET',)
|
||||
|
||||
@web.authenticated
|
||||
@json_errors
|
||||
def get(self):
|
||||
ksm = self.kernel_spec_manager
|
||||
results = []
|
||||
for kernel_name in ksm.find_kernel_specs():
|
||||
d = ksm.get_kernel_spec(kernel_name).to_dict()
|
||||
d['name'] = kernel_name
|
||||
results.append(d)
|
||||
|
||||
self.set_header("Content-Type", 'application/json')
|
||||
self.finish(json.dumps(results))
|
||||
|
||||
|
||||
class KernelSpecHandler(IPythonHandler):
|
||||
SUPPORTED_METHODS = ('GET',)
|
||||
|
||||
@web.authenticated
|
||||
@json_errors
|
||||
def get(self, kernel_name):
|
||||
ksm = self.kernel_spec_manager
|
||||
try:
|
||||
kernelspec = ksm.get_kernel_spec(kernel_name)
|
||||
except KeyError:
|
||||
raise web.HTTPError(404, u'Kernel spec %s not found' % kernel_name)
|
||||
self.set_header("Content-Type", 'application/json')
|
||||
self.finish(kernelspec.to_json())
|
||||
|
||||
|
||||
# URL to handler mappings
|
||||
|
||||
kernel_name_regex = r"(?P<kernel_name>\w+)"
|
||||
|
||||
default_handlers = [
|
||||
(r"/api/kernelspecs", MainKernelSpecHandler),
|
||||
(r"/api/kernelspecs/%s" % kernel_name_regex, KernelSpecHandler),
|
||||
]
|
||||
@ -0,0 +1,97 @@
|
||||
# coding: utf-8
|
||||
"""Test the kernel specs webservice API."""
|
||||
|
||||
import errno
|
||||
import io
|
||||
import json
|
||||
import os
|
||||
|
||||
pjoin = os.path.join
|
||||
|
||||
import requests
|
||||
|
||||
from IPython.html.utils import url_path_join
|
||||
from IPython.html.tests.launchnotebook import NotebookTestBase, assert_http_error
|
||||
|
||||
# Copied from IPython.kernel.tests.test_kernelspec so updating that doesn't
|
||||
# break these tests
|
||||
sample_kernel_json = {'argv':['cat', '{connection_file}'],
|
||||
'display_name':'Test kernel',
|
||||
'language':'bash',
|
||||
}
|
||||
|
||||
some_resource = u"The very model of a modern major general"
|
||||
|
||||
|
||||
class KernelSpecAPI(object):
|
||||
"""Wrapper for notebook API calls."""
|
||||
def __init__(self, base_url):
|
||||
self.base_url = base_url
|
||||
|
||||
def _req(self, verb, path, body=None):
|
||||
response = requests.request(verb,
|
||||
url_path_join(self.base_url, path),
|
||||
data=body,
|
||||
)
|
||||
response.raise_for_status()
|
||||
return response
|
||||
|
||||
def list(self):
|
||||
return self._req('GET', 'api/kernelspecs')
|
||||
|
||||
def kernel_spec_info(self, name):
|
||||
return self._req('GET', url_path_join('api/kernelspecs', name))
|
||||
|
||||
def kernel_resource(self, name, path):
|
||||
return self._req('GET', url_path_join('kernelspecs', name, path))
|
||||
|
||||
class APITest(NotebookTestBase):
|
||||
"""Test the kernelspec web service API"""
|
||||
def setUp(self):
|
||||
ipydir = self.ipython_dir.name
|
||||
sample_kernel_dir = pjoin(ipydir, 'kernels', 'sample')
|
||||
try:
|
||||
os.makedirs(sample_kernel_dir)
|
||||
except OSError as e:
|
||||
if e.errno != errno.EEXIST:
|
||||
raise
|
||||
|
||||
with open(pjoin(sample_kernel_dir, 'kernel.json'), 'w') as f:
|
||||
json.dump(sample_kernel_json, f)
|
||||
|
||||
with io.open(pjoin(sample_kernel_dir, 'resource.txt'), 'w',
|
||||
encoding='utf-8') as f:
|
||||
f.write(some_resource)
|
||||
|
||||
self.ks_api = KernelSpecAPI(self.base_url())
|
||||
|
||||
def test_list_kernelspecs(self):
|
||||
specs = self.ks_api.list().json()
|
||||
assert isinstance(specs, list)
|
||||
|
||||
# 2: the sample kernelspec created in setUp, and the native Python kernel
|
||||
self.assertEqual(len(specs), 2)
|
||||
|
||||
def is_sample_kernelspec(s):
|
||||
return s['name'] == 'sample' and s['display_name'] == 'Test kernel'
|
||||
|
||||
assert any(is_sample_kernelspec(s) for s in specs), specs
|
||||
|
||||
def test_get_kernelspec(self):
|
||||
spec = self.ks_api.kernel_spec_info('Sample').json() # Case insensitive
|
||||
self.assertEqual(spec['language'], 'bash')
|
||||
|
||||
def test_get_nonexistant_kernelspec(self):
|
||||
with assert_http_error(404):
|
||||
self.ks_api.kernel_spec_info('nonexistant')
|
||||
|
||||
def test_get_kernel_resource_file(self):
|
||||
res = self.ks_api.kernel_resource('sAmple', 'resource.txt')
|
||||
self.assertEqual(res.text, some_resource)
|
||||
|
||||
def test_get_nonexistant_resource(self):
|
||||
with assert_http_error(404):
|
||||
self.ks_api.kernel_resource('nonexistant', 'resource.txt')
|
||||
|
||||
with assert_http_error(404):
|
||||
self.ks_api.kernel_resource('sample', 'nonexistant.txt')
|
||||
Loading…
Reference in new issue