made task_fields return a dict-like object

Author: tclose

pydra/compose/base/helpers.py

@@ -74,8 +74,6 @@ def ensure_field_objects(
                 name=input_name,
                 help=input_helps.get(input_name, ""),
             )
-            if is_optional(arg):
-                inputs[input_name].default = None
         elif isinstance(arg, dict):
             arg_kwds = copy(arg)
             if "help" not in arg_kwds:

pydra/compose/tests/test_workflow.py

@@ -54,14 +54,14 @@ def MyTestWorkflow(a, b):
     # The constructor function is included as a part of the task so it is
     # included in the hash by default and can be overridden if needed. Not 100% sure
     # if this is a good idea or not
-    assert task_fields(MyTestWorkflow) == [
+    assert list(task_fields(MyTestWorkflow)) == [
         workflow.arg(name="a"),
         workflow.arg(name="b"),
         workflow.arg(
             name="constructor", type=ty.Callable, hash_eq=True, default=constructor
         ),
     ]
-    assert task_fields(MyTestWorkflow.Outputs) == [
+    assert list(task_fields(MyTestWorkflow.Outputs)) == [
         workflow.out(name="out"),
     ]
     workflow_spec = MyTestWorkflow(a=1, b=2.0)
@@ -115,15 +115,15 @@ def MyTestShellWorkflow(
 
     constructor = MyTestShellWorkflow().constructor
     assert constructor.__name__ == "MyTestShellWorkflow"
-    assert task_fields(MyTestShellWorkflow) == [
+    assert list(task_fields(MyTestShellWorkflow)) == [
         workflow.arg(name="input_video", type=video.Mp4),
         workflow.arg(name="watermark", type=image.Png),
         workflow.arg(name="watermark_dims", type=tuple[int, int], default=(10, 10)),
         workflow.arg(
             name="constructor", type=ty.Callable, hash_eq=True, default=constructor
         ),
     ]
-    assert task_fields(MyTestShellWorkflow.Outputs) == [
+    assert list(task_fields(MyTestShellWorkflow.Outputs)) == [
         workflow.out(name="output_video", type=video.Mp4),
     ]
     input_video = video.Mp4.mock("input.mp4")
@@ -178,7 +178,7 @@ class Outputs(workflow.Outputs):
             name="constructor", type=ty.Callable, hash_eq=True, default=constructor
         ),
     ]
-    assert task_fields(MyTestWorkflow.Outputs) == [
+    assert list(task_fields(MyTestWorkflow.Outputs)) == [
         workflow.out(name="out", type=float),
     ]
     workflow_spec = MyTestWorkflow(a=1, b=2.0)
@@ -301,7 +301,7 @@ def MyTestWorkflow(a: int, b: float) -> tuple[float, float]:
 
         return mul.out, divide.divided
 
-    assert task_fields(MyTestWorkflow) == [
+    assert list(task_fields(MyTestWorkflow)) == [
         workflow.arg(name="a", type=int, help="An integer input"),
         workflow.arg(name="b", type=float, help="A float input"),
         workflow.arg(
@@ -311,7 +311,7 @@ def MyTestWorkflow(a: int, b: float) -> tuple[float, float]:
             default=MyTestWorkflow().constructor,
         ),
     ]
-    assert task_fields(MyTestWorkflow.Outputs) == [
+    assert list(task_fields(MyTestWorkflow.Outputs)) == [
         workflow.out(name="out1", type=float, help="The first output"),
         workflow.out(name="out2", type=float, help="The second output"),
     ]
@@ -344,7 +344,7 @@ def MyTestWorkflow(a: int, b: float):
 
         # no return is used when the outputs are set directly
 
-    assert task_fields(MyTestWorkflow) == [
+    assert list(task_fields(MyTestWorkflow)) == [
         workflow.arg(name="a", type=int),
         workflow.arg(name="b", type=float),
         workflow.arg(
@@ -354,7 +354,7 @@ def MyTestWorkflow(a: int, b: float):
             default=MyTestWorkflow().constructor,
         ),
     ]
-    assert task_fields(MyTestWorkflow.Outputs) == [
+    assert list(task_fields(MyTestWorkflow.Outputs)) == [
         workflow.out(name="out1", type=float),
         workflow.out(name="out2", type=float),
     ]

pydra/engine/tests/test_functions.py

@@ -88,7 +88,7 @@ def Indirect(a):
     assert non_func_values(Direct(a=a)) == non_func_values(Indirect(a=a))
 
     # checking if the annotation is properly converted to output_spec if used in task
-    assert task_fields(Direct.Outputs)[0] == python.out(name="out", type=int)
+    assert task_fields(Direct.Outputs).out == python.out(name="out", type=int)
 
 
 def test_annotation_equivalence_2():
@@ -117,7 +117,7 @@ def Indirect(a) -> tuple[int, float]:
     assert hashes(Direct(a=a)) == hashes(Partial(a=a)) == hashes(Indirect(a=a))
 
     # checking if the annotation is properly converted to output_spec if used in task
-    assert task_fields(Direct.Outputs) == [
+    assert list(task_fields(Direct.Outputs)) == [
         python.out(name="out1", type=int),
         python.out(name="out2", type=float),
     ]
@@ -149,7 +149,7 @@ def Indirect(a):
     assert hashes(Direct(a=a)) == hashes(Partial(a=a)) == hashes(Indirect(a=a))
 
     # checking if the annotation is properly converted to output_spec if used in task
-    assert task_fields(Direct.Outputs)[0] == python.out(name="out1", type=int)
+    assert task_fields(Direct.Outputs).out1 == python.out(name="out1", type=int)
 
 
 def test_annotation_equivalence_4():
@@ -184,7 +184,7 @@ def Indirect(a):
     assert hashes(Direct(a=a)) == hashes(Partial(a=a)) == hashes(Indirect(a=a))
 
     # checking if the annotation is properly converted to output_spec if used in task
-    assert task_fields(Direct.Outputs) == [
+    assert list(task_fields(Direct.Outputs)) == [
         python.out(name="sum", type=int),
         python.out(name="sub", type=int),
     ]

pydra/engine/tests/test_shelltask.py

@@ -845,7 +845,7 @@ class Outputs(shell.Outputs):
 
     shelly = Shelly(
         executable=cmd,
-        newfile=File.mock("newfile_tmp.txt"),
+        newfile=tmp_path / "newfile_tmp.txt",
         time="02121010",
     )
 
@@ -884,7 +884,7 @@ class Outputs(shell.Outputs):
 
     shelly = Shelly(
         executable=cmd,
-        newfile=File.mock("newfile_tmp.txt"),
+        newfile=tmp_path / "newfile_tmp.txt",
         time="02121010",
     )
 
@@ -2682,7 +2682,7 @@ class Outputs(shell.Outputs):
     shelly = Shelly(
         executable=cmd,
     )
-    shelly.file1 = File.mock("new_file_1.txt")
+    shelly.file1 = tmp_path / "new_file_1.txt"
     assert get_output_names(shelly) == [
         "newfile1",
         "newfile2",

pydra/utils/general.py

@@ -320,17 +320,33 @@ def attrs_values(obj, **kwargs) -> dict[str, ty.Any]:
     }
 
 
-def task_fields(task: "type[Task] | Task") -> list["Field"]:
+class _TaskFieldsList(dict[str, "Field"]):
+    """A list of task fields. Acts like list in that you can iterate over the values
+    but also access them like a dict or by attribute."""
+
+    def __iter__(self):
+        return iter(self.values())
+
+    def __getattr__(self, name):
+        return self[name]
+
+    def __dir__(self):
+        return sorted(self.keys())
+
+
+def task_fields(task: "type[Task] | Task") -> _TaskFieldsList:
     """List the fields of a task"""
     if not inspect.isclass(task):
         task = type(task)
     if not attrs.has(task):
-        return []
-    return [
-        f.metadata[PYDRA_ATTR_METADATA]
-        for f in attrs.fields(task)
-        if PYDRA_ATTR_METADATA in f.metadata
-    ]
+        return _TaskFieldsList()
+    return _TaskFieldsList(
+        **{
+            f.name: f.metadata[PYDRA_ATTR_METADATA]
+            for f in attrs.fields(task)
+            if PYDRA_ATTR_METADATA in f.metadata
+        }
+    )
 
 
 def fields_values(obj, **kwargs) -> dict[str, ty.Any]: