From e4067bfb75a38851ea865719ebfbb65708187b4e Mon Sep 17 00:00:00 2001
From: Tom Christie <tom@tomchristie.com>
Date: Thu, 2 May 2013 12:07:18 +0100
Subject: [PATCH] introduce lookup_field and add pendingdeprecationwarnings
---
rest_framework/mixins.py | 13 +++++++++++--
rest_framework/relations.py | 10 ++++++++++
2 files changed, 21 insertions(+), 2 deletions(-)
diff --git a/rest_framework/mixins.py b/rest_framework/mixins.py
index ec751e24b..ae703771d 100644
--- a/rest_framework/mixins.py
+++ b/rest_framework/mixins.py
@@ -12,7 +12,7 @@ from rest_framework.response import Response
from rest_framework.request import clone_request
-def _get_validation_exclusions(obj, pk=None, slug_field=None):
+def _get_validation_exclusions(obj, pk=None, slug_field=None, lookup_field=None):
"""
Given a model instance, and an optional pk and slug field,
return the full list of all other field names on that model.
@@ -23,14 +23,19 @@ def _get_validation_exclusions(obj, pk=None, slug_field=None):
include = []
if pk:
+ # Pending deprecation
pk_field = obj._meta.pk
while pk_field.rel:
pk_field = pk_field.rel.to._meta.pk
include.append(pk_field.name)
if slug_field:
+ # Pending deprecation
include.append(slug_field)
+ if lookup_field and lookup_field != 'pk':
+ include.append(lookup_field)
+
return [field.name for field in obj._meta.fields if field.name not in include]
@@ -139,10 +144,14 @@ class UpdateModelMixin(object):
Set any attributes on the object that are implicit in the request.
"""
# pk and/or slug attributes are implicit in the URL.
+ lookup = self.kwargs.get(self.lookup_field, None)
pk = self.kwargs.get(self.pk_url_kwarg, None)
slug = self.kwargs.get(self.slug_url_kwarg, None)
slug_field = slug and self.slug_field or None
+ if lookup:
+ setattr(obj, self.lookup_field, lookup)
+
if pk:
setattr(obj, 'pk', pk)
@@ -152,7 +161,7 @@ class UpdateModelMixin(object):
# Ensure we clean the attributes so that we don't eg return integer
# pk using a string representation, as provided by the url conf kwarg.
if hasattr(obj, 'full_clean'):
- exclude = _get_validation_exclusions(obj, pk, slug_field)
+ exclude = _get_validation_exclusions(obj, pk, slug_field, self.lookup_field)
obj.full_clean(exclude)
diff --git a/rest_framework/relations.py b/rest_framework/relations.py
index 6d8deec1b..bc7f112cb 100644
--- a/rest_framework/relations.py
+++ b/rest_framework/relations.py
@@ -314,6 +314,16 @@ class HyperlinkedRelatedField(RelatedField):
self.format = kwargs.pop('format', None)
# These are pending deprecation
+ if 'pk_url_kwarg' in kwargs:
+ msg = 'pk_url_kwarg is pending deprecation. Use lookup_field instead.'
+ warnings.warn(msg, PendingDeprecationWarning, stacklevel=2)
+ if 'slug_url_kwarg' in kwargs:
+ msg = 'slug_url_kwarg is pending deprecation. Use lookup_field instead.'
+ warnings.warn(msg, PendingDeprecationWarning, stacklevel=2)
+ if 'slug_field' in kwargs:
+ msg = 'slug_field is pending deprecation. Use lookup_field instead.'
+ warnings.warn(msg, PendingDeprecationWarning, stacklevel=2)
+
self.pk_url_kwarg = kwargs.pop('pk_url_kwarg', self.pk_url_kwarg)
self.slug_field = kwargs.pop('slug_field', self.slug_field)
default_slug_kwarg = self.slug_url_kwarg or self.slug_field