pydocstyle is unmaintained, switch to ruff

Author: mr-c

.gitignore

@@ -106,7 +106,6 @@ venv.bak/
 .vscode/
 
 testenv*/
-pydocstyle_report.txt
 
 # PyCharm
 .idea/

Makefile

@@ -29,10 +29,10 @@ EXTRAS=
 PYSOURCES=$(filter-out $(MODULE)/parser/cwl_v%,$(shell find $(MODULE) -name "*.py")) \
 	  $(wildcard tests/*.py) create_cwl_from_objects.py load_cwl_by_path.py \
 	  ${MODULE}/parser/cwl_v1_?_utils.py docs/conf.py
-DEVPKGS=build diff_cover pylint pep257 pydocstyle 'tox<4' tox-pyenv \
+DEVPKGS=build diff_cover pylint pep257 ruff 'tox<4' tox-pyenv \
 	wheel autoflake pyupgrade bandit auto-walrus \
 	-rlint-requirements.txt -rtest-requirements.txt -rmypy-requirements.txt
-DEBDEVPKGS=pep8 python-autopep8 pylint python-coverage pydocstyle sloccount \
+DEBDEVPKGS=pep8 python-autopep8 pylint python-coverage ruff sloccount \
 	   python-flake8 python-mock shellcheck
 VERSION=v$(shell echo $$(tail -n 1 cwl_utils/__meta__.py | awk '{print $$3}'))
 mkfile_dir := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
@@ -45,8 +45,8 @@ all: dev
 help: Makefile
 	@sed -n 's/^##//p' $<
 
-## cleanup                : shortcut for "make sort_imports format flake8 diff_pydocstyle_report"
-cleanup: sort_imports format flake8 diff_pydocstyle_report
+## cleanup                : shortcut for "make sort_imports format flake8 pydocstyle"
+cleanup: sort_imports format flake8 pydocstyle
 
 ## install-dep            : install most of the development dependencies via pip
 install-dep: install-dependencies
@@ -95,14 +95,7 @@ remove_unused_imports: $(PYSOURCES)
 pep257: pydocstyle
 ## pydocstyle             : check Python docstring style
 pydocstyle: $(PYSOURCES)
-	pydocstyle --add-ignore=D100,D101,D102,D103 $^ || true
-
-pydocstyle_report.txt: $(PYSOURCES)
-	pydocstyle $^ > $@ 2>&1 || true
-
-## diff_pydocstyle_report : check Python docstring style for changed files only
-diff_pydocstyle_report: pydocstyle_report.txt
-	diff-quality --compare-branch=main --violations=pydocstyle --fail-under=100 $^
+	ruff check $^
 
 ## codespell              : check for common misspellings
 codespell:

cwl_utils/parser/__init__.py

@@ -142,7 +142,8 @@ def _get_id_from_graph(yaml: MutableMapping[str, Any], id_: Optional[str]) -> An
 
 
 def cwl_version(yaml: Any) -> Optional[str]:
-    """Return the cwlVersion of a YAML object.
+    """
+    Return the cwlVersion of a YAML object.
 
     :param yaml: ruamel.yaml object for a CWL document
 

pyproject.toml

@@ -86,3 +86,19 @@ dependencies = {file = ["requirements.txt"]}
 
 [tool.isort]
 profile = "black"
+
+[tool.ruff.lint]
+select = [
+  "D",   # pydocstyle
+]
+ignore = [
+  "D100",
+  "D101",
+  "D102",
+  "D103",
+  "D104",
+  "D105",
+  "D107",
+  "D203",
+  "D212",
+]

tests/load_cwl_by_path.py

@@ -1,4 +1,8 @@
-"""This is the example from README.md, please synchronize all changes between the two."""
+"""
+Example from README.md.
+
+Please synchronize all changes between the two.
+"""
 
 # SPDX-License-Identifier: Apache-2.0
 from pathlib import Path

tests/test_docker_extract.py

@@ -22,7 +22,6 @@
 )
 def test_container_extraction(target: str, engine: str, tmp_path: Path) -> None:
     """Test container extraction tool."""
-
     args = ["--dir", str(tmp_path), get_data(target), "--container-engine", engine]
     if engine == "singularity":
         args.append("--singularity")
@@ -41,7 +40,6 @@ def test_container_extraction(target: str, engine: str, tmp_path: Path) -> None:
 )
 def test_container_extraction_force(engine: str, tmp_path: Path) -> None:
     """Test force pull container extraction."""
-
     args = [
         "--dir",
         str(tmp_path),
@@ -81,7 +79,6 @@ def test_container_extraction_no_dockerPull(
     engine: str, tmp_path: Path, capsys: pytest.CaptureFixture[str]
 ) -> None:
     """Test container extraction tool when dockerPull is missing."""
-
     args = [
         "--dir",
         str(tmp_path),
@@ -114,7 +111,6 @@ def test_container_extraction_no_dockerPull(
 )
 def test_container_extraction_embedded_step(engine: str, tmp_path: Path) -> None:
     """Test container extraction tool."""
-
     args = [
         "--dir",
         str(tmp_path),

tox.ini

@@ -64,10 +64,9 @@ extras =
 
 [testenv:py312-pydocstyle]
 allowlist_externals = make
-commands = make diff_pydocstyle_report
+commands = make pydocstyle
 deps =
-    pydocstyle
-    diff-cover
+    ruff
 skip_install = true
 
 [testenv:py312-lint-readme]