Add rudimentary typing to pytask. (#160)

Author: tobiasraabe

.pre-commit-config.yaml

@@ -66,6 +66,7 @@ repos:
             flake8-print,
             flake8-pytest-style,
             flake8-todo,
+            flake8-typing-imports,
             flake8-unused-arguments,
             pep8-naming,
             pydocstyle,
@@ -94,6 +95,21 @@ repos:
     hooks:
     -   id: tryceratops
         exclude: (console\.py|test_mark_expression\.py)
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v0.910-1'
+    hooks:
+    -   id: mypy
+        args: [
+            --no-strict-optional,
+            --ignore-missing-imports,
+        ]
+        additional_dependencies: [
+            types-attrs,
+            types-click,
+            types-setuptools
+        ]
+        pass_filenames: false
+        language_version: "3.9"
 -   repo: meta
     hooks:
     -   id: check-hooks-apply

docs/rtd_environment.yml

@@ -14,7 +14,6 @@ dependencies:
   - nbsphinx
   - sphinx
   - sphinx-autoapi
-  - sphinx-autodoc-typehints
   - sphinx-click
   - sphinx-copybutton
   - sphinx-panels

docs/source/changes.rst

@@ -11,6 +11,7 @@ all releases are available on `PyPI <https://pypi.org/project/pytask>`_ and
 ------------------
 
 - :gh:`159` removes files for creating a conda package which is handled by conda-forge.
+- :gh:`160` adds rudimentary typing to pytask.
 - :gh:`161` removes a workaround for pyreadline which is also removed in pytest 7.
 - :gh:`163` allow forward slashes in expressions and marker expressions.
 - :gh:`164` allows to use backward slashes in expressions and marker expressions.

docs/source/conf.py

@@ -39,7 +39,6 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
     "sphinx_copybutton",
-    "sphinx_autodoc_typehints",
     "sphinx_click",
     "sphinx_panels",
     "autoapi.extension",

environment.yml

@@ -40,7 +40,6 @@ dependencies:
   - nbsphinx
   - sphinx
   - sphinx-autoapi
-  - sphinx-autodoc-typehints
   - sphinx-click
   - sphinx-copybutton
   - sphinx-panels

pyproject.toml

@@ -8,3 +8,20 @@ write_to = "src/_pytask/_version.py"
 
 [tool.tryceratops]
 ignore = ["TC003"]
+
+
+[tool.mypy]
+files = ["src", "tests"]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false
+ignore_errors = true

src/_pytask/build.py

@@ -1,5 +1,8 @@
 """Implement the build command."""
 import sys
+from typing import Any
+from typing import Dict
+from typing import TYPE_CHECKING
 
 import click
 from _pytask.config import hookimpl
@@ -13,13 +16,17 @@
 from _pytask.session import Session
 
 
+if TYPE_CHECKING:
+    from typing import NoReturn
+
+
 @hookimpl(tryfirst=True)
-def pytask_extend_command_line_interface(cli):
+def pytask_extend_command_line_interface(cli: click.Group) -> None:
     """Extend the command line interface."""
     cli.add_command(build)
 
 
-def main(config_from_cli):
+def main(config_from_cli: Dict[str, Any]) -> Session:
     """Run pytask.
 
     This is the main command to run pytask which usually receives kwargs from the
@@ -100,7 +107,7 @@ def main(config_from_cli):
     default=None,
     help="Print errors with tracebacks as soon as the task fails.",
 )
-def build(**config_from_cli):
+def build(**config_from_cli: Any) -> "NoReturn":
     """Collect and execute tasks and report the results.
 
     This is the default command of pytask which searches given paths or the current