Commit 8acee2e6 by Tom Christie

Commenting link/action decorators as pending deprecation

parent 4292cc18
...@@ -108,53 +108,54 @@ def permission_classes(permission_classes): ...@@ -108,53 +108,54 @@ def permission_classes(permission_classes):
return decorator return decorator
def link(**kwargs): def detail_route(methods=['get'], **kwargs):
""" """
Used to mark a method on a ViewSet that should be routed for detail GET requests. Used to mark a method on a ViewSet that should be routed for detail requests.
""" """
msg = 'link is pending deprecation. Use detail_route instead.'
warnings.warn(msg, PendingDeprecationWarning, stacklevel=2)
def decorator(func): def decorator(func):
func.bind_to_methods = ['get'] func.bind_to_methods = methods
func.detail = True func.detail = True
func.kwargs = kwargs func.kwargs = kwargs
return func return func
return decorator return decorator
def action(methods=['post'], **kwargs): def list_route(methods=['get'], **kwargs):
""" """
Used to mark a method on a ViewSet that should be routed for detail POST requests. Used to mark a method on a ViewSet that should be routed for list requests.
""" """
msg = 'action is pending deprecation. Use detail_route instead.'
warnings.warn(msg, PendingDeprecationWarning, stacklevel=2)
def decorator(func): def decorator(func):
func.bind_to_methods = methods func.bind_to_methods = methods
func.detail = True func.detail = False
func.kwargs = kwargs func.kwargs = kwargs
return func return func
return decorator return decorator
# These are now pending deprecation, in favor of `detail_route` and `list_route`.
def detail_route(methods=['get'], **kwargs): def link(**kwargs):
""" """
Used to mark a method on a ViewSet that should be routed for detail requests. Used to mark a method on a ViewSet that should be routed for detail GET requests.
""" """
msg = 'link is pending deprecation. Use detail_route instead.'
warnings.warn(msg, PendingDeprecationWarning, stacklevel=2)
def decorator(func): def decorator(func):
func.bind_to_methods = methods func.bind_to_methods = ['get']
func.detail = True func.detail = True
func.kwargs = kwargs func.kwargs = kwargs
return func return func
return decorator return decorator
def list_route(methods=['get'], **kwargs): def action(methods=['post'], **kwargs):
""" """
Used to mark a method on a ViewSet that should be routed for list requests. Used to mark a method on a ViewSet that should be routed for detail POST requests.
""" """
msg = 'action is pending deprecation. Use detail_route instead.'
warnings.warn(msg, PendingDeprecationWarning, stacklevel=2)
def decorator(func): def decorator(func):
func.bind_to_methods = methods func.bind_to_methods = methods
func.detail = False func.detail = True
func.kwargs = kwargs func.kwargs = kwargs
return func return func
return decorator return decorator
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment