option to hide serializer from list

Author: sheppard

data_wizard/loaders.py

@@ -18,12 +18,16 @@ def content_object(self):
         return obj
 
     def load_io_options(self):
-        serializer = self.run.get_serializer()
-        return getattr(serializer.Meta, 'data_wizard', {})
+        return {
+            key: val
+            for key, val in self.run.get_serializer_options().items()
+            if key in self.valid_options
+        }
 
 
 class FileLoader(BaseLoader):
     file_attr = 'file'
+    valid_options = {'header_row', 'start_row'}
 
     @property
     def file(self):
@@ -37,6 +41,7 @@ def load_io(self):
 
 class URLLoader(BaseLoader):
     url_attr = 'url'
+    valid_options = {'header_row', 'start_row'}
 
     @property
     def url(self):

data_wizard/models.py

@@ -74,6 +74,12 @@ def get_serializer(self):
         else:
             raise Exception("No serializer specified!")
 
+    def get_serializer_options(self):
+        if self.serializer:
+            return registry.get_serializer_options(self.serializer)
+        else:
+            raise Exception("No serializer specified!")
+
     def already_parsed(self):
         return self.range_set.count()
 

data_wizard/registry.py

@@ -62,6 +62,7 @@ def get_serializers(self):
                 'name': name,
                 'serializer': serializer,
                 'class_name': self.get_class_name(serializer),
+                'options': self.get_serializer_options(name),
             })
         return serializers
 
@@ -76,6 +77,14 @@ def get_serializer(self, name):
             )
         return self._serializers[name]
 
+    def get_serializer_options(self, name):
+        serializer = self.get_serializer(name)
+        meta = getattr(serializer, 'Meta', None)
+        if not meta:
+            return {}
+        options = getattr(meta, 'data_wizard', {})
+        return options
+
     def get_choices(self):
         return [
             (s['class_name'], s['name'])

data_wizard/views.py

@@ -84,10 +84,13 @@ def retrieve_and_run(self, task_name, use_async=False, post=None):
     @detail_route()
     def serializers(self, request, *args, **kwargs):
         response = self.retrieve(request, **self.kwargs)
-        response.data['serializer_choices'] = [{
-            'name': s['class_name'],
-            'label': s['name'],
-        } for s in registry.get_serializers()]
+        response.data['serializer_choices'] = [
+            {
+                'name': s['class_name'],
+                'label': s['name'],
+            } for s in registry.get_serializers()
+            if s['options'].get('show_in_list', True)
+        ]
         return response
 
     @detail_route(methods=['post'])

tests/data_app/wizard.py

@@ -12,6 +12,9 @@ class IncompleteSerializer(serializers.ModelSerializer):
     class Meta:
         model = SimpleModel
         fields = "__all__"
+        data_wizard = {
+            'show_in_list': False,
+        }
 
 
 class SlugSerializer(serializers.ModelSerializer):

tests/test_simple_import.py

@@ -194,3 +194,21 @@ def check_data(self, run):
             " correct format (YYYY-MM-DD) but it is an invalid date.\"])"
         ])
         self.assert_urls(run, 'simplemodels/%s')
+
+
+class SerializerTestCase(BaseImportTestCase):
+    def test_serializer_list(self):
+        run = self.upload_file('simplemodel.csv', skip_serializer=True)
+        result = self.get_url(run, 'serializers')
+        choices = {
+            row['name']: row['label']
+            for row in result.data['serializer_choices']
+        }
+        self.assertIn(
+            'tests.data_app.wizard.SlugSerializer',
+            choices,
+        )
+        self.assertNotIn(
+            'tests.data_app.wizard.IncompleteSerializer',
+            choices,
+        )