diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 16f4341..babb3b3 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,10 +1,9 @@ repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.6.0 hooks: - id: check-added-large-files - args: - - --maxkb=25 + args: [--maxkb=25] - id: check-case-conflict - id: check-merge-conflict - id: check-vcs-permalinks @@ -14,9 +13,7 @@ repos: - id: fix-byte-order-marker - id: mixed-line-ending - id: no-commit-to-branch - args: - - --branch - - main + args: [--branch, main] - id: trailing-whitespace - repo: https://github.com/pre-commit/pygrep-hooks rev: v1.10.0 @@ -27,53 +24,19 @@ repos: - id: python-no-log-warn - id: python-use-type-annotations - id: text-unicode-replacement-char -- repo: https://github.com/asottile/reorder-python-imports - rev: v3.12.0 - hooks: - - id: reorder-python-imports - args: - - --py38-plus - - --add-import - - from __future__ import annotations - repo: https://github.com/asottile/setup-cfg-fmt rev: v2.5.0 hooks: - id: setup-cfg-fmt -- repo: https://github.com/PyCQA/docformatter - rev: v1.7.5 - hooks: - - id: docformatter - args: - - --in-place - - --wrap-summaries - - '88' - - --wrap-descriptions - - '88' - - --blank -- repo: https://github.com/psf/black - rev: 23.9.1 - hooks: - - id: black - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.0.292 + rev: v0.4.4 hooks: - id: ruff + - id: ruff-format - repo: https://github.com/dosisod/refurb - rev: v1.21.0 + rev: v2.0.0 hooks: - id: refurb - args: - - --ignore - - FURB126 -- repo: https://github.com/econchick/interrogate - rev: 1.5.0 - hooks: - - id: interrogate - args: - - -v - - --fail-under=40 - - src - - tests - repo: https://github.com/executablebooks/mdformat rev: 0.7.17 hooks: @@ -81,35 +44,13 @@ repos: additional_dependencies: - mdformat-gfm - mdformat-black - args: - - --wrap - - '88' + args: [--wrap, "88"] - repo: https://github.com/codespell-project/codespell rev: v2.2.6 hooks: - id: codespell -- repo: https://github.com/pre-commit/mirrors-mypy - rev: v1.5.1 - hooks: - - id: mypy - args: - - --no-strict-optional - - --ignore-missing-imports - additional_dependencies: - - attrs - - click - - types-setuptools - pass_filenames: false -- repo: https://github.com/mgedmin/check-manifest - rev: '0.49' - hooks: - - id: check-manifest - args: - - --no-build-isolation - additional_dependencies: - - setuptools-scm - - toml - repo: meta hooks: - id: check-hooks-apply - id: check-useless-excludes + # - id: identity # Prints all files passed to pre-commits. Debugging. diff --git a/pyproject.toml b/pyproject.toml index 4cceea3..325a11b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,11 +2,9 @@ requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.0"] build-backend = "setuptools.build_meta" - [tool.setuptools_scm] write_to = "src/pytask_stata/_version.py" - [tool.mypy] files = ["src", "tests"] check_untyped_defs = true @@ -17,54 +15,36 @@ no_implicit_optional = true warn_redundant_casts = true warn_unused_ignores = true - [[tool.mypy.overrides]] module = "tests.*" disallow_untyped_defs = false ignore_errors = true - [tool.ruff] target-version = "py38" -select = ["ALL"] fix = true -extend-ignore = [ - "I", # ignore isort - "TRY", - # Numpy docstyle - "D107", - "D203", - "D212", - "D213", - "D402", - "D413", - "D415", - "D416", - "D417", - # Others. - "D404", # Do not start module docstring with "This". - "RET504", # unnecessary variable assignment before return. - "S101", # raise errors for asserts. - "B905", # strict parameter for zip that was implemented in py310. - "ANN101", # type annotating self - "ANN102", # type annotating cls - "FBT", # flake8-boolean-trap - "EM", # flake8-errmsg - "ANN401", # flake8-annotate typing.Any - "PD", # pandas-vet - "COM812", # trailing comma missing, but black takes care of that -] +unsafe-fixes = true +[tool.ruff.lint] +select = ["ALL"] +ignore = [ + "ANN101", + "ANN102", + "ANN401", # flake8-annotate typing.Any + "COM812", # Comply with ruff-format. + "ISC001", # Comply with ruff-format. +] -[tool.ruff.per-file-ignores] -"tests/*" = ["D", "ANN"] +[tool.ruff.lint.per-file-ignores] +"tests/*" = ["D", "ANN", "S101"] "__init__.py" = ["D104"] +[tool.ruff.lint.isort] +force-single-line = true -[tool.ruff.pydocstyle] +[tool.ruff.lint.pydocstyle] convention = "numpy" - [tool.pytest.ini_options] # Do not add src since it messes with the loading of pytask-parallel as a plugin. testpaths = ["tests"] diff --git a/src/pytask_stata/cli.py b/src/pytask_stata/cli.py index 8cb2667..3aee3e1 100644 --- a/src/pytask_stata/cli.py +++ b/src/pytask_stata/cli.py @@ -1,4 +1,5 @@ """Everything related to the CLI.""" + from __future__ import annotations import click diff --git a/src/pytask_stata/collect.py b/src/pytask_stata/collect.py index d65ee12..aae9034 100644 --- a/src/pytask_stata/collect.py +++ b/src/pytask_stata/collect.py @@ -1,21 +1,23 @@ """Collect tasks.""" + from __future__ import annotations import functools import subprocess from types import FunctionType -from typing import Any from typing import TYPE_CHECKING +from typing import Any +from pytask import Mark +from pytask import Session +from pytask import Task from pytask import depends_on from pytask import has_mark from pytask import hookimpl -from pytask import Mark from pytask import parse_nodes from pytask import produces from pytask import remove_marks -from pytask import Session -from pytask import Task + from pytask_stata.shared import convert_task_id_to_name_of_log_file from pytask_stata.shared import stata @@ -47,10 +49,11 @@ def pytask_collect_task( obj, marks = remove_marks(obj, "stata") if len(marks) > 1: - raise ValueError( + msg = ( f"Task {name!r} has multiple @pytask.mark.stata marks, but only one is " "allowed." ) + raise ValueError(msg) mark = _parse_stata_mark(mark=marks[0]) script, options = stata(**marks[0].kwargs) @@ -109,8 +112,7 @@ def _parse_stata_mark(mark: Mark) -> Mark: parsed_kwargs = {"script": script or None, "options": options or []} - mark = Mark("stata", (), parsed_kwargs) - return mark + return Mark("stata", (), parsed_kwargs) def _copy_func(func: FunctionType) -> FunctionType: diff --git a/src/pytask_stata/config.py b/src/pytask_stata/config.py index 0634e07..1d9c2d5 100644 --- a/src/pytask_stata/config.py +++ b/src/pytask_stata/config.py @@ -1,4 +1,5 @@ """Configure pytask.""" + from __future__ import annotations import shutil @@ -6,6 +7,7 @@ from typing import Any from pytask import hookimpl + from pytask_stata.shared import STATA_COMMANDS diff --git a/src/pytask_stata/execute.py b/src/pytask_stata/execute.py index db12876..529343a 100644 --- a/src/pytask_stata/execute.py +++ b/src/pytask_stata/execute.py @@ -1,26 +1,29 @@ """Execute tasks.""" + from __future__ import annotations import re -from pytask import has_mark -from pytask import hookimpl from pytask import Session from pytask import Task -from pytask_stata.shared import convert_task_id_to_name_of_log_file +from pytask import has_mark +from pytask import hookimpl + from pytask_stata.shared import STATA_COMMANDS +from pytask_stata.shared import convert_task_id_to_name_of_log_file @hookimpl def pytask_execute_task_setup(session: Session, task: Task) -> None: """Check if Stata is found on the PATH.""" if has_mark(task, "stata") and session.config["stata"] is None: - raise RuntimeError( + msg = ( "Stata is needed to run do-files, but it is not found on your PATH.\n\n" f"We are looking for one of {STATA_COMMANDS} on your PATH. If you have a" "different Stata executable, please, file an issue at " "https://github.com/pytask-dev/pytask-stata." ) + raise RuntimeError(msg) @hookimpl diff --git a/src/pytask_stata/parametrize.py b/src/pytask_stata/parametrize.py index 3afec0e..a30f982 100644 --- a/src/pytask_stata/parametrize.py +++ b/src/pytask_stata/parametrize.py @@ -1,4 +1,5 @@ """Parametrize tasks.""" + from __future__ import annotations from typing import Any diff --git a/src/pytask_stata/plugin.py b/src/pytask_stata/plugin.py index a8f4e46..84db2ae 100644 --- a/src/pytask_stata/plugin.py +++ b/src/pytask_stata/plugin.py @@ -1,9 +1,11 @@ """Register hook specifications and implementations.""" + from __future__ import annotations from typing import TYPE_CHECKING from _pytask.config import hookimpl + from pytask_stata import cli from pytask_stata import collect from pytask_stata import config diff --git a/src/pytask_stata/shared.py b/src/pytask_stata/shared.py index f36c104..8464a14 100644 --- a/src/pytask_stata/shared.py +++ b/src/pytask_stata/shared.py @@ -1,11 +1,12 @@ """Shared functions and variables.""" + from __future__ import annotations import sys +from typing import TYPE_CHECKING from typing import Any from typing import Iterable from typing import Sequence -from typing import TYPE_CHECKING if TYPE_CHECKING: from pathlib import Path @@ -78,9 +79,7 @@ def convert_task_id_to_name_of_log_file(id_: str) -> str: 'task_example_py_task_example[arg1]' """ - id_without_parent_directories = id_.rsplit("/")[-1] - converted_id = id_without_parent_directories.replace(".", "_").replace("::", "_") - return converted_id + return id_.rsplit("/")[-1].replace(".", "_").replace("::", "_") def _to_list(scalar_or_iter: Any) -> list[Any]: diff --git a/tests/conftest.py b/tests/conftest.py index 2cb9a8c..5f39d95 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -6,7 +6,6 @@ from click.testing import CliRunner from pytask_stata.config import STATA_COMMANDS - needs_stata = pytest.mark.skipif( next( (executable for executable in STATA_COMMANDS if shutil.which(executable)), None diff --git a/tests/test_execute.py b/tests/test_execute.py index 5a94850..e8fc7c0 100644 --- a/tests/test_execute.py +++ b/tests/test_execute.py @@ -6,12 +6,12 @@ from pathlib import Path import pytest -from pytask import cli from pytask import ExitCode -from pytask import main from pytask import Mark from pytask import Session from pytask import Task +from pytask import cli +from pytask import main from pytask_stata.config import STATA_COMMANDS from pytask_stata.execute import pytask_execute_task_setup @@ -117,7 +117,8 @@ def task_run_do_file(): # Hide Stata if available. monkeypatch.setattr( - "pytask_stata.config.shutil.which", lambda x: None # noqa: ARG005 + "pytask_stata.config.shutil.which", + lambda x: None, # noqa: ARG005 ) session = main({"paths": tmp_path}) diff --git a/tests/test_normal_execution_w_plugin.py b/tests/test_normal_execution_w_plugin.py index 346d228..a7b211d 100644 --- a/tests/test_normal_execution_w_plugin.py +++ b/tests/test_normal_execution_w_plugin.py @@ -1,4 +1,5 @@ """Contains tests which do not require the plugin and ensure normal execution.""" + from __future__ import annotations import textwrap diff --git a/tests/test_parallel.py b/tests/test_parallel.py index 750411e..52873c9 100644 --- a/tests/test_parallel.py +++ b/tests/test_parallel.py @@ -1,12 +1,13 @@ """Contains test which ensure that the plugin works with pytask-parallel.""" + from __future__ import annotations import textwrap import time import pytest -from pytask import cli from pytask import ExitCode +from pytask import cli from tests.conftest import needs_stata diff --git a/tests/test_parametrize.py b/tests/test_parametrize.py index 9ac0009..4ac5d98 100644 --- a/tests/test_parametrize.py +++ b/tests/test_parametrize.py @@ -4,8 +4,8 @@ import textwrap import pytest -from pytask import cli from pytask import ExitCode +from pytask import cli from tests.conftest import needs_stata