feat: Tox support

nhs_number/generate.py

@@ -23,7 +23,6 @@ def generate(
     for_region: Region = None,
     quantity: int = 1,
 ) -> list:
-
     """
     Generates valid or invalid NHS numbers, for testing.
 

nhs_number/standardise.py

@@ -10,7 +10,9 @@
 * Marcus Baw <marcusbaw@gmail.com>
 """
 # standard imports
-from __future__ import annotations # for Python 3.7 (remove once we stop supporting 3.7)
+from __future__ import (
+    annotations,
+)  # for Python 3.7 (remove once we stop supporting 3.7)
 import re
 import warnings
 
@@ -51,6 +53,11 @@ def standardise_format(nhs_number: str | int) -> str:
 
 
 def normalise_number(nhs_number: str) -> str:
-    warnings.warn("The normalise_number() function is deprecated - use "
-                  "standardise_format() instead", DeprecationWarning)
+    warnings.warn(
+        (
+            "The normalise_number() function is deprecated - use "
+            "standardise_format() instead"
+        ),
+        DeprecationWarning,
+    )
     return standardise_format(nhs_number)

nhs_number/validate.py

@@ -9,7 +9,9 @@
 * Andy Law <andy.law@roslin.ed.ac.uk>
 * Marcus Baw <marcusbaw@gmail.com>
 """
-from __future__ import annotations # for Python 3.7 (remove once we stop supporting 3.7)
+from __future__ import (
+    annotations,
+)  # for Python 3.7 (remove once we stop supporting 3.7)
 from nhs_number.standardise import standardise_format
 from nhs_number.constants import Region
 

pyproject.toml

@@ -38,11 +38,13 @@ python = "^3.7"
 pytest = "^7.3.1"
 black = "^23.3.0"
 mkdocs-material = "^9.1.15"
+tox = "^4.8.0"
 
 
 [tool.poetry.urls]
 "Issue Tracker" = "https://github.com/uk-fci/nhs-number/issues"
 
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

tests/context.py

@@ -1,6 +1,8 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
+sys.path.insert(
+    0, os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
+)
 
 import nhs_number

tests/test_bulk_validation.py

@@ -17,10 +17,14 @@
 
 
 @pytest.mark.skipif(
-    not os.path.exists("local-test-data/testdata-909090-valid-nhs-numbers.csv"),
-    reason="This test requires a large list of valid NHS numbers which we do"
-           " not want to include in the repo by default for reasons of file"
-           " size",
+    not os.path.exists(
+        "local-test-data/testdata-909090-valid-nhs-numbers.csv"
+    ),
+    reason=(
+        "This test requires a large list of valid NHS numbers which we do"
+        " not want to include in the repo by default for reasons of file"
+        " size"
+    ),
 )
 def test_with_large_numbers_of_known_valid_nhs_numbers():
     with open(

tests/test_details.py

@@ -12,5 +12,7 @@ def test_valid_synthetic_nhs_number_details():
     assert number.calculated_checksum == 0
     assert isinstance(number.region, Region)
     assert "test" in number.region.tags
-    assert number.region_comment == ("Not to be issued "
-                                     "(Synthetic/test patients PDS)")
+    assert (
+        number.region_comment
+        == "Not to be issued (Synthetic/test patients PDS)"
+    )

tox.ini

@@ -0,0 +1,14 @@
+[tox]
+isolated_build = true
+envlist = black, py{37,38,39,310,311}
+
+[testenv]
+allowlist_externals = poetry
+commands =
+    poetry install -v
+    poetry run pytest --ignore=tests/test_bulk_validation.py
+
+[testenv:black]
+description = 'Check code format with Black'
+commands = poetry run black --check .
+