maint: misc fixes and improvements

- sorts import using `isort`
- return `False` on empty `value`
- fix invalid parameter name in `url` docstring
- use tuple when iterating over sequence
- `# project` is replaced by `# local`
- `pyaml` is an external library which provides `yaml`
- pre-commit-config now has `black`, `isort` and `flake8`
- tox can now run tests, formatting, linting and type-checking
- `i18n` exclusion is only temporary
- re-order some configurations in `pyproject.toml`

Author: yozachar

.pre-commit-config.yaml

@@ -11,17 +11,15 @@ repos:
       - id: debug-statements
       - id: destroyed-symlinks
       - id: trailing-whitespace
-  # will be uncommented when all the
-  # scripts have been revised once
-  # - repo: https://github.com/psf/black
-  #   rev: 23.1.0
-  #   hooks:
-  #     - id: black
-  # - repo: https://github.com/PyCQA/isort
-  #   rev: 5.12.0
-  #   hooks:
-  #     - id: isort
-  # - repo: https://github.com/PyCQA/flake8
-  #   rev: 6.0.0
-  #   hooks:
-  #     - id: flake8
+  - repo: https://github.com/psf/black
+    rev: 23.1.0
+    hooks:
+      - id: black
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+  - repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8

docs/gen_docs.py

@@ -1,15 +1,17 @@
 """Generate docs."""
 
 # standard
-from shutil import copy, move, rmtree
-from yaml import safe_load, safe_dump
+from shutil import rmtree, move, copy
 from ast import parse, ImportFrom
-from typing import Dict, List
+from typing import List, Dict
 from os.path import getsize
 from subprocess import run
 from pathlib import Path
 from sys import argv
 
+# external
+from yaml import safe_load, safe_dump
+
 
 def _write_ref_content(source: Path, module_name: str, func_name: str):
     """Write content."""
@@ -61,7 +63,7 @@ def generate_documentation(source: Path):
     # build docs as subprocess
     print(run(("mkdocs", "build"), capture_output=True).stderr.decode())
     # restore mkdocs config
-    move(source / "mkdocs.bak.yml", source / "mkdocs.yml")
+    move(str(source / "mkdocs.bak.yml"), source / "mkdocs.yml")
 
 
 if __name__ == "__main__":

poetry.lock

@@ -35,6 +35,7 @@ tox = "^4.4.7"
 mkdocs = "^1.4.2"
 mkdocs-material = "^9.1.3"
 mkdocstrings = { extras = ["python"], version = "^0.20.0" }
+pyaml = "^21.10.1"
 
 [tool.poetry.group.sast.dependencies]
 bandit = "^1.7.5"
@@ -60,38 +61,31 @@ build-backend = "poetry.core.masonry.api"
 [tool.black]
 line-length = 100
 target-version = ["py38", "py39", "py310", "py311"]
+extend-exclude = "i18n"
 
 [tool.bandit]
-exclude_dirs = [
-    ".github",
-    ".pytest_cache",
-    ".tox",
-    ".vscode",
-    "docs",
-    "site",
-    "tests",
-]
+exclude_dirs = [".github", ".pytest_cache", ".tox", ".vscode", "site", "tests"]
 
 [tool.isort]
-extend_skip_glob = ["**/i18n/*"]
 ensure_newline_before_comments = true
+extend_skip_glob = ["**/i18n/*"]
 force_grid_wrap = 0
 force_sort_within_sections = true
 ignore_comments = true
 include_trailing_comma = true
 known_local_folder = ["validators"]
-line_length = 100
 length_sort = true
+line_length = 100
 multi_line_output = 3
 profile = "black"
-reverse_sort = true
 reverse_relative = true
+reverse_sort = true
 skip_gitignore = true
 use_parentheses = true
 
 [tool.pyright]
 include = ["validators", "tests"]
-exclude = ["**/__pycache__", ".pytest_cache/", ".tox/", "site/"]
+exclude = ["**/__pycache__", ".pytest_cache/", ".tox/", "site/", "**/i18n/*"]
 pythonVersion = "3.8"
 pythonPlatform = "All"
 typeCheckingMode = "strict"
@@ -102,25 +96,32 @@ legacy_tox_ini = """
     requires =
         tox >= 4.0
     env_list = py{38,39,310,311}
-        # format, lint, type,
+        fmt_black, fmt_isort, lint, type
 
     [testenv]
     description = run unit tests
     deps = pytest
     commands = pytest
 
-    # [testenv:format]
-    # description = run formatter
-    # deps = black
-    # commands = black
-
-    # [testenv:lint]
-    # description = run linters
-    # deps = flake8
-    # commands = flake8
-
-    # [testenv:type]
-    # description = run type checker
-    # deps = pyright
-    # commands = pyright
+    [testenv:fmt_black]
+    description = run formatter
+    deps = black
+    commands = black .
+
+    [testenv:fmt_isort]
+    description = run formatter
+    deps = isort
+    commands = isort .
+
+    [testenv:lint]
+    description = run linters
+    deps = flake8
+    commands = flake8
+
+    [testenv:type]
+    description = run type checker
+    deps =
+        pyright
+        pytest
+    commands = pyright
 """

pyproject.toml

@@ -1,5 +1,6 @@
 # until https://github.com/PyCQA/flake8/issues/234 is resolved
 
 [flake8]
-max-line-length = 100
 docstring-convention = google
+exclude = __pycache__,.github,.pytest_cache,.tox,.vscode,site,i18n
+max-line-length = 100

setup.cfg

@@ -7,8 +7,8 @@
 # external
 import pytest
 
-# project
-from validators._extremes import AbsMax, AbsMin
+# local
+from validators._extremes import AbsMin, AbsMax
 
 abs_max = AbsMax()
 abs_min = AbsMin()

tests/test__extremes.py

@@ -6,7 +6,6 @@
 
 # local
 from validators import (
-    ValidationFailure,
     card_number,
     mastercard,
     unionpay,
@@ -15,6 +14,7 @@
     visa,
     amex,
     jcb,
+    ValidationFailure,
 )
 
 visa_cards = ["4242424242424242", "4000002760003184"]

tests/test_card.py

@@ -5,8 +5,7 @@
 import pytest
 
 # local
-from validators import md5, sha1, sha224, sha256, sha512, ValidationFailure
-
+from validators import sha512, sha256, sha224, sha1, md5, ValidationFailure
 
 # ==> md5 <== #
 

tests/test_hashes.py

@@ -5,7 +5,7 @@
 import pytest
 
 # local
-from validators import ipv4, ipv6, ValidationFailure
+from validators import ipv6, ipv4, ValidationFailure
 
 
 @pytest.mark.parametrize(

tests/test_ip_address.py

@@ -4,7 +4,7 @@
 # external
 import pytest
 
-# project
+# local
 from validators import length, ValidationFailure