feat: ValidationFailure is now ValidationError

- ref https://peps.python.org/pep-0008/#exception-names - import sorted using ruff - adds project URLs
yozachar · Aug 1, 2023 · 12ae1f5 · 12ae1f5
1 parent 95ec1fa
commit 12ae1f5
Show file tree

Hide file tree

Showing 42 changed files with 187 additions and 175 deletions.
diff --git a/build_pkg.py b/build_pkg.py
@@ -1,10 +1,9 @@
 """Remove Refs."""
 
 # standard
-from subprocess import run
-
 # from shutil import rmtree
 from pathlib import Path
+from subprocess import run  # nosec
 
 # local
 from docs.gen_docs import generate_documentation
@@ -13,5 +12,8 @@
     project_dir = Path(__file__).parent
     generate_documentation(project_dir, only_rst_man=True)
     print()
-    process = run(("poetry", "build"), capture_output=True)
+    process = run(("poetry", "build"), capture_output=True)  # nosec
     print(process.stderr.decode() + process.stdout.decode())
+
+
+# TODO: Address all '# nosec'
diff --git a/docs/conf.py b/docs/conf.py
@@ -5,8 +5,8 @@
 """
 
 # standard
-from importlib.metadata import metadata
 from datetime import datetime
+from importlib.metadata import metadata
 
 # -- Project information ----------------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

diff --git a/docs/gen_docs.py b/docs/gen_docs.py
@@ -2,12 +2,12 @@
 # -*- coding: utf-8 -*-
 
 # standard
-from shutil import rmtree, move, copy
-from ast import parse, ImportFrom
-from typing import List, Dict
+from ast import ImportFrom, parse
 from os.path import getsize
-from subprocess import run
 from pathlib import Path
+from shutil import copy, move, rmtree
+from subprocess import run  # nosec
+from typing import Dict, List
 
 __all__ = ("generate_documentation",)
 
@@ -53,7 +53,7 @@ def _generate_reference(source: Path, destination: Path, ext: str):
 def _update_mkdocs_config(source: Path, destination: Path, nav_items: Dict[str, List[str]]):
     """Temporary update to mkdocs config."""
     # external
-    from yaml import safe_load, safe_dump
+    from yaml import safe_dump, safe_load
 
     copy(source, destination)
     with open(source, "rt") as mkf:
@@ -69,7 +69,7 @@ def _gen_md_docs(source: Path, refs_path: Path):
     # backup mkdocs config
     _update_mkdocs_config(source / "mkdocs.yaml", source / "mkdocs.bak.yaml", nav_items)
     # build mkdocs as subprocess
-    mkdocs_build = run(("mkdocs", "build"), capture_output=True)
+    mkdocs_build = run(("mkdocs", "build"), capture_output=True)  # nosec
     print(mkdocs_build.stderr.decode() + mkdocs_build.stdout.decode())
     # restore mkdocs config
     move(str(source / "mkdocs.bak.yaml"), source / "mkdocs.yaml")
@@ -96,12 +96,12 @@ def _gen_rst_docs(source: Path, refs_path: Path, only_web: bool = False, only_ma
     rc = 0
     if not only_man:
         # build sphinx web pages as subprocess
-        web_build = run(("sphinx-build", "docs", "docs/_build/web"), capture_output=True)
+        web_build = run(("sphinx-build", "docs", "docs/_build/web"), capture_output=True)  # nosec
         print(web_build.stderr.decode() + web_build.stdout.decode())
         rc = web_build.returncode
     if not only_web:
         # build sphinx man pages as subprocess
-        man_build = run(
+        man_build = run(  # nosec
             ("sphinx-build", "-b", "man", "docs", "docs/_build/man"), capture_output=True
         )
         print(man_build.stderr.decode() + man_build.stdout.decode())
@@ -155,3 +155,5 @@ def generate_documentation(
         # # for debugging
     )
     quit(rc)
+
+# TODO: Address all '# nosec'
diff --git a/pyproject.toml b/pyproject.toml
@@ -7,9 +7,8 @@ name = "validators"
 version = "0.21.1"
 description = "Python Data Validation for Humans™"
 authors = [{ name = "Konsta Vesterinen", email = "[email protected]" }]
-requires-python = ">=3.8"
-readme = "README.md"
 license = { text = "MIT" }
+readme = "README.md"
 keywords = ["validation", "validator", "python-validator"]
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -26,12 +25,18 @@ classifiers = [
     "Programming Language :: Python :: Implementation :: CPython",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
+requires-python = ">=3.8"
+dependencies = []
 
-####################
-#   Dependencies   #
-####################
+[project.urls]
+Homepage = "https://python-validators.github.io/validators"
+Documentation = "https://python-validators.github.io/validators"
+Repository = "https://github.com/python-validators/validators"
+Changelog = "https://github.com/python-validators/validators/blob/master/CHANGES.md"
 
-dependencies = []
+###########################
+#  Optional Dependencies  #
+###########################
 
 [project.optional-dependencies]
 docs-offline = ["myst-parser>=2.0.0", "pypandoc-binary>=1.11", "sphinx>=7.1.1"]
@@ -75,12 +80,15 @@ line-length = 100
 target-version = ["py38", "py39", "py310", "py311"]
 
 [tool.pyright]
-include = ["src", "tests"]
+extraPaths = ["src"]
 exclude = ["**/__pycache__", ".pytest_cache/", ".tox/", ".venv/", "site/"]
 pythonVersion = "3.8"
 pythonPlatform = "All"
 typeCheckingMode = "strict"
 
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
 [tool.ruff]
 select = ["E", "F", "I", "N", "D"]
 line-length = 100
@@ -107,25 +115,33 @@ env_list = lint, type, format, sast, py{38,39,310,311}
 
 [testenv:lint]
 description = ruff linter
-deps = ruff
+deps =
+    ruff
 commands = ruff check .
 
 [testenv:type]
 description = pyright type checker
-deps = pyright
+deps =
+    pyright
+    pyaml
+    pypandoc-binary
+    pytest
 commands = pyright .
 
 [testenv:format]
 description = code formatter
-deps = black
+deps =
+    black
 commands = black .
 
 [testenv:sast]
-deps = bandit[toml]
+deps =
+    bandit[toml]
 commands = bandit -c pyproject.toml -r .
 
 [testenv]
 description = unit tests
-deps = pytest
+deps =
+    pytest
 commands = pytest .
 """
diff --git a/src/validators/__init__.py b/src/validators/__init__.py
@@ -23,7 +23,7 @@
 from .mac_address import mac_address
 from .slug import slug
 from .url import url
-from .utils import validator, ValidationFailure
+from .utils import validator, ValidationError
 from .uuid import uuid
 
 # from .crypto_addresses import eth_address
@@ -57,7 +57,7 @@
     "unionpay",
     "url",
     "uuid",
-    "ValidationFailure",
+    "ValidationError",
     "validator",
     "visa",
     # i18n

diff --git a/src/validators/between.py b/src/validators/between.py
@@ -34,7 +34,7 @@ def between(
         >>> between(13.2, min_val=13, max_val=14)
         # Output: True
         >>> between(500, max_val=400)
-        # Output: ValidationFailure(func=between, args=...)
+        # Output: ValidationError(func=between, args=...)
         >>> between(
         ...     datetime(2000, 11, 11),
         ...     min_val=datetime(1999, 11, 11)
@@ -54,7 +54,7 @@ def between(
     Returns:
         (Literal[True]):
             If `value` is in between the given conditions.
-        (ValidationFailure):
+        (ValidationError):
             If `value` is not in between the given conditions.
 
     Raises:

diff --git a/src/validators/btc_address.py b/src/validators/btc_address.py
@@ -36,7 +36,7 @@ def btc_address(value: str, /):
         >>> btc_address('3Cwgr2g7vsi1bXDUkpEnVoRLA9w4FZfC69')
         # Output: True
         >>> btc_address('1BvBMsEYstWetqTFn5Au4m4GFg7xJaNVN2')
-        # Output: ValidationFailure(func=btc_address, args=...)
+        # Output: ValidationError(func=btc_address, args=...)
 
     Args:
         value:
@@ -45,7 +45,7 @@ def btc_address(value: str, /):
     Returns:
         (Literal[True]):
             If `value` is a valid bitcoin address.
-        (ValidationFailure):
+        (ValidationError):
             If `value` is an invalid bitcoin address.
 
     > *New in version 0.18.0*.

diff --git a/src/validators/card.py b/src/validators/card.py
@@ -20,7 +20,7 @@ def card_number(value: str, /):
         >>> card_number('4242424242424242')
         # Output: True
         >>> card_number('4242424242424241')
-        # Output: ValidationFailure(func=card_number, args={'value': '4242424242424241'})
+        # Output: ValidationError(func=card_number, args={'value': '4242424242424241'})
 
     Args:
         value:
@@ -29,7 +29,7 @@ def card_number(value: str, /):
     Returns:
         (Literal[True]):
             If `value` is a valid generic card number.
-        (ValidationFailure):
+        (ValidationError):
             If `value` is an invalid generic card number.
 
     > *New in version 0.15.0*.
@@ -53,7 +53,7 @@ def visa(value: str, /):
         >>> visa('4242424242424242')
         # Output: True
         >>> visa('2223003122003222')
-        # Output: ValidationFailure(func=visa, args={'value': '2223003122003222'})
+        # Output: ValidationError(func=visa, args={'value': '2223003122003222'})
 
     Args:
         value:
@@ -62,7 +62,7 @@ def visa(value: str, /):
     Returns:
         (Literal[True]):
             If `value` is a valid Visa card number.
-        (ValidationFailure):
+        (ValidationError):
             If `value` is an invalid Visa card number.
 
     > *New in version 0.15.0*.
@@ -79,7 +79,7 @@ def mastercard(value: str, /):
         >>> mastercard('5555555555554444')
         # Output: True
         >>> mastercard('4242424242424242')
-        # Output: ValidationFailure(func=mastercard, args={'value': '4242424242424242'})
+        # Output: ValidationError(func=mastercard, args={'value': '4242424242424242'})
 
     Args:
         value:
@@ -88,7 +88,7 @@ def mastercard(value: str, /):
     Returns:
         (Literal[True]):
             If `value` is a valid Mastercard card number.
-        (ValidationFailure):
+        (ValidationError):
             If `value` is an invalid Mastercard card number.
 
     > *New in version 0.15.0*.
@@ -105,7 +105,7 @@ def amex(value: str, /):
         >>> amex('378282246310005')
         # Output: True
         >>> amex('4242424242424242')
-        # Output: ValidationFailure(func=amex, args={'value': '4242424242424242'})
+        # Output: ValidationError(func=amex, args={'value': '4242424242424242'})
 
     Args:
         value:
@@ -114,7 +114,7 @@ def amex(value: str, /):
     Returns:
         (Literal[True]):
             If `value` is a valid American Express card number.
-        (ValidationFailure):
+        (ValidationError):
             If `value` is an invalid American Express card number.
 
     > *New in version 0.15.0*.
@@ -131,7 +131,7 @@ def unionpay(value: str, /):
         >>> unionpay('6200000000000005')
         # Output: True
         >>> unionpay('4242424242424242')
-        # Output: ValidationFailure(func=unionpay, args={'value': '4242424242424242'})
+        # Output: ValidationError(func=unionpay, args={'value': '4242424242424242'})
 
     Args:
         value:
@@ -140,7 +140,7 @@ def unionpay(value: str, /):
     Returns:
         (Literal[True]):
             If `value` is a valid UnionPay card number.
-        (ValidationFailure):
+        (ValidationError):
             If `value` is an invalid UnionPay card number.
 
     > *New in version 0.15.0*.
@@ -157,7 +157,7 @@ def diners(value: str, /):
         >>> diners('3056930009020004')
         # Output: True
         >>> diners('4242424242424242')
-        # Output: ValidationFailure(func=diners, args={'value': '4242424242424242'})
+        # Output: ValidationError(func=diners, args={'value': '4242424242424242'})
 
     Args:
         value:
@@ -166,7 +166,7 @@ def diners(value: str, /):
     Returns:
         (Literal[True]):
             If `value` is a valid Diners Club card number.
-        (ValidationFailure):
+        (ValidationError):
             If `value` is an invalid Diners Club card number.
 
     > *New in version 0.15.0*.
@@ -183,7 +183,7 @@ def jcb(value: str, /):
         >>> jcb('3566002020360505')
         # Output: True
         >>> jcb('4242424242424242')
-        # Output: ValidationFailure(func=jcb, args={'value': '4242424242424242'})
+        # Output: ValidationError(func=jcb, args={'value': '4242424242424242'})
 
     Args:
         value:
@@ -192,7 +192,7 @@ def jcb(value: str, /):
     Returns:
         (Literal[True]):
             If `value` is a valid JCB card number.
-        (ValidationFailure):
+        (ValidationError):
             If `value` is an invalid JCB card number.
 
     > *New in version 0.15.0*.
@@ -209,7 +209,7 @@ def discover(value: str, /):
         >>> discover('6011111111111117')
         # Output: True
         >>> discover('4242424242424242')
-        # Output: ValidationFailure(func=discover, args={'value': '4242424242424242'})
+        # Output: ValidationError(func=discover, args={'value': '4242424242424242'})
 
     Args:
         value:
@@ -218,7 +218,7 @@ def discover(value: str, /):
     Returns:
         (Literal[True]):
             If `value` is a valid Discover card number.
-        (ValidationFailure):
+        (ValidationError):
             If `value` is an invalid Discover card number.
 
     > *New in version 0.15.0*.

diff --git a/src/validators/domain.py b/src/validators/domain.py
@@ -16,7 +16,7 @@ def domain(value: str, /, *, rfc_1034: bool = False, rfc_2782: bool = False):
         >>> domain('example.com')
         # Output: True
         >>> domain('example.com/')
-        # Output: ValidationFailure(func=domain, ...)
+        # Output: ValidationError(func=domain, ...)
         >>> # Supports IDN domains as well::
         >>> domain('xn----gtbspbbmkef.xn--p1ai')
         # Output: True
@@ -35,7 +35,7 @@ def domain(value: str, /, *, rfc_1034: bool = False, rfc_2782: bool = False):
     Returns:
         (Literal[True]):
             If `value` is a valid domain name.
-        (ValidationFailure):
+        (ValidationError):
             If `value` is an invalid domain name.
 
     Note: