Fix detection of task functions. (#437)

Author: tobiasraabe

docs/source/changes.md

@@ -52,6 +52,8 @@ releases are available on [PyPI](https://pypi.org/project/pytask) and
 - {pull}`431` enables colors for WSL.
 - {pull}`432` fixes type checking of `pytask.mark.xxx`.
 - {pull}`433` fixes the ids generated for {class}`~pytask.PythonNode`s.
+- {pull}`437` fixes the detection of task functions and publishes
+  {func}`pytask.is_task_function`.
 
 ## 0.3.2 - 2023-06-07
 

docs/source/reference_guides/api.md

@@ -264,7 +264,8 @@ To parse dependencies and products from nodes, use the following functions.
 
 ```{eval-rst}
 .. autofunction:: pytask.depends_on
-.. autofunction:: pytask.parse_nodes
+.. autofunction:: pytask.parse_dependencies_from_task_function
+.. autofunction:: pytask.parse_products_from_task_function
 .. autofunction:: pytask.produces
 ```
 

src/_pytask/collect.py

@@ -39,6 +39,7 @@
 from _pytask.shared import reduce_node_name
 from _pytask.task_utils import task as task_decorator
 from _pytask.traceback import render_exc_info
+from _pytask.typing import is_task_function
 from rich.text import Text
 
 if TYPE_CHECKING:
@@ -102,7 +103,7 @@ def _collect_from_tasks(session: Session) -> None:
                 obj=raw_task,
             )
 
-        if callable(raw_task):
+        if is_task_function(raw_task):
             if not hasattr(raw_task, "pytask_meta"):
                 raw_task = task_decorator()(raw_task)  # noqa: PLW2901
 

src/_pytask/collect_utils.py

@@ -38,6 +38,7 @@
 __all__ = [
     "depends_on",
     "parse_dependencies_from_task_function",
+    "parse_products_from_task_function",
     "parse_nodes",
     "produces",
 ]
@@ -370,18 +371,6 @@ def _find_args_with_node_annotation(func: Callable[..., Any]) -> dict[str, PNode
 Read more about products in the documentation: https://tinyurl.com/yrezszr4.
 """
 
-_WARNING_PRODUCES_AS_KWARG = """Using 'produces' as an argument name to specify \
-products is deprecated and won't be available in pytask v0.5. Instead, use the product \
-annotation, described in this tutorial: https://tinyurl.com/yrezszr4.
-
-    from typing_extensions import Annotated
-    from pytask import Product
-
-    def task_example(produces: Annotated[..., Product]):
-        ...
-
-"""
-
 
 def parse_products_from_task_function(
     session: Session, task_path: Path, task_name: str, node_path: Path, obj: Any

src/_pytask/mark/structures.py

@@ -1,25 +1,18 @@
 from __future__ import annotations
 
-import functools
 import warnings
 from typing import Any
 from typing import Callable
 from typing import Iterable
 from typing import Mapping
 
 from _pytask.models import CollectionMetadata
+from _pytask.typing import is_task_function
 from attrs import define
 from attrs import field
 from attrs import validators
 
 
-def is_task_function(func: Any) -> bool:
-    return (callable(func) and getattr(func, "__name__", "<lambda>") != "<lambda>") or (
-        isinstance(func, functools.partial)
-        and getattr(func.func, "__name__", "<lambda>") != "<lambda>"
-    )
-
-
 @define(frozen=True)
 class Mark:
     """A class for a mark containing the name, positional and keyword arguments."""

src/_pytask/report.py

@@ -37,6 +37,7 @@ def from_exception(
         exc_info: ExceptionInfo,
         node: MetaNode | None = None,
     ) -> CollectionReport:
+        exc_info = remove_internal_traceback_frames_from_exc_info(exc_info)
         return cls(outcome=outcome, node=node, exc_info=exc_info)
 
 

src/_pytask/task_utils.py

@@ -12,6 +12,7 @@
 from _pytask.mark import Mark
 from _pytask.models import CollectionMetadata
 from _pytask.shared import find_duplicates
+from _pytask.typing import is_task_function
 
 if TYPE_CHECKING:
     from _pytask.tree_util import PyTree
@@ -123,7 +124,7 @@ def wrapper(func: Callable[..., Any]) -> None:
 
     # In case the decorator is used without parentheses, wrap the function which is
     # passed as the first argument with the default arguments.
-    if callable(name) and kwargs is None:
+    if is_task_function(name) and kwargs is None:
         return task()(name)
     return wrapper
 

src/_pytask/typing.py

@@ -1,5 +1,8 @@
 from __future__ import annotations
 
+import functools
+from typing import Any
+
 from attr import define
 
 
@@ -13,3 +16,9 @@ class ProductType:
 
 Product = ProductType()
 """ProductType: A singleton to mark products in annotations."""
+
+
+def is_task_function(func: Any) -> bool:
+    return (callable(func) and hasattr(func, "__name__")) or (
+        isinstance(func, functools.partial) and hasattr(func.func, "__name__")
+    )

src/pytask/__init__.py

@@ -7,7 +7,8 @@
 from _pytask.click import ColoredGroup
 from _pytask.click import EnumChoice
 from _pytask.collect_utils import depends_on
-from _pytask.collect_utils import parse_nodes
+from _pytask.collect_utils import parse_dependencies_from_task_function
+from _pytask.collect_utils import parse_products_from_task_function
 from _pytask.collect_utils import produces
 from _pytask.compat import check_for_optional_program
 from _pytask.compat import import_optional_dependency
@@ -44,6 +45,7 @@
 from _pytask.nodes import PathNode
 from _pytask.nodes import PythonNode
 from _pytask.nodes import Task
+from _pytask.nodes import TaskWithoutPath
 from _pytask.outcomes import CollectionOutcome
 from _pytask.outcomes import count_outcomes
 from _pytask.outcomes import Exit
@@ -63,6 +65,7 @@
 from _pytask.traceback import remove_internal_traceback_frames_from_exc_info
 from _pytask.traceback import remove_traceback_from_exc_info
 from _pytask.traceback import render_exc_info
+from _pytask.typing import is_task_function
 from _pytask.typing import Product
 from _pytask.warnings_utils import parse_warning_filter
 from _pytask.warnings_utils import warning_record_to_str
@@ -115,6 +118,7 @@
     "State",
     "Task",
     "TaskOutcome",
+    "TaskWithoutPath",
     "WarningReport",
     "__version__",
     "build",
@@ -131,8 +135,10 @@
     "has_mark",
     "hookimpl",
     "import_optional_dependency",
+    "is_task_function",
     "mark",
-    "parse_nodes",
+    "parse_dependencies_from_task_function",
+    "parse_products_from_task_function",
     "parse_warning_filter",
     "produces",
     "remove_internal_traceback_frames_from_exc_info",

tests/test_typing.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+import functools
+
+from _pytask.typing import is_task_function
+
+
+def test_is_task_function():
+    def func():
+        pass
+
+    assert is_task_function(func)
+
+    partialed_func = functools.partial(func)
+
+    assert is_task_function(partialed_func)
+
+    assert is_task_function(lambda x: x)
+
+    partialed_lambda = functools.partial(lambda x: x)
+
+    assert is_task_function(partialed_lambda)