diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e59642e3..34e5f9ab 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -45,13 +45,13 @@ repos: hooks: - id: sort-all - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.1.14 + rev: v0.2.0 hooks: - id: ruff-format - id: ruff args: [--unsafe-fixes] - repo: https://github.com/dosisod/refurb - rev: v1.27.0 + rev: v1.28.0 hooks: - id: refurb args: [--ignore, FURB126] @@ -96,9 +96,8 @@ repos: - id: nbqa-isort - id: nbqa-mypy args: [--ignore-missing-imports] - - id: nbqa-ruff - repo: https://github.com/kynan/nbstripout - rev: 0.6.1 + rev: 0.6.2 hooks: - id: nbstripout exclude: (docs) diff --git a/docs/source/reference_guides/api.md b/docs/source/reference_guides/api.md index 70feb034..b70d8e88 100644 --- a/docs/source/reference_guides/api.md +++ b/docs/source/reference_guides/api.md @@ -136,8 +136,7 @@ For example: ```python @pytask.mark.timeout(10, "slow", method="thread") -def task_function(): - ... +def task_function(): ... ``` Will create and attach a {class}`Mark ` object to the collected @@ -154,8 +153,7 @@ Example for using multiple custom markers: ```python @pytask.mark.timeout(10, "slow", method="thread") @pytask.mark.slow -def task_function(): - ... +def task_function(): ... ``` ### Classes diff --git a/docs/source/tutorials/repeating_tasks_with_different_inputs.md b/docs/source/tutorials/repeating_tasks_with_different_inputs.md index 8e5a10e5..b369167b 100644 --- a/docs/source/tutorials/repeating_tasks_with_different_inputs.md +++ b/docs/source/tutorials/repeating_tasks_with_different_inputs.md @@ -268,8 +268,7 @@ the {func}`@task ` decorator to pass keyword arguments to the task. for id_, kwargs in ID_TO_KWARGS.items(): @task(id=id_, kwargs=kwargs) - def task_create_random_data(seed, produces): - ... + def task_create_random_data(seed, produces): ... ``` Writing a function that creates `ID_TO_KWARGS` would be even more pythonic. @@ -289,8 +288,7 @@ ID_TO_KWARGS = create_parametrization() for id_, kwargs in ID_TO_KWARGS.items(): @task(id=id_, kwargs=kwargs) - def task_create_random_data(i, produces): - ... + def task_create_random_data(i, produces): ... ``` The {doc}`best-practices guide on parametrizations <../how_to_guides/bp_scaling_tasks>` diff --git a/docs/source/tutorials/selecting_tasks.md b/docs/source/tutorials/selecting_tasks.md index 266b47bf..23b06903 100644 --- a/docs/source/tutorials/selecting_tasks.md +++ b/docs/source/tutorials/selecting_tasks.md @@ -91,8 +91,7 @@ from pytask import task for i in range(2): @task - def task_parametrized(i=i): - ... + def task_parametrized(i=i): ... ``` To run the task where `i = 1`, run this command. diff --git a/docs/source/tutorials/skipping_tasks.md b/docs/source/tutorials/skipping_tasks.md index 7278ee3e..e223b1cd 100644 --- a/docs/source/tutorials/skipping_tasks.md +++ b/docs/source/tutorials/skipping_tasks.md @@ -42,8 +42,9 @@ from config import NO_LONG_RUNNING_TASKS @pytask.mark.skipif(NO_LONG_RUNNING_TASKS, reason="Skip long-running tasks.") -def task_that_takes_really_long_to_run(path: Path = Path("time_intensive_product.pkl")): - ... +def task_that_takes_really_long_to_run( + path: Path = Path("time_intensive_product.pkl"), +): ... ``` ## Further reading diff --git a/docs/source/tutorials/write_a_task.md b/docs/source/tutorials/write_a_task.md index 9d949077..9ecc3bbc 100644 --- a/docs/source/tutorials/write_a_task.md +++ b/docs/source/tutorials/write_a_task.md @@ -117,16 +117,14 @@ from pytask import task @task -def create_random_data(): - ... +def create_random_data(): ... # The id will be ".../task_data_preparation.py::create_data". @task(name="create_data") -def create_random_data(): - ... +def create_random_data(): ... ``` ## Customize task module names diff --git a/docs_src/how_to_guides/bp_scaling_tasks_2.py b/docs_src/how_to_guides/bp_scaling_tasks_2.py index d52731a6..f31cfc64 100644 --- a/docs_src/how_to_guides/bp_scaling_tasks_2.py +++ b/docs_src/how_to_guides/bp_scaling_tasks_2.py @@ -34,6 +34,6 @@ def task_prepare_data( path_to_processed_data: Annotated[Path, Product], ) -> None: df = pd.read_csv(path_to_input_data) - ... + # ... transform the data. subset = df.loc[df["subset"].eq(subset)] subset.to_pickle(path_to_processed_data) diff --git a/docs_src/tutorials/using_a_data_catalog_5_py310.py b/docs_src/tutorials/using_a_data_catalog_5_py310.py index 08a034b6..03e07a4b 100644 --- a/docs_src/tutorials/using_a_data_catalog_5_py310.py +++ b/docs_src/tutorials/using_a_data_catalog_5_py310.py @@ -12,5 +12,5 @@ def task_transform_csv( node: Annotated[PickleNode, Product] = data_catalog["transformed_csv"], ) -> None: df = pd.read_csv(path) - ... + # ... transform the data. node.save(df) diff --git a/docs_src/tutorials/using_a_data_catalog_5_py310_return.py b/docs_src/tutorials/using_a_data_catalog_5_py310_return.py index 41d4913d..28f03bd3 100644 --- a/docs_src/tutorials/using_a_data_catalog_5_py310_return.py +++ b/docs_src/tutorials/using_a_data_catalog_5_py310_return.py @@ -9,5 +9,5 @@ def task_transform_csv( path: Annotated[Path, data_catalog["csv"]], ) -> Annotated[pd.DataFrame, data_catalog["transformed_csv"]]: df = pd.read_csv(path) - ... + # ... transform the data return df diff --git a/docs_src/tutorials/using_a_data_catalog_5_py38.py b/docs_src/tutorials/using_a_data_catalog_5_py38.py index 5c3040bc..1f1d5735 100644 --- a/docs_src/tutorials/using_a_data_catalog_5_py38.py +++ b/docs_src/tutorials/using_a_data_catalog_5_py38.py @@ -12,5 +12,5 @@ def task_transform_csv( node: Annotated[PickleNode, Product] = data_catalog["transformed_csv"], ) -> None: df = pd.read_csv(path) - ... + # ... transform the data node.save(df) diff --git a/pyproject.toml b/pyproject.toml index 7e5aa4f3..934c73a2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -105,8 +105,11 @@ namespaces = false [tool.ruff] target-version = "py38" -select = ["ALL"] fix = true +extend-include = ["*.ipynb"] + +[tool.ruff.lint] +select = ["ALL"] ignore = [ "FBT", # flake8-boolean-trap "I", # ignore isort @@ -125,7 +128,7 @@ ignore = [ ] -[tool.ruff.per-file-ignores] +[tool.ruff.lint.per-file-ignores] "src/_pytask/_hashlib.py" = ["ALL"] "src/_pytask/capture.py" = ["PGH003"] "src/_pytask/hookspecs.py" = ["ARG001"] @@ -141,9 +144,10 @@ ignore = [ "docs/source/how_to_guides/functional_interface*" = ["B018", "D", "INP", "ARG005"] "docs_src/how_to_guides/using_task_returns_*_task.py" = ["ARG005", "E731"] "docs_src/how_to_guides/writing_custom_nodes_*.py" = ["S301"] +"docs_src/tutorials/using_a_data_catalog_*.py" = ["RET504"] -[tool.ruff.pydocstyle] +[tool.ruff.lint.pydocstyle] convention = "numpy" [tool.pytest.ini_options]