Merge pull request #1787 from VWS-Python/switch-to-ruff

Switch from flake8/isort to ruff

Author: adamtheturtle

Makefile

@@ -10,24 +10,20 @@ lint: \
     black \
     check-manifest \
     doc8 \
-    flake8 \
-    isort \
     linkcheck \
     mypy \
+    ruff \
     pip-extra-reqs \
     pip-missing-reqs \
     pyroma \
     spelling \
     vulture \
-    pylint \
-    pydocstyle \
+    pylint
 
 .PHONY: fix-lint
 fix-lint: \
-    add-trailing-comma \
-    autoflake \
     fix-black \
-    fix-isort
+    fix-ruff
 
 .PHONY: docs
 docs:

docs/source/__init__.py

@@ -0,0 +1 @@
+"""Documentation."""

docs/source/conf.py

@@ -26,7 +26,7 @@
 source_suffix = ".rst"
 master_doc = "index"
 
-year = datetime.datetime.now().year
+year = datetime.datetime.now(tz=datetime.UTC).year
 project_copyright = f"{year}, {author}"
 
 # The version info for the project you're documenting, acts as replacement for

lint.mk

@@ -22,17 +22,13 @@ check-manifest:
 doc8:
 	doc8 .
 
-.PHONY: flake8
-flake8:
-	flake8 .
+.PHONY: ruff
+ruff:
+	ruff .
 
-.PHONY: isort
-isort:
-	isort --check-only .
-
-.PHONY: fix-isort
-fix-isort:
-	isort .
+.PHONY: fix-ruff
+fix-ruff:
+	ruff --fix .
 
 .PHONY: pip-extra-reqs
 pip-extra-reqs:
@@ -61,22 +57,3 @@ linkcheck:
 .PHONY: spelling
 spelling:
 	$(MAKE) -C docs/ spelling SPHINXOPTS=$(SPHINXOPTS)
-
-.PHONY: autoflake
-autoflake:
-	autoflake \
-	    --in-place \
-	    --recursive \
-	    --remove-all-unused-imports \
-	    --remove-unused-variables \
-	    --expand-star-imports \
-	    --exclude _vendor,release \
-	    .
-
-.PHONY: pydocstyle
-pydocstyle:
-	pydocstyle
-
-.PHONY: add-trailing-comma
-add-trailing-comma:
-	add-trailing-comma $$(find . -type f -name '*.py') --exit-zero-even-if-changed

pyproject.toml

@@ -48,18 +48,18 @@
         'too-many-return-statements',
         'too-many-lines',
         'locally-disabled',
-        # Let flake8 handle long lines
+        # Let ruff handle long lines
         'line-too-long',
-        # Let flake8 handle unused imports
+        # Let ruff handle unused imports
         'unused-import',
-        # Let isort deal with sorting
+        # Let ruff deal with sorting
         'ungrouped-imports',
         # We don't need everything to be documented because of mypy
         'missing-type-doc',
         'missing-return-type-doc',
         # Too difficult to please
         'duplicate-code',
-        # Let isort handle imports
+        # Let ruff handle imports
         'wrong-import-order',
         # mypy does not want untyped parameters.
         'useless-type-doc',
@@ -88,11 +88,6 @@
 
 line-length = 79
 
-[tool.isort]
-
-multi_line_output = 3
-include_trailing_comma = true
-
 [tool.coverage.run]
 
 branch = true
@@ -106,16 +101,7 @@ log_cli = true
 
 ignore = [
     "*.enc",
-    ".appveyor.yml",
-    ".coveragerc",
-    ".isort.cfg",
-    ".markdownlint.json",
-    ".pydocstyle",
-    ".remarkrc",
-    ".readthedocs.yml",
     "readthedocs.yaml",
-    ".style.yapf",
-    ".travis.yml",
     "CHANGELOG.rst",
     "CODE_OF_CONDUCT.rst",
     "CONTRIBUTING.rst",
@@ -128,9 +114,6 @@ ignore = [
     "docs",
     "docs/**",
     ".git_archival.txt",
-    "mypy.ini",
-    "pylintrc",
-    "pytest.ini",
     "spelling_private_dict.txt",
     "tests",
     "tests-pylintrc",
@@ -164,23 +147,50 @@ module = [
 
 ignore_missing_imports = true
 
-[tool.pydocstyle]
-# We do not have summary lines, care about "mood", or need sections with
-# dash underlined titles.
-ignore = [
-  'D200',
-  'D205',
-  'D400',
-  'D415',
-  'D202',
-  'D203',
-  'D212',
-  'D401',
-  'D406',
-  'D407',
-  'D413',
-]
-
 [build-system]
 requires = ["setuptools", "pip", "wheel"]
 build-backend = "setuptools.build_meta"
+
+[tool.ruff]
+select = ["ALL"]
+
+ignore = [
+    # We do not annotate the type of 'self'.
+    "ANN101",
+    # We are happy to manage our own "complexity".
+    "C901",
+    # Allow our chosen docstring line-style - no one-line summary.
+    "D200",
+    "D203",
+    "D205",
+    "D212",
+    "D213",
+    # Allow backslashes in a docstring.
+    # See https://click.palletsprojects.com/en/8.0.x/documentation/#preventing-rewrapping.
+    "D301",
+    # It is too much work to make every docstring imperative.
+    "D401",
+    # We ignore some docstyle errors which do not apply to Google style
+    # docstrings.
+    "D406",
+    "D407",
+    # We have an existing interface to support and so we do not want to change
+    # exception names.
+    "N818",
+    # Ignore "too-many-*" errors as they seem to get in the way more than
+    # helping.
+    "PLR0912",
+    "PLR0913",
+    # Allow 'assert' as we use it for tests.
+    "S101",
+    # Allow imports which are only used for type checking to be outside type
+    # checking blocks.
+    "TCH002",
+    "TCH003",
+]
+
+[tool.ruff.per-file-ignores]
+"tests/test_*.py" = [
+    # Do not require tests to have a one-line summary.
+    "D205",
+]

readthedocs.yaml

@@ -3,7 +3,7 @@ version: 2
 build:
   os: ubuntu-20.04
   tools:
-    python: "3.9"
+    python: "3.11"
 
 python:
   install:

requirements/dev-requirements.txt

@@ -4,16 +4,12 @@ Sphinx-Substitution-Extensions==2022.2.16
 Sphinx==6.1.3
 VWS-Python-Mock==2021.12.27.3
 VWS-Test-Fixtures==2022.1.3
-add-trailing-comma==2.4.0
-autoflake==2.0.1
 black==23.1.0
 check-manifest==0.49
 doc8==1.1.1
 dodgy==0.2.1  # Look for uploaded secrets
-flake8==6.0.0  # Lint
 freezegun==1.2.2
 furo==2022.12.7
-isort==5.12.0  # Lint imports
 mypy==1.0.0  # Type checking
 pip_check_reqs==2.4.3
 pydocstyle==6.3.0  # Lint docstrings
@@ -22,6 +18,7 @@ pylint==2.15.5  # Lint
 pyroma==4.1  # Packaging best practices checker
 pytest-cov==4.0.0  # Measure code coverage
 pytest==7.2.1  # Test runners
+ruff==0.0.247
 sphinx-autodoc-typehints==1.22
 sphinx-prompt==1.5.0
 sphinxcontrib-spelling==7.7.0

setup.cfg

@@ -1,7 +1,3 @@
-[flake8]
-exclude=./.eggs,
-        ./build/,
-
 [bdist_wheel]
 universal = 1
 

spelling_private_dict.txt

@@ -87,6 +87,7 @@ todo
 travis
 txt
 unmocked
+untyped
 url
 usefixtures
 validators

src/vws/query.py

@@ -92,7 +92,7 @@ def query(
 
         Returns:
             An ordered list of target details of matching targets.
-        """  # noqa: E501
+        """
         image_content = image.getvalue()
         body = {
             "image": ("image.jpeg", image_content, "image/jpeg"),
@@ -108,7 +108,7 @@ def query(
         (
             content,
             content_type_header,
-        ) = encode_multipart_formdata(  # type:ignore
+        ) = encode_multipart_formdata(  # type:ignore[no-untyped-call]
             fields=body,
         )
         method = "POST"
@@ -166,8 +166,9 @@ def query(
                 target_data_dict = item["target_data"]
                 metadata = target_data_dict["application_metadata"]
                 timestamp_string = target_data_dict["target_timestamp"]
-                target_timestamp = datetime.datetime.utcfromtimestamp(
+                target_timestamp = datetime.datetime.fromtimestamp(
                     timestamp_string,
+                    tz=datetime.UTC,
                 )
                 target_data = TargetData(
                     name=target_data_dict["name"],