Changeset 9091 for main/waeup.kofa/branches/uli-zc-async/src/waeup/kofa

Timestamp:

8 Aug 2012, 14:07:26 (12 years ago)

Author:

uli

Message:

Add docs.

File:

• main/waeup.kofa/branches/uli-zc-async/src/waeup/kofa/utils/batching.py (modified) (1 diff)

main/waeup.kofa/branches/uli-zc-async/src/waeup/kofa/utils/batching.py

@@ -520 +520 @@
 
 class AsyncExportJob(AsyncJob):
-
+    """An IJob that exports data to CSV files.
+
+    `AsyncExportJob` instances are regular `AsyncJob` instances with a
+    different constructor API. Instead of a callable to execute, you
+    must pass a `site` and some `exporter_name` to trigger an export.
+
+    The real work is done when an instance of this class is put into a
+    queue. See :mod:`waeup.kofa.async` to learn more about
+    asynchronous jobs.
+
+    The `exporter_name` must be the name under which an ICSVExporter
+    utility was registered with the ZCA.
+
+    The `site` must be a valid site  or ``None``.
+
+    The result of an `AsyncExportJob` is the path to generated CSV
+    file. The file will reside in a temporary directory that should be
+    removed after being used.
+    """
     def __init__(self, site, exporter_name):
         super(AsyncExportJob, self).__init__(