renamed list_fields to task_fields

Author: tclose

pydra/_version.py

@@ -5,7 +5,7 @@
 from attrs.converters import default_if_none
 from fileformats.generic import File, FileSet
 from pydra.utils.typing import TypeParser, is_optional, is_type
-from pydra.utils.general import list_fields
+from pydra.utils.general import task_fields
 import attrs
 
 if ty.TYPE_CHECKING:
@@ -65,7 +65,7 @@ class Requirement:
     def satisfied(self, inputs: "Task") -> bool:
         """Check if the requirement is satisfied by the inputs"""
         value = getattr(inputs, self.name)
-        field = {f.name: f for f in list_fields(inputs)}[self.name]
+        field = {f.name: f for f in task_fields(inputs)}[self.name]
         if value is None or field.type is bool and value is False:
             return False
         if self.allowed_values is None:

pydra/compose/base/field.py

@@ -4,7 +4,7 @@
 import re
 from copy import copy
 from pydra.utils.typing import is_type
-from pydra.utils.general import list_fields
+from pydra.utils.general import task_fields
 from .field import Field, Arg, Out, NO_DEFAULT
 
 
@@ -399,7 +399,7 @@ def get_fields(klass, field_type, auto_attribs, helps) -> dict[str, Field]:
         """Get the fields from a class"""
         fields_dict = {}
         # Get fields defined in base classes if present
-        for field in list_fields(klass):
+        for field in task_fields(klass):
             if field.name not in skip_fields:
                 fields_dict[field.name] = field
         type_hints = ty.get_type_hints(klass)

pydra/compose/base/helpers.py

@@ -5,7 +5,7 @@
 from typing import Self
 import attrs.validators
 from pydra.utils.typing import is_optional, is_fileset_or_union
-from pydra.utils.general import list_fields
+from pydra.utils.general import task_fields
 from pydra.utils.typing import StateArray, is_lazy
 from pydra.utils.hash import hash_function
 import os
@@ -120,18 +120,18 @@ def __getitem__(self, name_or_index: str | int) -> ty.Any:
     def __eq__(self, other: ty.Any) -> bool:
         """Check if two tasks are equal"""
         values = attrs.asdict(self)
-        fields = list_fields(self)
+        fields = task_fields(self)
         try:
             other_values = attrs.asdict(other)
         except AttributeError:
             return False
         try:
-            other_fields = list_fields(other)
+            other_fields = task_fields(other)
         except AttributeError:
             return False
         if fields != other_fields:
             return False
-        for field in list_fields(self):
+        for field in task_fields(self):
             if field.hash_eq:
                 values[field.name] = hash_function(values[field.name])
                 other_values[field.name] = hash_function(other_values[field.name])
@@ -141,7 +141,7 @@ def __repr__(self) -> str:
         """A string representation of the task"""
         fields_str = ", ".join(
             f"{f.name}={getattr(self, f.name)!r}"
-            for f in list_fields(self)
+            for f in task_fields(self)
             if getattr(self, f.name) != f.default
         )
         return f"{self.__class__.__name__}({fields_str})"
@@ -390,7 +390,7 @@ def __repr__(self) -> str:
         """A string representation of the task"""
         fields_str = ", ".join(
             f"{f.name}={getattr(self, f.name)!r}"
-            for f in list_fields(self)
+            for f in task_fields(self)
             if getattr(self, f.name) != f.default
         )
         return f"{self.__class__.__name__}({fields_str})"
@@ -399,7 +399,7 @@ def __iter__(self) -> ty.Generator[str, None, None]:
         """Iterate through all the names in the task"""
         return (
             f.name
-            for f in list_fields(self)
+            for f in task_fields(self)
             if not (f.name.startswith("_") or f.name in self.RESERVED_FIELD_NAMES)
         )
 
@@ -412,7 +412,7 @@ def __eq__(self, other: ty.Any) -> bool:
             return False
         if set(values) != set(other_values):
             return False  # Return if attribute keys don't match
-        for field in list_fields(self):
+        for field in task_fields(self):
             if field.hash_eq:
                 values[field.name] = hash_function(values[field.name])
                 other_values[field.name] = hash_function(other_values[field.name])
@@ -467,7 +467,7 @@ def _hash_changes(self):
     def _compute_hashes(self) -> ty.Tuple[bytes, ty.Dict[str, bytes]]:
         """Compute a basic hash for any given set of fields."""
         inp_dict = {}
-        for field in list_fields(self):
+        for field in task_fields(self):
             if isinstance(field, Out):
                 continue  # Skip output fields
             # removing values that are not set from hash calculation
@@ -489,7 +489,7 @@ def _rule_violations(self) -> list[str]:
 
         field: Arg
         errors = []
-        for field in list_fields(self):
+        for field in task_fields(self):
             value = self[field.name]
 
             if is_lazy(value):
@@ -606,7 +606,7 @@ def _check_resolved(self):
 @register_serializer
 def bytes_repr_task(obj: Task, cache: Cache) -> ty.Iterator[bytes]:
     yield f"task[{obj._task_type}]:(".encode()
-    for field in list_fields(obj):
+    for field in task_fields(obj):
         yield f"{field.name}=".encode()
         yield hash_single(getattr(obj, field.name), cache)
         yield b","

pydra/compose/base/task.py

@@ -2,7 +2,7 @@
 import inspect
 from typing import dataclass_transform
 import attrs
-from pydra.utils.general import list_fields, attrs_values
+from pydra.utils.general import task_fields, attrs_values
 from pydra.compose import base
 from pydra.compose.base import (
     ensure_field_objects,
@@ -236,7 +236,7 @@ def _run(self, job: "Job[Task]", rerun: bool = True) -> None:
         # Run the actual function
         returned = self.function(**inputs)
         # Collect the outputs and save them into the job.return_values dictionary
-        job.return_values = {f.name: f.default for f in list_fields(self.Outputs)}
+        job.return_values = {f.name: f.default for f in task_fields(self.Outputs)}
         return_names = list(job.return_values)
         if returned is None:
             job.return_values = {nm: None for nm in return_names}

pydra/compose/python.py

@@ -11,7 +11,7 @@
 from fileformats.generic import FileSet, File
 from pydra.utils.general import (
     attrs_values,
-    list_fields,
+    task_fields,
     ensure_list,
     position_sort,
 )
@@ -82,7 +82,7 @@ def _from_task(cls, job: "Job[Task]") -> ty.Self:
         """
         outputs = super()._from_task(job)
         fld: field.out
-        for fld in list_fields(cls):
+        for fld in task_fields(cls):
             if fld.name in ["return_code", "stdout", "stderr"]:
                 resolved_value = job.return_values[fld.name]
             # Get the corresponding value from the inputs if it exists, which will be
@@ -278,7 +278,7 @@ def _command_args(self, values: dict[str, ty.Any]) -> list[str]:
         self._check_rules()
         # Drop none/empty values and optional path fields that are set to false
         values = copy(values)  # Create a copy so we can drop items from the dictionary
-        for fld in list_fields(self):
+        for fld in task_fields(self):
             fld_value = values[fld.name]
             if fld_value is None or (is_multi_input(fld.type) and fld_value == []):
                 del values[fld.name]
@@ -292,7 +292,7 @@ def _command_args(self, values: dict[str, ty.Any]) -> list[str]:
             self._command_shelltask_executable(fld, self.executable),
         ]  # list for (position, command arg)
         positions_provided = [0]
-        fields = {f.name: f for f in list_fields(self)}
+        fields = {f.name: f for f in task_fields(self)}
         for field_name in values:
             pos_val = self._command_pos_args(
                 fld=fields[field_name],
@@ -446,7 +446,7 @@ def _rule_violations(self) -> list[str]:
         errors = super()._rule_violations()
         # if there is a value that has to be updated (e.g. single value from a list)
         # getting all fields that should be formatted, i.e. {field_name}, ...
-        fields = list_fields(self)
+        fields = task_fields(self)
         available_template_names = [f.name for f in fields] + ["field", "inputs"]
         for fld in fields:
             if field.argstr:

pydra/compose/shell/task.py

@@ -5,7 +5,7 @@
 from copy import copy
 from pathlib import Path
 from fileformats.generic import FileSet
-from pydra.utils.general import attrs_values, list_fields
+from pydra.utils.general import attrs_values, task_fields
 from pydra.utils.typing import is_lazy
 from . import field
 
@@ -32,7 +32,7 @@ def template_update(
     # Collect templated inputs for which all requirements are satisfied.
     fields_templ = [
         fld
-        for fld in list_fields(task)
+        for fld in task_fields(task)
         if isinstance(fld, field.outarg)
         and fld.path_template
         and getattr(task, fld.name)

pydra/compose/shell/templating.py

@@ -3,7 +3,7 @@
 from decimal import Decimal
 import attrs
 import pytest
-from pydra.utils.general import list_fields
+from pydra.utils.general import task_fields
 from pydra.compose import python
 
 
@@ -18,8 +18,8 @@ def func(a: int) -> float:
     SampleDef = python.define(func)
 
     assert issubclass(SampleDef, python.Task)
-    inputs = sorted(list_fields(SampleDef), key=sort_key)
-    outputs = sorted(list_fields(SampleDef.Outputs), key=sort_key)
+    inputs = sorted(task_fields(SampleDef), key=sort_key)
+    outputs = sorted(task_fields(SampleDef.Outputs), key=sort_key)
     assert inputs == [
         python.arg(name="a", type=int),
         python.arg(name="function", type=ty.Callable, hash_eq=True, default=func),
@@ -49,8 +49,8 @@ def func(a: int, k: float = 2.0) -> float:
     SampleDef = python.define(func)
 
     assert issubclass(SampleDef, python.Task)
-    inputs = sorted(list_fields(SampleDef), key=sort_key)
-    outputs = sorted(list_fields(SampleDef.Outputs), key=sort_key)
+    inputs = sorted(task_fields(SampleDef), key=sort_key)
+    outputs = sorted(task_fields(SampleDef.Outputs), key=sort_key)
     assert inputs == [
         python.arg(name="a", type=int),
         python.arg(name="function", type=ty.Callable, hash_eq=True, default=func),
@@ -73,8 +73,8 @@ def func(a: int) -> float:
     )
 
     assert issubclass(SampleDef, python.Task)
-    inputs = sorted(list_fields(SampleDef), key=sort_key)
-    outputs = sorted(list_fields(SampleDef.Outputs), key=sort_key)
+    inputs = sorted(task_fields(SampleDef), key=sort_key)
+    outputs = sorted(task_fields(SampleDef.Outputs), key=sort_key)
     assert inputs == [
         python.arg(name="a", type=int, help="The argument to be doubled"),
         python.arg(name="function", type=ty.Callable, hash_eq=True, default=func),
@@ -98,8 +98,8 @@ def func(a: int) -> int:
     )
 
     assert issubclass(SampleDef, python.Task)
-    inputs = sorted(list_fields(SampleDef), key=sort_key)
-    outputs = sorted(list_fields(SampleDef.Outputs), key=sort_key)
+    inputs = sorted(task_fields(SampleDef), key=sort_key)
+    outputs = sorted(task_fields(SampleDef.Outputs), key=sort_key)
     assert inputs == [
         python.arg(name="a", type=float),
         python.arg(name="function", type=ty.Callable, hash_eq=True, default=func),
@@ -118,8 +118,8 @@ def SampleDef(a: int, b: float) -> tuple[float, float]:
         return a + b, a * b
 
     assert issubclass(SampleDef, python.Task)
-    inputs = sorted(list_fields(SampleDef), key=sort_key)
-    outputs = sorted(list_fields(SampleDef.Outputs), key=sort_key)
+    inputs = sorted(task_fields(SampleDef), key=sort_key)
+    outputs = sorted(task_fields(SampleDef.Outputs), key=sort_key)
     assert inputs == [
         python.arg(name="a", type=int),
         python.arg(name="b", type=float),
@@ -150,8 +150,8 @@ def SampleDef(a: int, b: float) -> tuple[float, float]:
         """
         return a + b, a * b
 
-    inputs = sorted(list_fields(SampleDef), key=sort_key)
-    outputs = sorted(list_fields(SampleDef.Outputs), key=sort_key)
+    inputs = sorted(task_fields(SampleDef), key=sort_key)
+    outputs = sorted(task_fields(SampleDef.Outputs), key=sort_key)
     assert inputs == [
         python.arg(name="a", type=int, help="First input to be inputted"),
         python.arg(name="b", type=float, help="Second input"),
@@ -185,8 +185,8 @@ def SampleDef(a: int, b: float) -> tuple[float, float]:
         """
         return a + b, a * b
 
-    inputs = sorted(list_fields(SampleDef), key=sort_key)
-    outputs = sorted(list_fields(SampleDef.Outputs), key=sort_key)
+    inputs = sorted(task_fields(SampleDef), key=sort_key)
+    outputs = sorted(task_fields(SampleDef.Outputs), key=sort_key)
     assert inputs == [
         python.arg(name="a", type=int, help="First input to be inputted"),
         python.arg(name="b", type=float, help="Second input"),
@@ -228,8 +228,8 @@ def SampleDef(a: int, b: float) -> tuple[float, float]:
         """
         return a + b, a * b
 
-    inputs = sorted(list_fields(SampleDef), key=sort_key)
-    outputs = sorted(list_fields(SampleDef.Outputs), key=sort_key)
+    inputs = sorted(task_fields(SampleDef), key=sort_key)
+    outputs = sorted(task_fields(SampleDef.Outputs), key=sort_key)
     assert inputs == [
         python.arg(name="a", type=int, help="First input to be inputted"),
         python.arg(name="b", type=float, help="Second input"),
@@ -276,8 +276,8 @@ def function(a, b):
             return a + b, a * b
 
     assert issubclass(SampleDef, python.Task)
-    inputs = sorted(list_fields(SampleDef), key=sort_key)
-    outputs = sorted(list_fields(SampleDef.Outputs), key=sort_key)
+    inputs = sorted(task_fields(SampleDef), key=sort_key)
+    outputs = sorted(task_fields(SampleDef.Outputs), key=sort_key)
     assert inputs == [
         python.arg(name="a", type=int, help="First input to be inputted"),
         python.arg(name="b", type=float, default=2.0, help="Second input"),
@@ -347,8 +347,8 @@ class Outputs(python.Outputs):
         def function(a, b):
             return a + b, a * b
 
-    inputs = sorted(list_fields(SampleDef), key=sort_key)
-    outputs = sorted(list_fields(SampleDef.Outputs), key=sort_key)
+    inputs = sorted(task_fields(SampleDef), key=sort_key)
+    outputs = sorted(task_fields(SampleDef.Outputs), key=sort_key)
     assert inputs == [
         python.arg(name="a", type=int, help="First input to be inputted"),
         python.arg(name="b", type=float, help="Second input"),

pydra/compose/tests/test_python.py

@@ -5,7 +5,7 @@
 import pytest
 import cloudpickle as cp
 from pydra.compose import shell
-from pydra.utils.general import list_fields
+from pydra.utils.general import task_fields
 from pydra.compose.shell.task import (
     RETURN_CODE_HELP,
     STDOUT_HELP,
@@ -993,7 +993,7 @@ def list_entries(stdout):
 
 
 def sorted_fields(interface):
-    fields = list_fields(interface)
+    fields = task_fields(interface)
     length = len(fields) - 1
 
     def pos_key(out: shell.out) -> int: