renamed TaskDef to Task

Author: tclose

pydra/design/base.py

@@ -27,15 +27,15 @@
 
 
 if ty.TYPE_CHECKING:
-    from pydra.engine.specs import TaskDef, TaskOutputs
+    from pydra.engine.specs import Task, TaskOutputs
 
 
 __all__ = [
     "Field",
     "Arg",
     "Out",
     "ensure_field_objects",
-    "make_task_def",
+    "make_task",
 ]
 
 
@@ -89,7 +89,7 @@ class Requirement:
         default=None, converter=allowed_values_converter
     )
 
-    def satisfied(self, inputs: "TaskDef") -> bool:
+    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]
@@ -157,7 +157,7 @@ class RequirementSet:
         converter=requirements_converter,
     )
 
-    def satisfied(self, inputs: "TaskDef") -> bool:
+    def satisfied(self, inputs: "Task") -> bool:
         """Check if all the requirements are satisfied by the inputs"""
         return all(req.satisfied(inputs) for req in self.requirements)
 
@@ -203,7 +203,7 @@ def requires_converter(
 
 @attrs.define(kw_only=True)
 class Field:
-    """Base class for input and output fields to task definitions
+    """Base class for input and output fields to tasks
 
     Parameters
     ----------
@@ -245,7 +245,7 @@ class Field:
     validator: ty.Callable[..., bool] | None = None
     hash_eq: bool = False
 
-    def requirements_satisfied(self, inputs: "TaskDef") -> bool:
+    def requirements_satisfied(self, inputs: "Task") -> bool:
         """Check if all the requirements are satisfied by the inputs"""
         return any(req.satisfied(inputs) for req in self.requires)
 
@@ -264,7 +264,7 @@ def _requires_validator(self, _, value):
 
 @attrs.define(kw_only=True)
 class Arg(Field):
-    """Base class for input fields of task definitions
+    """Base class for input fields of tasks
 
     Parameters
     ----------
@@ -303,7 +303,7 @@ class Arg(Field):
 
 @attrs.define(kw_only=True, slots=False)
 class Out(Field):
-    """Base class for output fields of task definitions
+    """Base class for output fields of tasks
 
     Parameters
     ----------
@@ -328,7 +328,7 @@ class Out(Field):
 
 
 def extract_fields_from_class(
-    spec_type: type["TaskDef"],
+    spec_type: type["Task"],
     outputs_type: type["TaskOutputs"],
     klass: type,
     arg_type: type[Arg],
@@ -436,8 +436,8 @@ def get_fields(klass, field_type, auto_attribs, helps) -> dict[str, Field]:
     return inputs, outputs
 
 
-def make_task_def(
-    spec_type: type["TaskDef"],
+def make_task(
+    spec_type: type["Task"],
     out_type: type["TaskOutputs"],
     inputs: dict[str, Arg],
     outputs: dict[str, Out],
@@ -447,7 +447,7 @@ def make_task_def(
     outputs_bases: ty.Sequence[type] = (),
     xor: ty.Sequence[str | None] | ty.Sequence[ty.Sequence[str | None]] = (),
 ):
-    """Create a task definition class and its outputs definition class from the
+    """Create a task class and its outputs class from the
     input and output fields provided to the decorator/function.
 
     Modifies the class so that its attributes are converted from pydra fields to attrs fields
@@ -467,9 +467,9 @@ def make_task_def(
     name : str, optional
         The name of the class, by default
     bases : ty.Sequence[type], optional
-        The base classes for the task definition class, by default ()
+        The base classes for the task class, by default ()
     outputs_bases : ty.Sequence[type], optional
-        The base classes for the outputs definition class, by default ()
+        The base classes for the outputs class, by default ()
     xor: Sequence[str | None] | Sequence[Sequence[str | None]], optional
         Names of args that are exclusive mutually exclusive, which must include
         the name of the current field. If this list includes None, then none of the
@@ -509,14 +509,14 @@ def make_task_def(
         if name is None:
             raise ValueError("name must be provided if klass is not")
         bases = tuple(bases)
-        # Ensure that TaskDef is a base class
+        # Ensure that Task is a base class
         if not any(issubclass(b, spec_type) for b in bases):
             bases = bases + (spec_type,)
         # If building from a decorated class (as opposed to dynamically from a function
         # or shell-template), add any base classes not already in the bases tuple
         if klass is not None:
             bases += tuple(c for c in klass.__mro__ if c not in bases + (object,))
-        # Create a new class with the TaskDef as a base class
+        # Create a new class with the Task as a base class
         klass = types.new_class(
             name=name,
             bases=bases,
@@ -580,7 +580,7 @@ def make_outputs_spec(
     bases: ty.Sequence[type],
     spec_name: str,
 ) -> type["TaskOutputs"]:
-    """Create an outputs definition class and its outputs definition class from the
+    """Create an outputs class and its outputs class from the
     output fields provided to the decorator/function.
 
     Creates a new class with attrs fields and then calls `attrs.define` to create an
@@ -591,9 +591,9 @@ def make_outputs_spec(
     outputs : dict[str, Out]
         The output fields of the task
     bases : ty.Sequence[type], optional
-        The base classes for the outputs definition class, by default ()
+        The base classes for the outputs class, by default ()
     spec_name : str
-        The name of the task definition class the outputs are for
+        The name of the task class the outputs are for
 
     Returns
     -------

pydra/design/python.py

@@ -6,7 +6,7 @@
     Arg,
     Out,
     ensure_field_objects,
-    make_task_def,
+    make_task,
     parse_doc_string,
     extract_function_inputs_and_outputs,
     check_explicit_fields_are_none,
@@ -21,7 +21,7 @@
 
 @attrs.define
 class arg(Arg):
-    """Argument of a Python task definition
+    """Argument of a Python task
 
     Parameters
     ----------
@@ -56,7 +56,7 @@ class arg(Arg):
 
 @attrs.define
 class out(Out):
-    """Output of a Python task definition
+    """Output of a Python task
 
     Parameters
     ----------
@@ -125,7 +125,7 @@ def define(
     Returns
     -------
     PythonTask
-        The task definition class for the Python function
+        The task class for the Python function
     """
     from pydra.engine.specs import PythonTask, PythonOutputs
 
@@ -175,7 +175,7 @@ def make(wrapped: ty.Callable | type) -> PythonTask:
             name="function", type=ty.Callable, default=function, hash_eq=True
         )
 
-        defn = make_task_def(
+        defn = make_task(
             PythonTask,
             PythonOutputs,
             parsed_inputs,

pydra/design/shell.py

@@ -20,7 +20,7 @@
     check_explicit_fields_are_none,
     extract_fields_from_class,
     ensure_field_objects,
-    make_task_def,
+    make_task,
     NO_DEFAULT,
 )
 from pydra.utils.typing import (
@@ -257,8 +257,8 @@ def define(
     name: str | None = None,
     xor: ty.Sequence[str | None] | ty.Sequence[ty.Sequence[str | None]] = (),
 ) -> "ShellTask":
-    """Create a task definition for a shell command. Can be used either as a decorator on
-    the "canonical" dataclass-form of a task definition or as a function that takes a
+    """Create a task for a shell command. Can be used either as a decorator on
+    the "canonical" dataclass-form of a task or as a function that takes a
     "shell-command template string" of the form
 
     ```
@@ -430,7 +430,7 @@ def make(
                 outpt.callable = GlobCallable(outpt.default)
                 outpt.default = NO_DEFAULT
 
-        defn = make_task_def(
+        defn = make_task(
             ShellTask,
             ShellOutputs,
             parsed_inputs,

pydra/design/tests/test_python.py

@@ -26,8 +26,8 @@ def func(a: int) -> float:
         python.arg(name="function", type=ty.Callable, hash_eq=True, default=func),
     ]
     assert outputs == [python.out(name="out", type=float)]
-    definition = SampleDef(a=1)
-    outputs = definition(cache_dir=tmp_path)
+    task = SampleDef(a=1)
+    outputs = task(cache_dir=tmp_path)
     assert outputs.out == 2.0
     with pytest.raises(TypeError):
         SampleDef(a=1.5)

pydra/design/tests/test_workflow.py

@@ -52,7 +52,7 @@ def MyTestWorkflow(a, b):
     constructor = MyTestWorkflow().constructor
     assert constructor.__name__ == "MyTestWorkflow"
 
-    # The constructor function is included as a part of the definition so it is
+    # 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 list_fields(MyTestWorkflow) == [
@@ -143,7 +143,7 @@ def MyTestShellWorkflow(
 
 
 def test_workflow_canonical():
-    """Test class-based workflow definition"""
+    """Test class-based workflow task"""
 
     # NB: We use PascalCase (i.e. class names) as it is translated into a class
 
@@ -169,7 +169,7 @@ class Outputs(WorkflowOutputs):
     constructor = MyTestWorkflow().constructor
     assert constructor.__name__ == "constructor"
 
-    # The constructor function is included as a part of the definition so it is
+    # 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 sorted(list_fields(MyTestWorkflow), key=attrgetter("name")) == [
@@ -236,7 +236,7 @@ def MyTestShellWorkflow(
         input_video=LazyOutField(node=mock_node, field="a_video", type=video.Mp4),
         watermark=LazyOutField(node=mock_node, field="a_watermark", type=image.Png),
     )
-    Workflow.clear_cache(definition=MyTestShellWorkflow)
+    Workflow.clear_cache(task=MyTestShellWorkflow)
     wf = Workflow.construct(workflow_spec)
     assert wf["add_watermark"].inputs.in_video == LazyInField(
         workflow=wf, field="input_video", type=video.Mp4, type_checked=True
@@ -458,7 +458,7 @@ def MyTestWorkflow(a: int, b: float, c: float) -> float:
         node=wf["NestedWorkflow"], field="out", type=float, type_checked=True
     )
     assert list(wf.node_names) == ["Divide", "NestedWorkflow"]
-    nwf_spec = copy(wf["NestedWorkflow"]._definition)
+    nwf_spec = copy(wf["NestedWorkflow"]._task)
     nwf_spec.a = 100.0
     nwf = Workflow.construct(nwf_spec)
     nwf.inputs.a == 100.0

pydra/design/workflow.py

@@ -6,7 +6,7 @@
     Arg,
     Out,
     ensure_field_objects,
-    make_task_def,
+    make_task,
     parse_doc_string,
     extract_function_inputs_and_outputs,
     check_explicit_fields_are_none,
@@ -15,7 +15,7 @@
 
 if ty.TYPE_CHECKING:
     from pydra.engine.core import Workflow
-    from pydra.engine.specs import TaskDef, TaskOutputs, WorkflowTask
+    from pydra.engine.specs import Task, TaskOutputs, WorkflowTask
     from pydra.engine.environments import Environment
     from pydra.engine.specs import TaskHooks
 
@@ -25,7 +25,7 @@
 
 @attrs.define
 class arg(Arg):
-    """Argument of a workflow task definition
+    """Argument of a workflow task
 
     Parameters
     ----------
@@ -63,7 +63,7 @@ class arg(Arg):
 
 @attrs.define
 class out(Out):
-    """Output of a workflow task definition
+    """Output of a workflow task
 
     Parameters
     ----------
@@ -111,7 +111,7 @@ def define(
 ) -> "WorkflowTask":
     """
     Create an interface for a function or a class. Can be used either as a decorator on
-    a constructor function or the "canonical" dataclass-form of a task definition.
+    a constructor function or the "canonical" dataclass-form of a task.
 
     Parameters
     ----------
@@ -130,15 +130,15 @@ def define(
 
     Returns
     -------
-    TaskDef
+    Task
         The interface for the function or class.
     """
-    from pydra.engine.specs import TaskDef, WorkflowTask, WorkflowOutputs
+    from pydra.engine.specs import Task, WorkflowTask, WorkflowOutputs
 
     if lazy is None:
         lazy = []
 
-    def make(wrapped: ty.Callable | type) -> TaskDef:
+    def make(wrapped: ty.Callable | type) -> Task:
         if inspect.isclass(wrapped):
             klass = wrapped
             constructor = klass.constructor
@@ -187,7 +187,7 @@ def make(wrapped: ty.Callable | type) -> TaskDef:
         for inpt_name in lazy:
             parsed_inputs[inpt_name].lazy = True
 
-        defn = make_task_def(
+        defn = make_task(
             WorkflowTask,
             WorkflowOutputs,
             parsed_inputs,
@@ -225,7 +225,7 @@ def this() -> "Workflow":
 
 
 def add(
-    task_def: "TaskDef[OutputsType]",
+    task: "Task[OutputsType]",
     name: str | None = None,
     environment: "Environment | None" = None,
     hooks: "TaskHooks | None" = None,
@@ -234,10 +234,10 @@ def add(
 
     Parameters
     ----------
-    task_def : TaskDef
+    task : Task
         The definition of the task to add to the workflow as a node
     name : str, optional
-        The name of the node, by default it will be the name of the task definition
+        The name of the node, by default it will be the name of the task
         class
     environment : Environment, optional
         The environment to run the task in, such as the Docker or Singularity container,
@@ -248,9 +248,9 @@ def add(
     Returns
     -------
     Outputs
-        The outputs definition of the node
+        The outputs of the node
     """
-    return this().add(task_def, name=name, environment=environment, hooks=hooks)
+    return this().add(task, name=name, environment=environment, hooks=hooks)
 
 
 U = ty.TypeVar("U")