added guards for arguments name clashes with 'function', 'executable', 'constructor'

Author: tclose

pydra/design/python.py

@@ -159,6 +159,11 @@ def make(wrapped: ty.Callable | type) -> PythonDef:
                 input_helps=input_helps,
                 output_helps=output_helps,
             )
+        if "function" in parsed_inputs:
+            raise ValueError(
+                "The argument 'function' is reserved for a field to hold the function "
+                "to be wrapped"
+            )
 
         parsed_inputs["function"] = arg(
             name="function", type=ty.Callable, default=function, hash_eq=True

pydra/design/shell.py

@@ -383,6 +383,12 @@ def make(
                 {n: getattr(ShellOutputs, n) for n in ShellOutputs.BASE_NAMES}
             )
 
+        if "executable" in parsed_inputs:
+            raise ValueError(
+                "The argument 'executable' is reserved for a field to hold the command "
+                "to be run"
+            )
+
         # Update the inputs (overriding inputs from base classes) with the executable
         # and the output argument fields
         parsed_inputs.update(

pydra/design/tests/test_python.py

@@ -33,6 +33,15 @@ def func(a: int) -> float:
         SampleDef(a=1.5)
 
 
+def test_function_arg_fail():
+
+    with pytest.raises(ValueError, match="The argument 'function' is reserved"):
+
+        @python.define
+        def func(function: ty.Callable) -> ty.Callable:
+            return function
+
+
 def test_interface_wrap_function_with_default():
     def func(a: int, k: float = 2.0) -> float:
         """Sample function with inputs and outputs"""

pydra/design/tests/test_shell.py

@@ -66,6 +66,13 @@ def test_interface_template():
     Cp.Outputs(out_path=File.mock("in-path.txt"))
 
 
+def test_executable_arg_fail():
+
+    with pytest.raises(ValueError, match="The argument 'executable' is reserved"):
+
+        shell.define("my-cmd <executable>")
+
+
 def test_interface_template_w_types_and_path_template_ext():
 
     TrimPng = shell.define("trim-png <in_image:image/png> <out|out_image:image/png>")

pydra/design/tests/test_workflow.py

@@ -1,6 +1,7 @@
 from operator import attrgetter
 from copy import copy
 from unittest.mock import Mock
+import pytest
 import attrs
 from pydra.engine.lazy import LazyInField, LazyOutField
 import typing as ty
@@ -74,6 +75,15 @@ def MyTestWorkflow(a, b):
     assert list(wf.node_names) == ["Add", "Mul"]
 
 
+def test_constructor_arg_fail():
+
+    with pytest.raises(ValueError, match="The argument 'constructor' is reserved"):
+
+        @workflow.define
+        def MyTestWorkflow(constructor: ty.Callable) -> ty.Callable:
+            return constructor
+
+
 def test_shell_workflow():
 
     @workflow.define(outputs=["output_video"])

pydra/design/workflow.py

@@ -169,6 +169,12 @@ def make(wrapped: ty.Callable | type) -> TaskDef:
                 output_helps=output_helps,
             )
 
+        if "constructor" in parsed_inputs:
+            raise ValueError(
+                "The argument 'constructor' is reserved and cannot be used as an "
+                "argument name"
+            )
+
         parsed_inputs["constructor"] = arg(
             name="constructor", type=ty.Callable, hash_eq=True, default=constructor
         )