Changeset 12516

Timestamp:

27 Jan 2015, 08:31:34 (10 years ago)

Author:

Henrik Bettermann

Message:

Export datasets of selected items specified by a list of identifiers. Will be used in students and applicants modules.

Location:

main/waeup.kofa/trunk/src/waeup/kofa

Files:

• browser/pages.py (modified) (1 diff)
• interfaces.py (modified) (2 diffs)
• utils/batching.py (modified) (3 diffs)
• utils/tests/test_batching.py (modified) (3 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/browser/pages.py

@@ -211 +211 @@
         exporter = getUtility(ICSVExporter, name=exporter_name)
         exporter_title = getattr(exporter, 'title', 'Unknown')
-        args = ', '.join(['%s=%s' % (item[0], item[1])
-            for item in job.kwargs.items()])
+        if not job.kwargs.has_key('selected'):
+            args = ', '.join(['%s=%s' % (item[0], item[1])
+                for item in job.kwargs.items()])
+        else:
+            args = 'selection'
         status = job.finished and 'ready' or 'running'
         status = job.failed and 'FAILED' or status

main/waeup.kofa/trunk/src/waeup/kofa/interfaces.py

@@ -344 +344 @@
         """
 
+    def get_selected(site, selected):
+        """Get datasets in `site` to be exported.
+
+        The set of data is specified by a list of identifiers.
+
+        Returns an iterable.
+        """
+
     def export(iterable, filepath=None):
         """Export iterables as rows in a CSV file.
@@ -369 +377 @@
         Which special keywords are supported is up to the respective
         exporter.
+        """
+
+    def export_selected(site, filepath=None, **kw):
+        """Export items in `site` specified by a list of identifiers
+        called `selected`.
+
+        If `filepath` is not given, a string with the data should be
+        returned.
         """
 

main/waeup.kofa/trunk/src/waeup/kofa/utils/batching.py

@@ -497 +497 @@
         raise NotImplementedError
 
+    def get_selected(self, site, selected):
+        """Get datasets to export for selected items
+        specified by a list of identifiers.
+
+        Returns an iterable.
+        """
+        raise NotImplementedError
+
     def export(self, iterable, filepath=None):
         """Export `iterable` as CSV file.
@@ -521 +529 @@
         """
         data = self.get_filtered(site, **kw)
+        return self.export(data, filepath=filepath)
+
+    def export_selected(self, site, filepath=None, **kw):
+        """Export those items specified by a list of identifiers
+        called `selected`.
+
+        If `filepath` is ``None``, a raw string with CSV data should
+        be returned.
+        """
+        selected = kw.get('selected', [])
+        data = self.get_selected(site, selected)
         return self.export(data, filepath=filepath)
 
@@ -551 +570 @@
     if kw == {}:
         exporter.export_all(site, filepath=output_path)
+    elif kw.has_key('selected'):
+        exporter.export_selected(site, filepath=output_path, **kw)
     else:
         exporter.export_filtered(site, filepath=output_path, **kw)

main/waeup.kofa/trunk/src/waeup/kofa/utils/tests/test_batching.py

@@ -342 +342 @@
         # we can pass in positional and keyword args
         exporter = ExporterBase()
-        writer, outfile = exporter.get_csv_writer(filepath=self.workfile)
         self.assertRaises(NotImplementedError, exporter.export_filtered,
                           'foo', bar='bar')
+
+    def test_export_selected(self):
+        # we can pass in a list of identifiers
+        exporter = ExporterBase()
+        self.assertRaises(NotImplementedError, exporter.export_selected,
+                          'foo', selected=[])
         return
 
@@ -360 +365 @@
     def export_filtered(self, site, filepath=None, foo=None, bar=None):
         if foo or bar:
+            open(filepath, 'wb').write(SAMPLE_FILTERED_DATA)
+            return
+        self.export_all(site, filepath=filepath)
+        return
+
+    def export_selected(self, site, filepath=None, selected=None):
+        if selected:
             open(filepath, 'wb').write(SAMPLE_FILTERED_DATA)
             return
@@ -399 +411 @@
         # we export filtered sets
         result_path = export_job(None, 'cave_exporter', foo='foo')
+        contents = open(result_path, 'rb').read()
+        shutil.rmtree(os.path.dirname(result_path))
+        self.assertEqual(contents, SAMPLE_FILTERED_DATA)
+        return
+
+    def test_export_job_selected(self):
+        # we export subsets
+        result_path = export_job(None, 'cave_exporter', selected=['foo'])
         contents = open(result_path, 'rb').read()
         shutil.rmtree(os.path.dirname(result_path))