В настоящее время я использую следующее, чтобы поднять HTTP-запрос:
raise tornado.web.HTTPError(400)
который возвращает вывод html:
<html><title>400: Bad Request</title><body>400: Bad Request</body></html>
Можно ли вернуть только код ответа HTTP с настраиваемым телом?
Вы можете имитировать метод RequestHandler.send_error:
class MyHandler(tornado.web.RequestHandler):
def get(self):
self.clear()
self.set_status(400)
self.finish("<html><body>My custom body</body></html>")
Tornado называет RequestHandler.write_error для вывода ошибок, поэтому альтернатива подход VisioN будет переопределять его, как было предложено Tornado docs. Преимуществом этого подхода является то, что он позволит вам поднять HTTPError по-прежнему.
Источником RequestHandler.write_error является здесь. Ниже вы можете увидеть пример простой модификации write_error, который изменит набор кода состояния и изменит вывод, если вы укажете причину в kwargs.
def write_error(self, status_code, **kwargs):
if self.settings.get("serve_traceback") and "exc_info" in kwargs:
# in debug mode, try to send a traceback
self.set_header('Content-Type', 'text/plain')
for line in traceback.format_exception(*kwargs["exc_info"]):
self.write(line)
self.finish()
else:
self.set_status(status_code)
if kwargs['reason']:
self.finish(kwargs['reason'])
else:
self.finish("<html><title>%(code)d: %(message)s</title>"
"<body>%(code)d: %(message)s</body></html>" % {
"code": status_code,
"message": self._reason,
})
Лучше использовать стандартный интерфейс и определить свое пользовательское сообщение на HTTPError.
raise tornado.web.HTTPError(status_code=code, log_message=custom_msg)
Затем вы можете проанализировать ошибку в RequestHandler и проверить сообщение:
class CustomHandler(tornado.web.RequestHandler):
def write_error(self, status_code, **kwargs):
err_cls, err, traceback = kwargs['exc_info']
if err.log_message and err.log_message.startswith(custom_msg):
self.write("<html><body><h1>Here be dragons</h1></body></html>")
def write_error(self, status_code, **kwargs):
#Function to display custom error page defined in the handler.
#Over written from base handler.
data = {}
data['code'] = status_code
data['message'] = httplib.responses[status_code]
# your other conditions here to create data dict
self.write(TEMPLATES.load('error.html').generate(data=data))
когда инициируется вызов self.send_error() Функция write_error() вызывается обработчиком запроса. Таким образом, вы можете создать свой пользовательский файл данных с данными здесь и отобразить его на странице пользовательских ошибок.
http.responses [status_code] возвращает текст кода ошибки, например, "страница не найдена" на основе кода состояния.
Также вы можете переопределить метод get_error_html в своем обработчике. Например:
import tornado.web
class CustomHandler(tornado.web.RequestHandler):
def get_error_html(self, status_code, **kwargs);
self.write("<html><body><h1>404!</h1></body></html>")
...
def get(self):
...
Этот обмен разъясняет некоторые из предложенных здесь подходов и исключает ключевое слово reason (о котором я подумывал).
Q: (мртн)
"Я хочу использовать raise tornado.web.HTTPError(400, reason='invalid request') для передачи пользовательской причины ответа об ошибке, и я надеюсь сделать это путем переопределения метода write_error (self, status_code, **kwargs).
"Но кажется, что я могу получить доступ только к self._reason внутри write_error, а это не то, чего я хочу. Я также пытался kwargs['reason'], но этого не существует".
A: (ведущий разработчик Tornado @bendarnell)
"Исключение, которое выявило ошибку, доступно write_error как тройка exc_info в аргументах ключевого слова. Вы можете получить доступ к полю причины с помощью чего-то вроде этого:
if "exc_info" in kwargs:
e = kwargs["exc_info"][1]
if isinstance(e, tornado.web.HTTPError):
reason = e.reason
"Но обратите внимание, что поле reason по существу устарело (оно отсутствует в HTTP/2), поэтому, вероятно, это не лучший способ сделать то, что вы пытаетесь сделать здесь (HTTPError log_message поле немного лучше, но все же не идеально). Просто поднимите свое собственное исключение вместо использования HTTPError; ваше переопределение write_error может использовать self.set_status(400), когда оно видит правильный тип исключения. "
Для ответа на ошибку JSON я использую следующий шаблон:
Обработчик запросов:
import json
from tornado.web import RequestHandler
from src.lib.errors import HTTPBadRequest
class JsonHandler(RequestHandler):
def prepare(self):
content_type = ''
if "Content-Type" in self.request.headers:
content_type = self.request.headers['Content-Type']
if content_type == 'application/json':
try:
self.request.body = json.loads(self.request.body.decode('utf-8'))
except ValueError:
raise HTTPBadRequest
def write_error(self, *args, **kwargs):
err_cls, err, traceback = kwargs['exc_info']
self.set_status(err.status_code)
if err.description:
self.write_json(err.description)
self.finish()
def set_default_headers(self):
self.set_header('Content-Type', 'application/json')
def write_json(self, response):
self.write(json.dumps(response))
Обработчик ошибок:
from typing import Any
from tornado import httputil
class BaseHTTPError(Exception):
def __init__(
self, status_code: int = 500, description=None, *args: Any, **kwargs: Any
) -> None:
if description is None:
description = {}
self.status_code = status_code
self.description = description
self.args = args
self.kwargs = kwargs
def __str__(self) -> str:
message = "HTTP %d: %s" % (
self.status_code,
httputil.responses.get(self.status_code, "Unknown"),
)
return message
class HTTPBadRequest(BaseHTTPError):
def __init__(self, *args, **kwargs):
super().__init__(status_code=400, description={"error": "Bad Request"}, *args, **kwargs)