Merge branch 'fix-bug-is-fairworkflows-decorator' of github.com:fair-workflows/fairworkflows into use-noodles-from-call

Author: svenvanderburg

fairworkflows/fairworkflow.py

@@ -519,10 +519,8 @@ def _modify_function(func):
         num_params = len(inspect.signature(func).parameters)
         empty_args = ([inspect.Parameter.empty()] * num_params)
         workflow_level_promise = scheduled_workflow(*empty_args)
+        _validate_decorated_function(func, empty_args)
         step_level_promise = func(*empty_args)
-        if not isinstance(step_level_promise, PromisedObject):
-            raise TypeError("The workflow does not return a 'promise'. Did you use the "
-                            "is_fairstep decorator on all the steps?")
 
         # Description of workflow is the raw function code
         description = inspect.getsource(func)
@@ -531,3 +529,22 @@ def _modify_function(func):
             is_pplan_plan=is_pplan_plan, derived_from=None)
         return workflow_level_promise
     return _modify_function
+
+
+def _validate_decorated_function(func, empty_args):
+    """
+    Validate that a function decorated with is_fairworkflow actually consists of steps that are
+    decorated with is_fairstep. Call the function using empty arguments to test. NB: This won't
+    catch all edgecases of users misusing the is_fairworkflow decorator, but at least will
+    provide more useful error messages in frequently occurring cases.
+    """
+    try:
+        result = func(*empty_args)
+    except TypeError as e:
+        raise TypeError("Marking the function as workflow with `is_fairworkflow` decorator "
+                        "failed. "
+                        "Did you use the is_fairstep decorator on all the steps? "
+                        f"Detailed error message: {e}")
+    if not isinstance(result, PromisedObject):
+        raise TypeError("The workflow does not return a 'promise'. Did you use the "
+                        "is_fairstep decorator on all the steps?")

tests/test_fairworkflow.py

@@ -386,3 +386,24 @@ def my_workflow(in1):
                 """
                 return return_value(in1)
         assert "The workflow does not return a 'promise'" in str(e.value)
+
+    def test_workflow_mixed_decorated_steps(self):
+        def add(a: float, b: float) -> float:
+            """Adding up numbers. NB: no is_fairstep decorator!"""
+            return a + b
+
+        @is_fairstep(label='Subtraction')
+        def sub(a: float, b: float) -> float:
+            """Subtracting numbers."""
+            return a - b
+
+        with pytest.raises(TypeError) as e:
+            @is_fairworkflow(label='My Workflow')
+            def my_workflow(in1, in2):
+                """
+                A simple addition, subtraction workflow
+                """
+                return add(in1, sub(in2, in2))
+        assert ("Marking the function as workflow with `is_fairworkflow` decorator failed. "
+                in str(e.value))
+        assert "unsupported operand type(s)" in str(e.value)