Changeset 9816

Timestamp:

21 Dec 2012, 13:09:05 (12 years ago)

Author:

Henrik Bettermann

Message:

Extend IExportJob so that AsyncExportJobs? unveil their status like AsyncReportJobs? do. Use this property attribute to hide buttons.

Location:

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

Files:

• interfaces.py (modified) (1 diff)
• students/browser.py (modified) (1 diff)
• utils/batching.py (modified) (2 diffs)

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

@@ -1185 +1185 @@
         pass
 
+    finished = schema.Bool(
+        title = u'`True` if the job finished.`',
+        default = False,
+        )
+
+    failed = schema.Bool(
+        title = u"`True` iff the job finished and didn't provide a file.",
+        default = None,
+        )
+
 class IExportJobContainer(IKofaObject):
     """A component that contains (maybe virtually) export jobs.

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

@@ -2671 +2671 @@
             # XXX: Descr. should be improved
             descr = '%r, %r' % (job.args[1:], job.kwargs)
-
-            # XXX: status should be replaced by 'ready', 'running' or 'FAILED'
-            # like in w.k.browser.reports ...
-            status = job.status
-            # ... and buttons should be displayed accordingly
-            show_download_button = True
-            show_discard_button = True
-            show_refresh_button = True
-
-
+            status = job.finished and 'ready' or 'running'
+            status = job.failed and 'FAILED' or status
+            show_download_button = job.finished and not job.failed
+            show_discard_button = job.finished
+            show_refresh_button = not job.finished
             start_time = getattr(job, 'begin_after', None)
             if start_time:

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

@@ -28 +28 @@
 import tempfile
 import time
+import zc.async.interfaces
 from cStringIO import StringIO
 from persistent.list import PersistentList
@@ -571 +572 @@
             export_job, site, exporter_name, *args, **kwargs)
 
+    @property
+    def finished(self):
+        """A job is marked `finished` if it is completed.
+
+        Please note: a finished report job does not neccessarily
+        provide an IReport result. See meth:`failed`.
+        """
+        return self.status == zc.async.interfaces.COMPLETED
+
+    @property
+    def failed(self):
+        """A report job is marked failed iff it is finished and the
+        result is None.
+
+        While a job is unfinished, the `failed` status is ``None``.
+
+        Failed jobs normally provide a `traceback` to examine reasons.
+        """
+        if not self.finished:
+            return None
+        if getattr(self, 'result', None) is None:
+            return True
+        return False
+
 class ExportJobContainer(object):
     """A mix-in that provides functionality for asynchronous export jobs.