Add linters configuration, reformat whole code

.github/workflows/tests.yml

@@ -14,8 +14,10 @@ jobs:
       fail-fast: false
       matrix:
         include:
+          - { python-version: "3.11", session: "black" }
           - { python-version: "3.11", session: "flake8" }
           - { python-version: "3.11", session: "mypy" }
+          - { python-version: "3.11", session: "isort" }
           - { python-version: "3.12", session: "py312" }
           - { python-version: "3.11", session: "py311" }
           - { python-version: "3.10", session: "py310" }

MANIFEST.in

@@ -2,5 +2,5 @@ include *.md
 include COPYING
 include voluptuous/tests/*.py
 include voluptuous/tests/*.md
-include pytest.ini
+include pyproject.toml
 include tox.ini

pyproject.toml

@@ -0,0 +1,18 @@
+[tool.black]
+target-version = ["py38", "py39", "py310", "py311", "py312"]
+skip-string-normalization = true
+
+[tool.isort]
+skip_gitignore = true
+profile = "black"
+multi_line_output = 5
+
+[tool.mypy]
+python_version = "3.8"
+
+warn_unused_ignores = true
+
+[tool.pytest.ini_options]
+python_files = "tests.py"
+testpaths = "voluptuous/tests"
+addopts = "--doctest-glob=*.md -v"

setup.py

@@ -1,7 +1,8 @@
+import io
+import sys
+
 from setuptools import setup
 
-import sys
-import io
 sys.path.insert(0, '.')
 version = __import__('voluptuous').__version__
 
@@ -38,5 +39,5 @@
         'Programming Language :: Python :: 3.10',
         'Programming Language :: Python :: 3.11',
         'Programming Language :: Python :: 3.12',
-    ]
+    ],
 )

tox.ini

@@ -1,10 +1,10 @@
 [tox]
-envlist = flake8,py38,py39,py310,py311,py312
+envlist = flake8,black,py38,py39,py310,py311,py312
 
 [flake8]
 ; E501: line too long (X > 79 characters)
-; W503 line break before binary operator
-ignore = E501,W503
+; E203, E704: black-related ignores (see https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#flake8)
+extend-ignore = E203, E501, E704
 exclude = .tox,.venv,build,*.egg
 
 [testenv]
@@ -28,3 +28,13 @@ deps =
     mypy
     pytest
 commands = mypy voluptuous
+
+[testenv:black]
+deps =
+    black
+commands = black --check .
+
+[testenv:isort]
+deps =
+    isort
+commands = isort --check .

voluptuous/__init__.py

@@ -1,9 +1,12 @@
 # flake8: noqa
-
+# fmt: off
 from voluptuous.schema_builder import *
-from voluptuous.validators import *
 from voluptuous.util import *
-from voluptuous.error import *
+from voluptuous.validators import *
+
+from voluptuous.error import * # isort: skip
+
+# fmt: on
 
 __version__ = '0.14.1'
 __author__ = 'alecthomas'

voluptuous/error.py

@@ -1,5 +1,8 @@
+# fmt: off
 import typing
 
+# fmt: on
+
 
 class Error(Exception):
     """Base validation exception."""
@@ -24,7 +27,7 @@ def __init__(
         message: str,
         path: typing.Optional[typing.List[typing.Hashable]] = None,
         error_message: typing.Optional[str] = None,
-        error_type: typing.Optional[str] = None
+        error_type: typing.Optional[str] = None,
     ) -> None:
         Error.__init__(self, message)
         self._path = path or []
@@ -44,8 +47,7 @@ def error_message(self) -> str:
         return self._error_message
 
     def __str__(self) -> str:
-        path = ' @ data[%s]' % ']['.join(map(repr, self.path)) \
-            if self.path else ''
+        path = ' @ data[%s]' % ']['.join(map(repr, self.path)) if self.path else ''
         output = Exception.__str__(self)
         if self.error_type:
             output += ' for ' + self.error_type
@@ -207,9 +209,11 @@ class ExactSequenceInvalid(Invalid):
 
 class NotEnoughValid(Invalid):
     """The value did not pass enough validations."""
+
     pass
 
 
 class TooManyValid(Invalid):
     """The value passed more than expected validations."""
+
     pass

voluptuous/humanize.py

@@ -1,13 +1,18 @@
+# fmt: off
+import typing
+
 from voluptuous import Invalid, MultipleInvalid
 from voluptuous.error import Error
 from voluptuous.schema_builder import Schema
-import typing
 
+# fmt: on
 
 MAX_VALIDATION_ERROR_ITEM_LENGTH = 500
 
 
-def _nested_getitem(data: typing.Any, path: typing.List[typing.Hashable]) -> typing.Optional[typing.Any]:
+def _nested_getitem(
+    data: typing.Any, path: typing.List[typing.Hashable]
+) -> typing.Optional[typing.Any]:
     for item_index in path:
         try:
             data = data[item_index]
@@ -18,24 +23,34 @@ def _nested_getitem(data: typing.Any, path: typing.List[typing.Hashable]) -> typ
     return data
 
 
-def humanize_error(data, validation_error: Invalid, max_sub_error_length: int = MAX_VALIDATION_ERROR_ITEM_LENGTH) -> str:
-    """ Provide a more helpful + complete validation error message than that provided automatically
+def humanize_error(
+    data,
+    validation_error: Invalid,
+    max_sub_error_length: int = MAX_VALIDATION_ERROR_ITEM_LENGTH,
+) -> str:
+    """Provide a more helpful + complete validation error message than that provided automatically
     Invalid and MultipleInvalid do not include the offending value in error messages,
     and MultipleInvalid.__str__ only provides the first error.
     """
     if isinstance(validation_error, MultipleInvalid):
-        return '\n'.join(sorted(
-            humanize_error(data, sub_error, max_sub_error_length)
-            for sub_error in validation_error.errors
-        ))
+        return '\n'.join(
+            sorted(
+                humanize_error(data, sub_error, max_sub_error_length)
+                for sub_error in validation_error.errors
+            )
+        )
     else:
         offending_item_summary = repr(_nested_getitem(data, validation_error.path))
         if len(offending_item_summary) > max_sub_error_length:
-            offending_item_summary = offending_item_summary[:max_sub_error_length - 3] + '...'
+            offending_item_summary = (
+                offending_item_summary[: max_sub_error_length - 3] + '...'
+            )
         return '%s. Got %s' % (validation_error, offending_item_summary)
 
 
-def validate_with_humanized_errors(data, schema: Schema, max_sub_error_length: int = MAX_VALIDATION_ERROR_ITEM_LENGTH) -> typing.Any:
+def validate_with_humanized_errors(
+    data, schema: Schema, max_sub_error_length: int = MAX_VALIDATION_ERROR_ITEM_LENGTH
+) -> typing.Any:
     try:
         return schema(data)
     except (Invalid, MultipleInvalid) as e: