Publish more functions. (#237)

Author: tobiasraabe

codecov.yml

@@ -24,4 +24,3 @@ coverage:
 
 ignore:
   - ".tox/**/*"
-  - "setup.py"

docs/source/changes.md

@@ -24,6 +24,7 @@ releases are available on [PyPI](https://pypi.org/project/pytask) and
   {mod}`_pytask.mark_utils`. (Closes {issue}`220`.)
 - {pull}`236` refactors {mod}`_pytask.collect` and places shared functions in
   {mod}`_pytask.collect_utils`.
+- {pull}`237` publish more functions.
 - {pull}`238` allows any order of decorators with a `@pytask.mark.task` decorator.
 - {pull}`241` allows to parametrize over single dicts.
 - {pull}`242` removes tasks from global {obj}`_pytask.task_utils.COLLECTED_TASKS` to

src/_pytask/session.py

@@ -30,26 +30,26 @@
 class Session:
     """The session of pytask."""
 
-    config = attr.ib(factory=dict, type=Optional[Dict[str, Any]])
-    """Optional[Dict[str, Any]]: Configuration of the session."""
+    config = attr.ib(factory=dict, type=Dict[str, Any])
+    """Dict[str, Any]: Configuration of the session."""
     hook = attr.ib(default=None, type=Optional[_HookRelay])
     """Optional[pluggy.hooks._HookRelay]: Holds all hooks collected by pytask."""
     collection_reports = attr.ib(factory=list, type=List["CollectionReport"])
-    """Optional[List[CollectionReport]]: Reports for collected items.
+    """List[CollectionReport]: Reports for collected items.
 
     The reports capture errors which happened while collecting tasks.
 
     """
-    tasks = attr.ib(factory=list, type=Optional[List["Task"]])
-    """Optional[List[Task]]: List of collected tasks."""
+    tasks = attr.ib(factory=list, type=List["Task"])
+    """List[Task]: List of collected tasks."""
     dag = attr.ib(default=None, type=Optional[nx.DiGraph])
     resolving_dependencies_report = attr.ib(
         default=None, type=Optional["ResolvingDependenciesReport"]
     )
     """Optional[ResolvingDependenciesReport]: Reports for resolving dependencies
     failed."""
-    execution_reports = attr.ib(factory=list, type=Optional[List["ExecutionReport"]])
-    """Optional[List[ExecutionReport]]: Reports for executed tasks."""
+    execution_reports = attr.ib(factory=list, type=List["ExecutionReport"])
+    """List[ExecutionReport]: Reports for executed tasks."""
     exit_code = attr.ib(default=ExitCode.OK, type=ExitCode)
 
     collection_start = attr.ib(default=None, type=Optional[float])

src/_pytask/traceback.py

@@ -13,6 +13,14 @@
 from rich.traceback import Traceback
 
 
+__all__ = [
+    "format_exception_without_traceback",
+    "remove_internal_traceback_frames_from_exc_info",
+    "remove_traceback_from_exc_info",
+    "render_exc_info",
+]
+
+
 _PLUGGY_DIRECTORY = Path(pluggy.__file__).parent
 _PYTASK_DIRECTORY = Path(_pytask.__file__).parent
 

src/pytask/__init__.py

@@ -10,6 +10,14 @@
 from _pytask.compat import import_optional_dependency
 from _pytask.config import hookimpl
 from _pytask.console import console
+from _pytask.database import db
+from _pytask.exceptions import CollectionError
+from _pytask.exceptions import ConfigurationError
+from _pytask.exceptions import ExecutionError
+from _pytask.exceptions import NodeNotCollectedError
+from _pytask.exceptions import NodeNotFoundError
+from _pytask.exceptions import PytaskError
+from _pytask.exceptions import ResolvingDependenciesError
 from _pytask.graph import build_dag
 from _pytask.mark import Mark
 from _pytask.mark import MARK_GEN as mark  # noqa: N811
@@ -32,7 +40,15 @@
 from _pytask.outcomes import SkippedAncestorFailed
 from _pytask.outcomes import SkippedUnchanged
 from _pytask.outcomes import TaskOutcome
+from _pytask.report import CollectionReport
+from _pytask.report import ExecutionReport
+from _pytask.report import ResolvingDependenciesReport
 from _pytask.session import Session
+from _pytask.traceback import format_exception_without_traceback
+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
+
 
 # This import must come last, otherwise a circular import occurs.
 from _pytask.cli import cli  # noreorder
@@ -45,7 +61,9 @@
     "cli",
     "console",
     "count_outcomes",
+    "db",
     "depends_on",
+    "format_exception_without_traceback",
     "get_all_marks",
     "get_marks",
     "has_mark",
@@ -55,22 +73,34 @@
     "mark",
     "parse_nodes",
     "produces",
+    "remove_internal_traceback_frames_from_exc_info",
     "remove_marks",
+    "remove_traceback_from_exc_info",
+    "render_exc_info",
     "set_marks",
+    "CollectionError",
     "CollectionOutcome",
+    "CollectionReport",
+    "ConfigurationError",
+    "ExecutionReport",
+    "ExecutionError",
     "Exit",
     "ExitCode",
     "FilePathNode",
     "Mark",
     "MarkDecorator",
     "MarkGenerator",
     "MetaNode",
-    "Task",
+    "NodeNotCollectedError",
+    "NodeNotFoundError",
     "Persisted",
-    "Task",
+    "PytaskError",
+    "ResolvingDependenciesError",
+    "ResolvingDependenciesReport",
     "Session",
     "Skipped",
     "SkippedAncestorFailed",
     "SkippedUnchanged",
+    "Task",
     "TaskOutcome",
 ]

tests/test_shared.py

@@ -10,24 +10,26 @@
 
 @pytest.mark.unit
 @pytest.mark.parametrize(
-    "value, expected",
+    "value, expectation, expected",
     [
-        (True, True),
-        ("True", True),
-        ("true", True),
-        ("1", True),
-        (False, False),
-        ("False", False),
-        ("false", False),
-        ("0", False),
-        (None, None),
-        ("None", None),
-        ("none", None),
+        (True, does_not_raise(), True),
+        ("True", does_not_raise(), True),
+        ("true", does_not_raise(), True),
+        ("1", does_not_raise(), True),
+        (False, does_not_raise(), False),
+        ("False", does_not_raise(), False),
+        ("false", does_not_raise(), False),
+        ("0", does_not_raise(), False),
+        (None, does_not_raise(), None),
+        ("None", does_not_raise(), None),
+        ("none", does_not_raise(), None),
+        ("asklds", pytest.raises(ValueError, match="Input"), None),
     ],
 )
-def test_convert_truthy_or_falsy_to_bool(value, expected):
-    result = convert_truthy_or_falsy_to_bool(value)
-    assert result == expected
+def test_convert_truthy_or_falsy_to_bool(value, expectation, expected):
+    with expectation:
+        result = convert_truthy_or_falsy_to_bool(value)
+        assert result == expected
 
 
 @pytest.mark.unit