Refine typing. (#440)

Author: tobiasraabe

.pre-commit-config.yaml

@@ -62,15 +62,13 @@ repos:
     rev: 'v1.5.1'
     hooks:
     -   id: mypy
-        args: [
-            --no-strict-optional,
-            --ignore-missing-imports,
-        ]
         additional_dependencies: [
             attrs>=21.3.0,
             click,
             optree,
             pluggy,
+            rich,
+            sqlalchemy,
             types-setuptools,
         ]
         pass_filenames: false

docs/source/changes.md

@@ -55,6 +55,7 @@ releases are available on [PyPI](https://pypi.org/project/pytask) and
 - {pull}`437` fixes the detection of task functions and publishes
   {func}`pytask.is_task_function`.
 - {pull}`438` clarifies some types.
+- {pull}`440` refines more types.
 
 ## 0.3.2 - 2023-06-07
 

pyproject.toml

@@ -23,6 +23,14 @@ module = "tests.*"
 disallow_untyped_defs = false
 ignore_errors = true
 
+[[tool.mypy.overrides]]
+module = ["click_default_group", "networkx"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["_pytask.hookspecs"]
+disable_error_code = ["empty-body"]
+
 
 [tool.codespell]
 ignore-words-list = "falsy, hist, ines, unparseable"

src/_pytask/build.py

@@ -233,12 +233,10 @@ def build(  # noqa: C901, PLR0912, PLR0913, PLR0915
         session = Session.from_config(config_)
 
     except (ConfigurationError, Exception):
-        exc_info = sys.exc_info()
-        exc_info = remove_internal_traceback_frames_from_exc_info(exc_info)
+        exc_info = remove_internal_traceback_frames_from_exc_info(sys.exc_info())
         traceback = Traceback.from_exception(*exc_info)
         console.print(traceback)
-        session = Session({}, None)
-        session.exit_code = ExitCode.CONFIGURATION_FAILED
+        session = Session(exit_code=ExitCode.CONFIGURATION_FAILED)
 
     else:
         try:
@@ -257,8 +255,7 @@ def build(  # noqa: C901, PLR0912, PLR0913, PLR0915
             session.exit_code = ExitCode.FAILED
 
         except Exception:  # noqa: BLE001
-            exc_info = sys.exc_info()
-            exc_info = remove_internal_traceback_frames_from_exc_info(exc_info)
+            exc_info = remove_internal_traceback_frames_from_exc_info(sys.exc_info())
             traceback = Traceback.from_exception(*exc_info)
             console.print(traceback)
             session.exit_code = ExitCode.FAILED

src/_pytask/capture.py

@@ -619,7 +619,7 @@ def resume_capturing(self) -> None:
         if self.err:
             self.err.resume()
         if self._in_suspended:
-            self.in_.resume()
+            self.in_.resume()  # type: ignore[union-attr]
             self._in_suspended = False
 
     def stop_capturing(self) -> None:

src/_pytask/clean.py

@@ -35,7 +35,6 @@
 
 
 if TYPE_CHECKING:
-    from types import TracebackType
     from typing import NoReturn
 
 
@@ -112,12 +111,8 @@ def clean(**raw_config: Any) -> NoReturn:  # noqa: C901, PLR0912, PLR0915
         session = Session.from_config(config)
 
     except Exception:  # noqa: BLE001
-        session = Session({}, None)
-        session.exit_code = ExitCode.CONFIGURATION_FAILED
-        exc_info: tuple[
-            type[BaseException], BaseException, TracebackType | None
-        ] = sys.exc_info()
-        console.print(render_exc_info(*exc_info))
+        session = Session(exit_code=ExitCode.CONFIGURATION_FAILED)
+        console.print(render_exc_info(*sys.exc_info()))
 
     else:
         try:
@@ -163,7 +158,7 @@ def clean(**raw_config: Any) -> NoReturn:  # noqa: C901, PLR0912, PLR0915
                 )
 
             console.print()
-            console.rule(style=None)
+            console.rule(style="default")
 
         except CollectionError:
             session.exit_code = ExitCode.COLLECTION_FAILED

src/_pytask/click.py

@@ -56,7 +56,7 @@ def convert(
 class _OptionHighlighter(RegexHighlighter):
     """A highlighter for help texts."""
 
-    highlights: ClassVar = [
+    highlights: ClassVar = [  # type: ignore[misc]
         r"(?P<switch>\-\w)\b",
         r"(?P<option>\-\-[\w\-]+)",
         r"\-\-[\w\-]+(?P<metavar>[ |=][\w\.:]+)",
@@ -192,7 +192,7 @@ def _print_options(
 
 def _format_help_text(  # noqa: C901, PLR0912, PLR0915
     param: click.Parameter, ctx: click.Context
-) -> str:
+) -> Text:
     """Format the help of a click parameter.
 
     A large chunk of the function is copied from

src/_pytask/collect.py

@@ -112,11 +112,16 @@ def _collect_from_tasks(session: Session) -> None:
             except (TypeError, OSError):
                 path = None
             else:
-                if path.name == "<stdin>":
+                if path and path.name == "<stdin>":
                     path = None  # pragma: no cover
 
             # Detect whether a path is defined in a Jupyter notebook.
-            if is_jupyter() and "ipykernel" in path.as_posix() and path.suffix == ".py":
+            if (
+                is_jupyter()
+                and path
+                and "ipykernel" in path.as_posix()
+                and path.suffix == ".py"
+            ):
                 path = None  # pragma: no cover
 
             name = raw_task.pytask_meta.name
@@ -209,7 +214,11 @@ def pytask_collect_task_protocol(
             return CollectionReport(outcome=CollectionOutcome.SUCCESS, node=task)
 
     except Exception:  # noqa: BLE001
-        task = Task(base_name=name, path=path, function=None)
+        if path:
+            task = Task(base_name=name, path=path, function=obj)
+        else:
+            task = TaskWithoutPath(name=name, function=obj)
+
         return CollectionReport.from_exception(
             outcome=CollectionOutcome.FAIL, exc_info=sys.exc_info(), node=task
         )
@@ -463,7 +472,7 @@ def pytask_collect_log(
                 if isinstance(report.node, PTask):
                     short_name = format_task_name(
                         report.node, editor_url_scheme="no_link"
-                    )
+                    ).plain
                 else:
                     short_name = reduce_node_name(report.node, session.config["paths"])
                 header = f"Could not collect {short_name}"
@@ -475,8 +484,11 @@ def pytask_collect_log(
 
             console.print()
 
+            assert report.exc_info
             console.print(
-                render_exc_info(*report.exc_info, session.config["show_locals"])
+                render_exc_info(
+                    *report.exc_info, show_locals=session.config["show_locals"]
+                )
             )
 
             console.print()

src/_pytask/collect_command.py

@@ -68,8 +68,7 @@ def collect(**raw_config: Any | None) -> NoReturn:
         session = Session.from_config(config)
 
     except (ConfigurationError, Exception):
-        session = Session({}, None)
-        session.exit_code = ExitCode.CONFIGURATION_FAILED
+        session = Session(exit_code=ExitCode.CONFIGURATION_FAILED)
         console.print_exception()
 
     else:
@@ -222,17 +221,15 @@ def _print_collected_tasks(  # noqa: PLR0912
                             reduced_path = str(
                                 relative_to(Path(path_part), common_ancestor)
                             )
-                            text = reduced_path + "::" + rest
+                            text = Text(reduced_path + "::" + rest)
                         except Exception:  # noqa: BLE001
-                            text = node.name
+                            text = Text(node.name)
 
                     task_branch.add(Text.assemble(FILE_ICON, "<Dependency ", text, ">"))
 
                 for node in sorted(  # type: ignore[assignment]
                     tree_leaves(task.produces),
-                    key=lambda x: getattr(
-                        x, "path", x.name  # type: ignore[attr-defined]
-                    ),
+                    key=lambda x: x.path if isinstance(x, PPathNode) else x.name,  # type: ignore[attr-defined]
                 ):
                     if isinstance(node, PPathNode):
                         reduced_node_name = str(relative_to(node.path, common_ancestor))

src/_pytask/config_utils.py

@@ -19,7 +19,7 @@ def set_defaults_from_config(
     # command-line options during parsing. Here, we add their defaults to the
     # configuration.
     command_option_names = [option.name for option in context.command.params]
-    commands = context.parent.command.commands  # type: ignore[attr-defined]
+    commands = context.parent.command.commands  # type: ignore[union-attr]
     all_defaults_from_cli = {
         option.name: option.default
         for name, command in commands.items()
@@ -54,7 +54,7 @@ def set_defaults_from_config(
     return context.params["config"]
 
 
-def _find_project_root_and_config(paths: list[Path]) -> tuple[Path, Path]:
+def _find_project_root_and_config(paths: list[Path] | None) -> tuple[Path, Path | None]:
     """Find the project root and configuration file from a list of paths.
 
     The process is as follows:
@@ -68,7 +68,7 @@ def _find_project_root_and_config(paths: list[Path]) -> tuple[Path, Path]:
 
     """
     try:
-        common_ancestor = Path(os.path.commonpath(paths))
+        common_ancestor = Path(os.path.commonpath(paths))  # type: ignore[arg-type]
     except ValueError:
         common_ancestor = Path.cwd()
 

src/_pytask/console.py

@@ -15,6 +15,7 @@
 import rich
 from _pytask.nodes import Task
 from rich.console import Console
+from rich.console import RenderableType
 from rich.padding import Padding
 from rich.panel import Panel
 from rich.segment import Segment
@@ -103,7 +104,7 @@
 
 
 def render_to_string(
-    text: str | Text,
+    text: RenderableType,
     *,
     console: Console | None = None,
     strip_styles: bool = False,
@@ -201,7 +202,7 @@ def create_url_style_for_path(path: Path, edtior_url_scheme: str) -> Style:
 
 def get_file(
     function: Callable[..., Any], skipped_paths: list[Path] | None = None
-) -> Path:
+) -> Path | None:
     """Get path to module where the function is defined.
 
     When the ``pdb`` or ``trace`` mode is activated, every task function is wrapped with
@@ -214,12 +215,14 @@ def get_file(
 
     if isinstance(function, functools.partial):
         return get_file(function.func)
-    if (
-        hasattr(function, "__wrapped__")
-        and Path(inspect.getsourcefile(function)) in skipped_paths
-    ):
-        return get_file(function.__wrapped__)
-    return Path(inspect.getsourcefile(function))
+    if hasattr(function, "__wrapped__"):
+        source_file = inspect.getsourcefile(function)
+        if source_file and Path(source_file) in skipped_paths:
+            return get_file(function.__wrapped__)
+    source_file = inspect.getsourcefile(function)
+    if source_file:
+        return Path(source_file)
+    return None
 
 
 def _get_source_lines(function: Callable[..., Any]) -> int:

src/_pytask/dag.py

@@ -65,7 +65,7 @@ def pytask_dag(session: Session) -> bool | None:
     except Exception:  # noqa: BLE001
         report = DagReport.from_exception(sys.exc_info())
         session.hook.pytask_dag_log(session=session, report=report)
-        session.resolving_dependencies_report = report
+        session.dag_reports = report
 
         raise ResolvingDependenciesError from None
 
@@ -336,7 +336,9 @@ def pytask_dag_log(session: Session, report: DagReport) -> None:
     )
 
     console.print()
-    console.print(render_exc_info(*report.exc_info, session.config["show_locals"]))
+    console.print(
+        render_exc_info(*report.exc_info, show_locals=session.config["show_locals"])
+    )
 
     console.print()
     console.rule(style="failed")

src/_pytask/dag_utils.py

@@ -67,8 +67,8 @@ class TopologicalSorter:
     """
 
     dag: nx.DiGraph
+    dag_backup: nx.DiGraph
     priorities: dict[str, int] = field(factory=dict)
-    _dag_backup: nx.DiGraph | None = None
     _is_prepared: bool = False
     _nodes_out: set[str] = field(factory=set)
 
@@ -88,7 +88,7 @@ def from_dag(cls, dag: nx.DiGraph) -> TopologicalSorter:
         task_dict = {name: nx.ancestors(dag, name) & task_names for name in task_names}
         task_dag = nx.DiGraph(task_dict).reverse()
 
-        return cls(task_dag, priorities, task_dag.copy())
+        return cls(dag=task_dag, priorities=priorities, dag_backup=task_dag.copy())
 
     def prepare(self) -> None:
         """Perform some checks before creating a topological ordering."""
@@ -131,7 +131,8 @@ def done(self, *nodes: str) -> None:
 
     def reset(self) -> None:
         """Reset an exhausted topological sorter."""
-        self.dag = self._dag_backup.copy()
+        if self.dag_backup:
+            self.dag = self.dag_backup.copy()
         self._is_prepared = False
         self._nodes_out = set()
 

src/_pytask/database_utils.py

@@ -69,8 +69,10 @@ def _create_or_update_state(
                 )
             )
         else:
-            state_in_db.modification_time = modification_time
-            state_in_db.hash_ = hash_
+            state_in_db.modification_time = (
+                modification_time  # type: ignore[assignment]
+            )
+            state_in_db.hash_ = hash_  # type: ignore[assignment]
 
         session.commit()
 
@@ -90,4 +92,6 @@ def update_states_in_database(session: Session, task_name: str) -> None:
             modification_time = ""
             hash_ = node.state()
 
-        _create_or_update_state(task_name, node.name, modification_time, hash_)
+        _create_or_update_state(
+            task_name, node.name, modification_time, hash_  # type: ignore[arg-type]
+        )