mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-22 01:26:53 +03:00
Check extra action func.__name__ (#7098)
This commit is contained in:
parent
0d2bbd3177
commit
1e383f103a
|
@ -33,6 +33,15 @@ def _is_extra_action(attr):
|
|||
return hasattr(attr, 'mapping') and isinstance(attr.mapping, MethodMapper)
|
||||
|
||||
|
||||
def _check_attr_name(func, name):
|
||||
assert func.__name__ == name, (
|
||||
'Expected function (`{func.__name__}`) to match its attribute name '
|
||||
'(`{name}`). If using a decorator, ensure the inner function is '
|
||||
'decorated with `functools.wraps`, or that `{func.__name__}.__name__` '
|
||||
'is otherwise set to `{name}`.').format(func=func, name=name)
|
||||
return func
|
||||
|
||||
|
||||
class ViewSetMixin:
|
||||
"""
|
||||
This is the magic.
|
||||
|
@ -164,7 +173,9 @@ class ViewSetMixin:
|
|||
"""
|
||||
Get the methods that are marked as an extra ViewSet `@action`.
|
||||
"""
|
||||
return [method for _, method in getmembers(cls, _is_extra_action)]
|
||||
return [_check_attr_name(method, name)
|
||||
for name, method
|
||||
in getmembers(cls, _is_extra_action)]
|
||||
|
||||
def get_extra_action_url_map(self):
|
||||
"""
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
from collections import OrderedDict
|
||||
from functools import wraps
|
||||
|
||||
import pytest
|
||||
from django.conf.urls import include, url
|
||||
|
@ -33,6 +34,13 @@ class Action(models.Model):
|
|||
pass
|
||||
|
||||
|
||||
def decorate(fn):
|
||||
@wraps(fn)
|
||||
def wrapper(self, request, *args, **kwargs):
|
||||
return fn(self, request, *args, **kwargs)
|
||||
return wrapper
|
||||
|
||||
|
||||
class ActionViewSet(GenericViewSet):
|
||||
queryset = Action.objects.all()
|
||||
|
||||
|
@ -68,6 +76,16 @@ class ActionViewSet(GenericViewSet):
|
|||
def unresolvable_detail_action(self, request, *args, **kwargs):
|
||||
raise NotImplementedError
|
||||
|
||||
@action(detail=False)
|
||||
@decorate
|
||||
def wrapped_list_action(self, request, *args, **kwargs):
|
||||
raise NotImplementedError
|
||||
|
||||
@action(detail=True)
|
||||
@decorate
|
||||
def wrapped_detail_action(self, request, *args, **kwargs):
|
||||
raise NotImplementedError
|
||||
|
||||
|
||||
class ActionNamesViewSet(GenericViewSet):
|
||||
|
||||
|
@ -191,6 +209,8 @@ class GetExtraActionsTests(TestCase):
|
|||
'detail_action',
|
||||
'list_action',
|
||||
'unresolvable_detail_action',
|
||||
'wrapped_detail_action',
|
||||
'wrapped_list_action',
|
||||
]
|
||||
|
||||
self.assertEqual(actual, expected)
|
||||
|
@ -204,9 +224,35 @@ class GetExtraActionsTests(TestCase):
|
|||
'detail_action',
|
||||
'list_action',
|
||||
'unresolvable_detail_action',
|
||||
'wrapped_detail_action',
|
||||
'wrapped_list_action',
|
||||
]
|
||||
self.assertEqual(actual, expected)
|
||||
|
||||
def test_attr_name_check(self):
|
||||
def decorate(fn):
|
||||
def wrapper(self, request, *args, **kwargs):
|
||||
return fn(self, request, *args, **kwargs)
|
||||
return wrapper
|
||||
|
||||
class ActionViewSet(GenericViewSet):
|
||||
queryset = Action.objects.all()
|
||||
|
||||
@action(detail=False)
|
||||
@decorate
|
||||
def wrapped_list_action(self, request, *args, **kwargs):
|
||||
raise NotImplementedError
|
||||
|
||||
view = ActionViewSet()
|
||||
with pytest.raises(AssertionError) as excinfo:
|
||||
view.get_extra_actions()
|
||||
|
||||
assert str(excinfo.value) == (
|
||||
'Expected function (`wrapper`) to match its attribute name '
|
||||
'(`wrapped_list_action`). If using a decorator, ensure the inner '
|
||||
'function is decorated with `functools.wraps`, or that '
|
||||
'`wrapper.__name__` is otherwise set to `wrapped_list_action`.')
|
||||
|
||||
|
||||
@override_settings(ROOT_URLCONF='tests.test_viewsets')
|
||||
class GetExtraActionUrlMapTests(TestCase):
|
||||
|
@ -218,6 +264,7 @@ class GetExtraActionUrlMapTests(TestCase):
|
|||
expected = OrderedDict([
|
||||
('Custom list action', 'http://testserver/api/actions/custom_list_action/'),
|
||||
('List action', 'http://testserver/api/actions/list_action/'),
|
||||
('Wrapped list action', 'http://testserver/api/actions/wrapped_list_action/'),
|
||||
])
|
||||
|
||||
self.assertEqual(view.get_extra_action_url_map(), expected)
|
||||
|
@ -229,6 +276,7 @@ class GetExtraActionUrlMapTests(TestCase):
|
|||
expected = OrderedDict([
|
||||
('Custom detail action', 'http://testserver/api/actions/1/custom_detail_action/'),
|
||||
('Detail action', 'http://testserver/api/actions/1/detail_action/'),
|
||||
('Wrapped detail action', 'http://testserver/api/actions/1/wrapped_detail_action/'),
|
||||
# "Unresolvable detail action" excluded, since it's not resolvable
|
||||
])
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user