mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-22 17:47:04 +03:00
Allow action decorator to handle multiple http methods
This commit is contained in:
parent
02b29267ac
commit
112b52f57e
|
@ -112,18 +112,18 @@ def link(**kwargs):
|
||||||
Used to mark a method on a ViewSet that should be routed for GET requests.
|
Used to mark a method on a ViewSet that should be routed for GET requests.
|
||||||
"""
|
"""
|
||||||
def decorator(func):
|
def decorator(func):
|
||||||
func.bind_to_method = 'get'
|
func.bind_to_methods = ['get']
|
||||||
func.kwargs = kwargs
|
func.kwargs = kwargs
|
||||||
return func
|
return func
|
||||||
return decorator
|
return decorator
|
||||||
|
|
||||||
|
|
||||||
def action(**kwargs):
|
def action(methods=['post'], **kwargs):
|
||||||
"""
|
"""
|
||||||
Used to mark a method on a ViewSet that should be routed for POST requests.
|
Used to mark a method on a ViewSet that should be routed for POST requests.
|
||||||
"""
|
"""
|
||||||
def decorator(func):
|
def decorator(func):
|
||||||
func.bind_to_method = 'post'
|
func.bind_to_methods = methods
|
||||||
func.kwargs = kwargs
|
func.kwargs = kwargs
|
||||||
return func
|
return func
|
||||||
return decorator
|
return decorator
|
||||||
|
|
|
@ -131,20 +131,20 @@ class SimpleRouter(BaseRouter):
|
||||||
dynamic_routes = []
|
dynamic_routes = []
|
||||||
for methodname in dir(viewset):
|
for methodname in dir(viewset):
|
||||||
attr = getattr(viewset, methodname)
|
attr = getattr(viewset, methodname)
|
||||||
httpmethod = getattr(attr, 'bind_to_method', None)
|
httpmethods = getattr(attr, 'bind_to_methods', None)
|
||||||
if httpmethod:
|
if httpmethods:
|
||||||
dynamic_routes.append((httpmethod, methodname))
|
dynamic_routes.append((httpmethods, methodname))
|
||||||
|
|
||||||
ret = []
|
ret = []
|
||||||
for route in self.routes:
|
for route in self.routes:
|
||||||
if route.mapping == {'{httpmethod}': '{methodname}'}:
|
if route.mapping == {'{httpmethod}': '{methodname}'}:
|
||||||
# Dynamic routes (@link or @action decorator)
|
# Dynamic routes (@link or @action decorator)
|
||||||
for httpmethod, methodname in dynamic_routes:
|
for httpmethods, methodname in dynamic_routes:
|
||||||
initkwargs = route.initkwargs.copy()
|
initkwargs = route.initkwargs.copy()
|
||||||
initkwargs.update(getattr(viewset, methodname).kwargs)
|
initkwargs.update(getattr(viewset, methodname).kwargs)
|
||||||
ret.append(Route(
|
ret.append(Route(
|
||||||
url=replace_methodname(route.url, methodname),
|
url=replace_methodname(route.url, methodname),
|
||||||
mapping={httpmethod: methodname},
|
mapping=dict((httpmethod, methodname) for httpmethod in httpmethods),
|
||||||
name=replace_methodname(route.name, methodname),
|
name=replace_methodname(route.name, methodname),
|
||||||
initkwargs=initkwargs,
|
initkwargs=initkwargs,
|
||||||
))
|
))
|
||||||
|
|
|
@ -23,6 +23,10 @@ class BasicViewSet(viewsets.ViewSet):
|
||||||
def action2(self, request, *args, **kwargs):
|
def action2(self, request, *args, **kwargs):
|
||||||
return Response({'method': 'action2'})
|
return Response({'method': 'action2'})
|
||||||
|
|
||||||
|
@action(methods=['post', 'delete'])
|
||||||
|
def action3(self, request, *args, **kwargs):
|
||||||
|
return Response({'method': 'action2'})
|
||||||
|
|
||||||
@link()
|
@link()
|
||||||
def link1(self, request, *args, **kwargs):
|
def link1(self, request, *args, **kwargs):
|
||||||
return Response({'method': 'link1'})
|
return Response({'method': 'link1'})
|
||||||
|
@ -40,16 +44,17 @@ class TestSimpleRouter(TestCase):
|
||||||
routes = self.router.get_routes(BasicViewSet)
|
routes = self.router.get_routes(BasicViewSet)
|
||||||
decorator_routes = routes[2:]
|
decorator_routes = routes[2:]
|
||||||
# Make sure all these endpoints exist and none have been clobbered
|
# Make sure all these endpoints exist and none have been clobbered
|
||||||
for i, endpoint in enumerate(['action1', 'action2', 'link1', 'link2']):
|
for i, endpoint in enumerate(['action1', 'action2', 'action3', 'link1', 'link2']):
|
||||||
route = decorator_routes[i]
|
route = decorator_routes[i]
|
||||||
# check url listing
|
# check url listing
|
||||||
self.assertEqual(route.url,
|
self.assertEqual(route.url,
|
||||||
'^{{prefix}}/{{lookup}}/{0}/$'.format(endpoint))
|
'^{{prefix}}/{{lookup}}/{0}/$'.format(endpoint))
|
||||||
# check method to function mapping
|
# check method to function mapping
|
||||||
if endpoint.startswith('action'):
|
if endpoint == 'action3':
|
||||||
method_map = 'post'
|
methods_map = ['post', 'delete']
|
||||||
|
elif endpoint.startswith('action'):
|
||||||
|
methods_map = ['post']
|
||||||
else:
|
else:
|
||||||
method_map = 'get'
|
methods_map = ['get']
|
||||||
self.assertEqual(route.mapping[method_map], endpoint)
|
for method in methods_map:
|
||||||
|
self.assertEqual(route.mapping[method], endpoint)
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user