Change.

Author: tobiasraabe

docs/source/changes.md

@@ -62,7 +62,7 @@ releases are available on [PyPI](https://pypi.org/project/pytask) and
 - {pull}`485` adds missing steps to unconfigure pytask after the job is done, which
   caused flaky tests.
 - {pull}`486` adds default names to {class}`~pytask.PPathNode`.
-- {pull}`487` implements delayed tasks and nodes.
+- {pull}`487` implements task generators and provisional nodes.
 - {pull}`488` raises an error when an invalid value is used in a return annotation.
 - {pull}`489` and {pull}`491` simplifies parsing products and does not raise an error
   when a product annotation is used with the argument name `produces`. And allow

docs/source/how_to_guides/provisional_nodes_and_task_generators.md

@@ -21,7 +21,7 @@ The following sections will explain how you use pytask in these situations.
 Let us start with a task that downloads all files without an extension from the root
 folder of the pytask repository and stores them on disk in a folder called `downloads`.
 
-```{literalinclude} ../../../docs_src/how_to_guides/delayed_tasks_delayed_products.py
+```{literalinclude} ../../../docs_src/how_to_guides/provisional_products.py
 ---
 emphasize-lines: 4, 11
 ---
@@ -49,21 +49,21 @@ actual nodes. A {class}`~pytask.DirectoryNode`, for example, returns
 In the next step, we want to define a task that consumes and merges all previously
 downloaded files into one file.
 
-```{literalinclude} ../../../docs_src/how_to_guides/delayed_tasks_delayed_task.py
+```{literalinclude} ../../../docs_src/how_to_guides/provisional_task.py
 ---
 emphasize-lines: 9
 ---
 ```
 
-Here, we use the {class}`~pytask.DirectoryNode` as a dependency since we do not know the
+Here, the {class}`~pytask.DirectoryNode` is a dependency because we do not know the
 names of the downloaded files. Before the task is executed, the list of files in the
 folder defined by the root path and the pattern are automatically collected and passed
 to the task.
 
-If we use a {class}`DirectoryNode` with the same `root_dir` and `pattern` in both tasks,
-pytask will automatically recognize that the second task depends on the first. If that
-is not true, you might need to make this dependency more explicit by using
-{func}`@task(after=...) <pytask.task>`, which is explained {ref}`here <after>`.
+If we use a {class}`~pytask.DirectoryNode` with the same `root_dir` and `pattern` in
+both tasks, pytask will automatically recognize that the second task depends on the
+first. If that is not true, you might need to make this dependency more explicit by
+using {func}`@task(after=...) <pytask.task>`, which is explained {ref}`here <after>`.
 
 ## Task generators
 
@@ -79,9 +79,10 @@ writing functions in a task module.
 The code snippet shows each task takes one of the downloaded files and copies its
 content to a `.txt` file.
 
-```{literalinclude} ../../../docs_src/how_to_guides/delayed_tasks_task_generator.py
+```{literalinclude} ../../../docs_src/how_to_guides/provisional_task_generator.py
 ```
 
 ```{important}
-The generated tasks need to be decoratored with {func}`@task <pytask.task>` to be collected.
+The generated tasks need to be decoratored with {func}`@task <pytask.task>` to be
+collected.
 ```

docs_src/how_to_guides/delayed_tasks_delayed_products.py renamed to docs_src/how_to_guides/provisional_products.py

@@ -22,7 +22,6 @@
 from _pytask.dag_utils import node_and_neighbors
 from _pytask.database_utils import has_node_changed
 from _pytask.database_utils import update_states_in_database
-from _pytask.delayed_utils import collect_provisional_products
 from _pytask.exceptions import ExecutionError
 from _pytask.exceptions import NodeLoadError
 from _pytask.exceptions import NodeNotFoundError
@@ -38,6 +37,7 @@
 from _pytask.outcomes import WouldBeExecuted
 from _pytask.outcomes import count_outcomes
 from _pytask.pluginmanager import hookimpl
+from _pytask.provisional_utils import collect_provisional_products
 from _pytask.reports import ExecutionReport
 from _pytask.traceback import remove_traceback_from_exc_info
 from _pytask.tree_util import tree_leaves

docs_src/how_to_guides/delayed_tasks_delayed_task.py renamed to docs_src/how_to_guides/provisional_task.py

@@ -129,7 +129,7 @@ def load(self, is_product: bool = False) -> Any:  # pragma: no cover
 
         It is possible to load a provisional node as a dependency so that it can inject
         basic information about it in the task. For example,
-        :meth:`pytask.DirectoryNode` injects the root directory.
+        :meth:`pytask.DirectoryNode.load` injects the root directory.
 
         """
         if is_product:

docs_src/how_to_guides/delayed_tasks_task_generator.py renamed to docs_src/how_to_guides/provisional_task_generator.py

@@ -8,11 +8,11 @@
 from _pytask.dag_utils import node_and_neighbors
 from _pytask.database_utils import has_node_changed
 from _pytask.database_utils import update_states_in_database
-from _pytask.delayed_utils import collect_provisional_products
 from _pytask.mark_utils import has_mark
 from _pytask.outcomes import Persisted
 from _pytask.outcomes import TaskOutcome
 from _pytask.pluginmanager import hookimpl
+from _pytask.provisional_utils import collect_provisional_products
 
 if TYPE_CHECKING:
     from _pytask.node_protocols import PTask

src/_pytask/execute.py

@@ -46,7 +46,7 @@ def pytask_add_hooks(pm: PluginManager) -> None:
         "_pytask.dag_command",
         "_pytask.database",
         "_pytask.debugging",
-        "_pytask.delayed",
+        "_pytask.provisional",
         "_pytask.execute",
         "_pytask.live",
         "_pytask.logging",

src/_pytask/node_protocols.py

@@ -12,15 +12,15 @@
 from pytask import TaskOutcome
 
 from _pytask.config import hookimpl
-from _pytask.delayed_utils import TASKS_WITH_PROVISIONAL_NODES
-from _pytask.delayed_utils import collect_provisional_nodes
-from _pytask.delayed_utils import recreate_dag
 from _pytask.exceptions import NodeLoadError
 from _pytask.node_protocols import PNode
 from _pytask.node_protocols import PProvisionalNode
 from _pytask.node_protocols import PTask
 from _pytask.node_protocols import PTaskWithPath
 from _pytask.outcomes import CollectionOutcome
+from _pytask.provisional_utils import TASKS_WITH_PROVISIONAL_NODES
+from _pytask.provisional_utils import collect_provisional_nodes
+from _pytask.provisional_utils import recreate_dag
 from _pytask.reports import ExecutionReport
 from _pytask.task_utils import COLLECTED_TASKS
 from _pytask.task_utils import parse_collected_tasks_with_task_marker