better error messages in case of unsatisfied steps

CompNet · Jul 2, 2024 · 5e0ae71 · 5e0ae71
1 parent b50f6e6
commit 5e0ae71
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git a/docs/pipeline.rst b/docs/pipeline.rst
@@ -68,7  68,7 @@ In that case, the ``tokens`` requirements is fulfilled at run time. If
 you don't pass the parameter, Renard will throw the following
 exception:
 
->>> ValueError: ["step 1 (NLTKNamedEntityRecognizer) has unsatisfied needs (needs : {'tokens'}, available : {'text'})"]
 >>> ValueError: ["step 1 (NLTKNamedEntityRecognizer) has unsatisfied needs. needs: {'tokens'}. available: {'text'}). missing: {'tokens'}."]
 
 
 For simplicity, one can use one of the preconfigured pipelines:

diff --git a/renard/pipeline/core.py b/renard/pipeline/core.py
@@ -632,13  632,27 @@ def check_valid(
                 return (
                     False,
                     [
-                        f"step {i   1} ({step.__class__.__name__}) has unsatisfied needs (needs : {step.needs()}, available : {pipeline_state})"
                         "".join(
                             [
                                 f"step {i   1} ({step.__class__.__name__}) has unsatisfied needs. "
                                   f"needs: {step.needs()}. "
                                   f"available: {pipeline_state}). "
                                   f"missing: {step.needs() - pipeline_state}."
                             ]
                         ),
                     ],
                 )
 
             if not step.optional_needs().issubset(pipeline_state):
                 warnings.append(
-                    f"step {i   1} ({step.__class__.__name__}) has unsatisfied optional needs : (optional needs : {step.optional_needs()}, available : {pipeline_state})"
                     "".join(
                         [
                             f"step {i   1} ({step.__class__.__name__}) has unsatisfied optional needs. "
                               f"needs: {step.optional_needs.needs()}. "
                               f"available: {pipeline_state}). "
                               f"missing: {step.optional_needs() - pipeline_state}."
                         ]
                     )
                 )
 
             pipeline_state = pipeline_state.union(step.production())