outputdir is a standard parameter on StandardWorkflowComponent as wel…

…l as Task

README.rst

@@ -376,8 +376,9 @@ everything.
             #always return the last task(s)
             return ucto
 
+------------------------------------
 Dynamic dependencies aka Inception
------------------------------------
+------------------------------------
 
 Workflows are static in the sense that based on the format of the input file
 and all given parameters, all workflow components and tasks are assembled
@@ -454,14 +455,10 @@ won't result in parallisation, you must really yield an entire list (or tuple).
 Note that we added an ``outputdir`` parameter to the Ucto component which we
 hadn't implemented yet. This is necessary to ensure all individual output files
 end up in the directory that groups our output. The Ucto component should
-simply pass this parameter on to the ``Ucto_txt2tok`` task, and there we
-just add it as an optional parameter as follows. The ``outputfrominput()``
-method automatically supports this parameter.
-
-.. code-block:: python
-
-    class Ucto_txt2tok(Task):
-        outputdir = Parameter(default="")
+simply pass this parameter on to the ``Ucto_txt2tok`` task. The outputdir
+parameter is implicitly present on all tasks as well as on
+``StandardWorkflowComponent``, the ``outputfrominput()`` method automatically
+supports this parameter.
 
 Assuming you have a collecting of text files in a directory ``corpus.txtdir/``,
 you can now invoke LuigiNLP as follows and end up with a ``corpus.tokdir/``

luiginlp/engine.py

@@ -328,6 +328,7 @@ class StandardWorkflowComponent(WorkflowComponent):
     """A workflow component that takes one inputfile"""
 
     inputfile = luigi.Parameter()
+    outputdir = luigi.Parameter(default="")
 
 class TargetInfo(sciluigi.TargetInfo):
     pass

luiginlp/modules/ocr.py

@@ -15,7 +15,6 @@ class Tesseract(Task):
     executable = 'tesseract'
 
     language = Parameter()
-    outputdir = Parameter(default="")
 
     in_tiff = None #input slot
 
@@ -32,7 +31,6 @@ def run(self):
 class OCR_singlepage(StandardWorkflowComponent):
     language = Parameter()
     tiff_extension=Parameter(default='tif')
-    outputdir = Parameter(default="")
 
     def autosetup(self):
         return Tesseract

luiginlp/modules/ucto.py

@@ -49,8 +49,6 @@ class Ucto_folia2folia(Task):
     #Parameters for this module (all mandatory!)
     language = Parameter()
 
-    #Optional parameter
-    outputdir = Parameter(default="")
 
     in_folia = None #will be linked to an out_* slot of another module in the workflow specification
 
@@ -76,7 +74,6 @@ class Ucto(StandardWorkflowComponent):
     language = Parameter()
     tok_input_sentenceperline = BoolParameter(default=False)
     tok_output_sentenceperline = BoolParameter(default=False)
-    outputdir = Parameter(default="")
 
     def autosetup(self):
         return (Ucto_txt2folia, Ucto_folia2folia)
@@ -136,7 +133,6 @@ class Ucto_dir(StandardWorkflowComponent):
     language = Parameter()
     tok_input_sentenceperline = BoolParameter(default=False)
     tok_output_sentenceperline = BoolParameter(default=False)
-    outputdir = Parameter(default="")
 
     def autosetup(self):
         return (Ucto_txt2folia_dir, Ucto_folia2folia_dir)