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.

Sign up for GitHub

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

Fix #262: JSONErrorsMixin not returning correct results #263

Merged
merged 1 commit into from
Oct 31, 2017
Merged

Fix #262: JSONErrorsMixin not returning correct results #263

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 14 additions & 12 deletions kernel_gateway/mixins.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
"""Mixins for Tornado handlers."""

import json
import traceback
from tornado import web
try:
# py3
from http.client import responses
Expand Down Expand Up @@ -85,12 +87,8 @@ class JSONErrorsMixin(object):
def write_error(self, status_code, **kwargs):
"""Responds with an application/json error object.

Overrides the HTML renderer in the notebook server to force all errors
to JSON format. Outputs all errors as JSON in the same format as the
notebook.base.handlers.json_errors decorator. Avoids having to
(re-)decorate everything that the kernel gateway overrides. Also avoids
rendering errors as a human readable HTML pages in cases where the
decorator is not used in the notebook code base.
Overrides the APIHandler.write_error in the notebook server until it
properly sets the 'reason' field.

Parameters
----------
Expand All @@ -108,20 +106,24 @@ def write_error(self, status_code, **kwargs):
exc_info = kwargs.get('exc_info')
message = ''
reason = responses.get(status_code, 'Unknown HTTP Error')
reply = {
'reason': reason,
'message': message,
}
if exc_info:
exception = exc_info[1]
# Get the custom message, if defined
try:
message = exception.log_message % exception.args
except Exception:
pass
if isinstance(exception, web.HTTPError):
reply['message'] = exception.log_message or message
else:
reply['message'] = 'Unknown server error'
reply['traceback'] = ''.join(traceback.format_exception(*exc_info))

# Construct the custom reason, if defined
custom_reason = getattr(exception, 'reason', '')
if custom_reason:
reason = custom_reason
reply['reason'] = custom_reason

self.set_header('Content-Type', 'application/json')
self.set_status(status_code)
reply = dict(reason=reason, message=message)
self.finish(json.dumps(reply))