fix issues with method not allowed response

This commit is contained in:
Raphael Deem 2017-12-11 20:11:20 -08:00
parent 969dac2033
commit 2b0258c13a
4 changed files with 45 additions and 5 deletions

View File

@ -543,6 +543,7 @@ class Sanic:
# Fetch handler from router # Fetch handler from router
handler, args, kwargs, uri = self.router.get(request) handler, args, kwargs, uri = self.router.get(request)
request.uri_template = uri request.uri_template = uri
if handler is None: if handler is None:
raise ServerError( raise ServerError(

View File

@ -150,6 +150,16 @@ class InvalidUsage(SanicException):
pass pass
@add_status_code(405)
class MethodNotSupported(SanicException):
def __init__(self, message, method, allowed_methods):
super().__init__(message)
self.headers = dict()
self.headers["Allow"] = ", ".join(allowed_methods)
if method in ['HEAD', 'PATCH', 'PUT', 'DELETE']:
self.headers['Content-Length'] = 0
@add_status_code(500) @add_status_code(500)
class ServerError(SanicException): class ServerError(SanicException):
pass pass

View File

@ -3,7 +3,7 @@ from collections import defaultdict, namedtuple
from collections.abc import Iterable from collections.abc import Iterable
from functools import lru_cache from functools import lru_cache
from sanic.exceptions import NotFound, InvalidUsage from sanic.exceptions import NotFound, InvalidUsage, MethodNotSupported
from sanic.views import CompositionView from sanic.views import CompositionView
Route = namedtuple( Route = namedtuple(
@ -352,6 +352,15 @@ class Router:
except NotFound: except NotFound:
return self._get(request.path, request.method, '') return self._get(request.path, request.method, '')
def get_supported_methods(self, url):
"""Get a list of supported methods for a url and optional host.
:param url: URL string (including host)
:return: frozenset of supported methods
"""
route = self.routes_all.get(url)
return getattr(route, 'methods', frozenset())
@lru_cache(maxsize=ROUTER_CACHE_SIZE) @lru_cache(maxsize=ROUTER_CACHE_SIZE)
def _get(self, url, method, host): def _get(self, url, method, host):
"""Get a request handler based on the URL of the request, or raises an """Get a request handler based on the URL of the request, or raises an
@ -364,9 +373,10 @@ class Router:
url = host + url url = host + url
# Check against known static routes # Check against known static routes
route = self.routes_static.get(url) route = self.routes_static.get(url)
method_not_supported = InvalidUsage( method_not_supported = MethodNotSupported(
'Method {} not allowed for URL {}'.format( 'Method {} not allowed for URL {}'.format(method, url),
method, url), status_code=405) method=method,
allowed_methods=self.get_supported_methods(url))
if route: if route:
if route.methods and method not in route.methods: if route.methods and method not in route.methods:
raise method_not_supported raise method_not_supported

View File

@ -35,6 +35,25 @@ async def sample_streaming_fn(response):
await asyncio.sleep(.001) await asyncio.sleep(.001)
response.write('bar') response.write('bar')
def test_method_not_allowed():
app = Sanic('method_not_allowed')
@app.get('/')
async def test(request):
return response.json({'hello': 'world'})
request, response = app.test_client.head('/')
assert response.headers['Allow']== 'GET'
@app.post('/')
async def test(request):
return response.json({'hello': 'world'})
request, response = app.test_client.head('/')
assert response.status == 405
assert set(response.headers['Allow'].split(', ')) == set(['GET', 'POST'])
assert response.headers['Content-Length'] == '0'
@pytest.fixture @pytest.fixture
def json_app(): def json_app():