[PATCH v2 04/13] REST: Make use of the 'source' property

Stephen Finucane stephen at that.guru
Sun Nov 20 03:51:19 AEDT 2016


This is apparently the correct way to rename fields, and will ensure a
future API version that supports writes will work correctly.

Signed-off-by: Stephen Finucane <stephen at that.guru>
Cc: Andy Doan <andy.doan at linaro.org>
---
 patchwork/api/project.py | 15 +++++++--------
 1 file changed, 7 insertions(+), 8 deletions(-)

diff --git a/patchwork/api/project.py b/patchwork/api/project.py
index 17f4b3c..9e5d2aa 100644
--- a/patchwork/api/project.py
+++ b/patchwork/api/project.py
@@ -17,6 +17,7 @@
 # along with Patchwork; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
+from rest_framework.serializers import CharField
 from rest_framework.serializers import HyperlinkedModelSerializer
 
 from patchwork.api import PatchworkPermission
@@ -25,17 +26,15 @@ from patchwork.models import Project
 
 
 class ProjectSerializer(HyperlinkedModelSerializer):
-    def to_representation(self, instance):
-        data = super(ProjectSerializer, self).to_representation(instance)
-        data['link_name'] = data.pop('linkname')
-        data['list_email'] = data.pop('listemail')
-        data['list_id'] = data.pop('listid')
-        return data
+    # TODO(stephenfin): These should be renamed at the model layer
+    link_name = CharField(max_length=255, source='linkname')
+    list_id = CharField(max_length=255, source='listid')
+    list_email = CharField(max_length=255, source='listemail')
 
     class Meta:
         model = Project
-        fields = ('url', 'name', 'linkname', 'listid', 'listemail', 'web_url',
-                  'scm_url', 'webscm_url')
+        fields = ('url', 'name', 'link_name', 'list_id', 'list_email',
+                  'web_url', 'scm_url', 'webscm_url')
 
 
 class ProjectViewSet(PatchworkViewSet):
-- 
2.7.4



More information about the Patchwork mailing list