mesh-1697: switch to ruff to match other mesh repos

Author: johnwilliams57-nhs

.flake8

@@ -14,9 +14,23 @@ install-hooks:
 test:
 	@echo disable for spec only
 
-lint:
+black:
+	poetry run black .
+
+black-check:
+	poetry run black . --check
+
+ruff: black
+	poetry run ruff --fix --show-fixes .
+
+ruff-check:
+	poetry run ruff .
+
+ruff-ci:
+	poetry run ruff --output-format=github .
+
+lint: ruff
 	npm run lint
-	poetry run flake8
 
 publish:
 	npm run publish 2> /dev/null

Makefile

@@ -1,4 +1,5 @@
 [project]
+name="mesh_api_specification"
 python = "^3.8"
 
 
@@ -31,10 +32,64 @@ gitpython = "^3.1.30"
 
 
 [tool.poetry.dev-dependencies]
-flake8 = "^3.7.9"
-black = "^19.10b0"
+ruff = "^0.0.291"
+black = "^23.9.1"
 pip-licenses = "^2.0.1"
 jinja2 = "^2.11.2"
 
 
 [tool.poetry.scripts]
+
+[tool.poetry.group.dev.dependencies]
+black = "^23.9.1"
+
+[tool.black]
+line-length = 120
+target-version = ['py38', 'py39', 'py310', 'py311']
+include = '\.pyi?$'
+#extend-exclude = '''
+#/(
+#  # The following are specific to Black, you probably don't want those.
+#  | blib2to3
+#  | tests/data
+#  | profiling
+#)/
+#'''
+
+[tool.ruff]
+select = [
+    # See https://beta.ruff.rs/docs/rules/ for a full list
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "C",  # flake8-comprehensions
+    "B",  # flake8-bugbear
+    "Q", # flake8-quotes
+    "YTT", # flake8-2020
+    "RSE", # flake8-raise
+    "T10", # flake8-debugger
+    "ISC", # flake8-implicit-str-concat
+    "ICN", # flake8-import-conventions
+    "PIE", # flake8-pie
+    "EXE", # flake8-executable
+    "A", # flake8-builtins
+    "UP",  # pyupgrade
+    "PT", # flake8-pytest-style
+    "PERF", # Perflint #
+    "RUF", # Ruff-specific rules
+    "SIM", # flake8-simplify
+]
+src = ["."]
+ignore = [
+    "PT004",
+]
+exclude = [
+    ".git",
+    ".venv",
+]
+unfixable = ["SIM112"]
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.per-file-ignores]

poetry.lock

@@ -16,12 +16,13 @@
     +startversioning       Reset version to v1.0.0-alpha
 """
 
-import os.path
 import itertools
+import os.path
+from itertools import pairwise
+
 import git
 import semver
 
-
 SCRIPT_LOCATION = os.path.join(os.path.dirname(os.path.abspath(__file__)))
 REPO_ROOT = os.path.abspath(os.path.join(SCRIPT_LOCATION, ".."))
 REPO = git.Repo(REPO_ROOT)
@@ -33,9 +34,7 @@ def get_versionable_commits(repo):
     commits = [c for c in repo.iter_commits() if len(c.parents) == 1]
 
     # If there is a marker to start versioning from, use it. Else, start from the first commit
-    return list(
-        itertools.takewhile(lambda c: "+startversioning" not in c.message, commits)
-    )
+    return list(itertools.takewhile(lambda c: "+startversioning" not in c.message, commits))
 
 
 def is_status_set_command(commit):
@@ -55,7 +54,7 @@ def is_minor_inc(commit):
 
 def without_empty(commits):
     """Takes a list of commits and returns a list without empty commits"""
-    pairs = zip(commits, commits[1:])
+    pairs = pairwise(commits)
 
     for fst, snd in pairs:
         if fst.tree != snd.tree:
@@ -83,9 +82,7 @@ def calculate_version(base_major=1, base_minor=0, base_revision=0, base_pre="alp
         most_recent_message = status_sets[0].message.strip()
 
         if most_recent_message.startswith("+setstatus "):
-            pre = most_recent_message.split(" ")[
-                1
-            ]  # Take the first string after the command
+            pre = most_recent_message.split(" ")[1]  # Take the first string after the command
 
         if most_recent_message == "+clearstatus":
             pre = None

pyproject.toml

@@ -9,11 +9,12 @@
 import json
 import os
 import os.path
+
 from docopt import docopt
 from jsonpath_rw import parse
 
 
-def generate_resource_example(schema_dict, path=None):
+def generate_resource_example(schema_dict, path=None):  # noqa: C901 - complexity 11 instead of 10.
     """
     Generates resource examples from an OAS schema
 
@@ -29,50 +30,34 @@ def generate_resource_example(schema_dict, path=None):
         if property_value["type"] == "array":
             if "oneOf" in property_value["items"]:
                 example[property_name] = [
-                    generate_resource_example(t["properties"], path + [property_name])
+                    generate_resource_example(t["properties"], [*path, property_name])
                     for t in property_value["items"]["oneOf"]
                 ]
             elif "anyOf" in property_value["items"]:
                 example[property_name] = [
-                    generate_resource_example(t["properties"], path + [property_name])
+                    generate_resource_example(t["properties"], [*path, property_name])
                     for t in property_value["items"]["anyOf"]
                 ]
             elif property_value["items"]["type"] == "object":
                 example[property_name] = [
-                    generate_resource_example(
-                        property_value["items"]["properties"], path + [property_name]
-                    )
+                    generate_resource_example(property_value["items"]["properties"], [*path, property_name])
                 ]
             else:
                 if {"example", "default"} & set(property_value.get("items", {}).keys()):
                     items = property_value["items"]
-                    example[property_name] = [
-                        items.get("example", items.get("default"))
-                    ]
-                elif ("example" not in property_value) and (
-                    "default" not in property_value
-                ):
+                    example[property_name] = [items.get("example", items.get("default"))]
+                elif ("example" not in property_value) and ("default" not in property_value):
                     property_path = ".".join(path)
-                    raise RuntimeError(
-                        f"{property_path}.{property_name} has no example or default!"
-                    )
+                    raise RuntimeError(f"{property_path}.{property_name} has no example or default!")
                 else:
-                    example[property_name] = property_value.get(
-                        "example", property_value.get("default")
-                    )
+                    example[property_name] = property_value.get("example", property_value.get("default"))
         elif property_value["type"] == "object":
-            example[property_name] = generate_resource_example(
-                property_value["properties"], path + [property_name]
-            )
+            example[property_name] = generate_resource_example(property_value["properties"], [*path, property_name])
         else:
             if ("example" not in property_value) and ("default" not in property_value):
                 property_path = ".".join(path)
-                raise RuntimeError(
-                    f"{property_path}.{property_name} has no example or default!"
-                )
-            example[property_name] = property_value.get(
-                "example", property_value.get("default")
-            )
+                raise RuntimeError(f"{property_path}.{property_name} has no example or default!")
+            example[property_name] = property_value.get("example", property_value.get("default"))
 
     return example
 
@@ -82,7 +67,7 @@ def main(arguments):
     arguments = docopt(__doc__, version="0")
 
     # Load spec from file
-    with open(arguments["SPEC_FILE"], "r") as spec_file:
+    with open(arguments["SPEC_FILE"]) as spec_file:
         spec = json.loads(spec_file.read())
 
     # Create default dir structure
@@ -95,18 +80,10 @@ def main(arguments):
             os.path.join(arguments["OUT_DIR"], "resources", component_name + ".json"),
             "w",
         ) as out_file:
-            out_file.write(
-                json.dumps(
-                    generate_resource_example(
-                        component_spec["properties"], [component_name]
-                    )
-                )
-            )
+            out_file.write(json.dumps(generate_resource_example(component_spec["properties"], [component_name])))
 
     # Pull out responses
-    match_expr = parse(
-        "paths.*.*.(response|(responses.*)).content.*.(example|(examples.*.value))"
-    )
+    match_expr = parse("paths.*.*.(response|(responses.*)).content.*.(example|(examples.*.value))")
 
     for match in match_expr.find(spec):
         if "patch" in str(match.full_path):

scripts/calculate_version.py

@@ -50,9 +50,7 @@ def nhs_number_is_valid(nhs_number: str) -> bool:
 
 def main():
     """Main entrypoint"""
-    parser = argparse.ArgumentParser(
-        description="Validate NHS Numbers or generate check digit for a number"
-    )
+    parser = argparse.ArgumentParser(description="Validate NHS Numbers or generate check digit for a number")
     parser.add_argument(
         "operation",
         help="generate a check digit given 9-digit prefix, or validate a 10-digit NHS number",

scripts/generate_examples.py

@@ -5,8 +5,9 @@
 Reads an openapi spec on stdin and adds the calculated version to it,
 then prints it on stdout.
 """
-import sys
 import json
+import sys
+
 from calculate_version import calculate_version
 
 

scripts/nhs_number_utils.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 """
 template.py
 
@@ -15,9 +16,10 @@
   -f <path> --file=<path>   Template from file at path.
   -e --env                  Replace from environment variables instead of JSON argument.
 """
+import json
 import os
 import sys
-import json
+
 from docopt import docopt
 from jinja2 import Template
 
@@ -28,21 +30,21 @@ def replace(template, replacements):
 
 def main(args):
     template = ""
-    if args['--file']:
-        with open(args['--file'], 'r') as template_file:
+    if args["--file"]:
+        with open(args["--file"]) as template_file:
             template = template_file.read()
     else:
         template = sys.stdin.read()
 
     replacements = {}
-    if args['<replacements>']:
-        replacements = json.loads(args['<replacements>'])
-    elif args['--env']:
+    if args["<replacements>"]:
+        replacements = json.loads(args["<replacements>"])
+    elif args["--env"]:
         replacements = os.environ
 
     sys.stdout.write(replace(template, replacements))
     sys.stdout.close()
 
 
 if __name__ == "__main__":
-    main(docopt(__doc__, version='1'))
+    main(docopt(__doc__, version="1"))

scripts/set_version.py

@@ -2,6 +2,8 @@
 Tests for nhs_number_utils module
 """
 import unittest
+
+import pytest
 from nhs_number_utils import calculate_check_digit, nhs_number_is_valid
 
 VALID_NHS_NUMBERS = (
@@ -28,26 +30,26 @@ class CheckDigitCalculatorTestCase(unittest.TestCase):
     def test_check_digits_calculate(self):
         """Check that the check digit is correct"""
         for number in VALID_NHS_NUMBERS:
-            self.assertEqual(calculate_check_digit(number[:-1]), int(number[9]))
+            assert calculate_check_digit(number[:-1]) == int(number[9])
 
     def test_too_short_nhs_numbers_raise_exception(self):
         """Check that if the number is too short, an error is raised"""
-        with self.assertRaisesRegex(ValueError, "Expecting nine digits"):
+        with pytest.raises(ValueError, match="Expecting nine digits"):
             calculate_check_digit("12345678")
 
     def test_too_long_nhs_numbers_raise_exception(self):
         """Check that if the number is too long, an error is raised"""
-        with self.assertRaisesRegex(ValueError, "Expecting nine digits"):
+        with pytest.raises(ValueError, match="Expecting nine digits"):
             calculate_check_digit("1234567890")
 
     def test_providing_something_not_a_number_raises_exception(self):
         """Check that if the string is not numeric, an error is raised"""
-        with self.assertRaisesRegex(ValueError, "nhs_number must comprise only digits"):
+        with pytest.raises(ValueError, match="nhs_number must comprise only digits"):
             calculate_check_digit("A")
 
     def test_invalid_nhs_number_detection(self):
         """Check that invalid nhs numbers will be rejected"""
-        with self.assertRaisesRegex(ValueError, "Number is invalid"):
+        with pytest.raises(ValueError, match="Number is invalid"):
             calculate_check_digit("123456789")
 
 
@@ -57,24 +59,24 @@ class NhsNumberValidatorTestCase(unittest.TestCase):
     def test_valid_numbers_validate(self):
         """Check that valid numbers validate"""
         for number in VALID_NHS_NUMBERS:
-            self.assertTrue(nhs_number_is_valid(number))
+            assert nhs_number_is_valid(number)
 
     def test_invalid_nhs_numbers_are_detected(self):
         """Check that nvalid numbers don't validate"""
         for number in INVALID_NHS_NUMBERS:
-            self.assertFalse(nhs_number_is_valid(number))
+            assert not nhs_number_is_valid(number)
 
     def test_too_short_nhs_numbers_raise_exception(self):
         """Check that too short nhs numbers will raise an exception"""
-        with self.assertRaisesRegex(ValueError, "Expecting ten digits"):
+        with pytest.raises(ValueError, match="Expecting ten digits"):
             nhs_number_is_valid("12345678")
 
     def test_too_long_nhs_numbers_raise_exception(self):
         """Check that too long nhs numbers will raise an exception"""
-        with self.assertRaisesRegex(ValueError, "Expecting ten digits"):
+        with pytest.raises(ValueError, match="Expecting ten digits"):
             nhs_number_is_valid("12345678901")
 
     def test_providing_something_not_a_number_raises_exception(self):
         """Check that non-numeric nhs numbers will raise an exception"""
-        with self.assertRaisesRegex(ValueError, "nhs_number must comprise only digits"):
+        with pytest.raises(ValueError, match="nhs_number must comprise only digits"):
             nhs_number_is_valid("A")