replace cerberus wirh jsonschema

.github/workflows/linting.yaml

@@ -1,7 +1,7 @@
 name: Linting
 
 env:
-    POETRY_VERSION: "1.4.0"
+    POETRY_VERSION: "1.8.4"
 
 on:
     pull_request:

.github/workflows/testing.yaml

@@ -5,7 +5,7 @@ env:
     # https://github.com/pytest-dev/pytest/issues/7443
     # https://github.com/actions/runner/issues/241
     PY_COLORS: 1
-    POETRY_VERSION: "1.4.0"
+    POETRY_VERSION: "1.8.4"
 
 on:
     pull_request:

docs/changes.rst

@@ -4,6 +4,8 @@ Changelog
 1.4 (unreleased)
 ----------------
 
+- Replace ``cerberus`` with ``jsonschema``.
+
 - Remove upperbound-pin in ``pyproject.toml``.
   Do not falsely claim incompatibility with python 4.0.
 

pyproject.toml

@@ -35,7 +35,7 @@ skips = ["*/test_*.py"]
 [tool.black]
 line-length = 120
 include = '\.py$'          # regex -> single-quotes
-target_version = ["py311"]
+target-version = ["py311"]
 
 
 [tool.coverage.html]
@@ -133,15 +133,11 @@ packages = [{ include = "libranet_logging", from = "src" }]
 python = ">=3.8.0"
 cerberus = ">=1.3"
 colorlog = ">=6.7"
+jsonschema = ">=4.23"
 logging-tree = ">=1.9"
 pyyaml = ">=6.0"
 
-lxml = { version = ">=4.9", optional = true, allow-prereleases = false } # mypy coverage-report
-# sitecustomize-entrypoints = { version = ">=1.1", optional = true, allow-prereleases = true }
-
 
-[tool.poetry.extras]
-lxml = ["lxml"]
 # sitecustomize = ["sitecustomize-entrypoints"]
 
 # [project.optional-dependencies]
@@ -281,7 +277,7 @@ log_cli = false # enable to show log-output
 log_cli_level = "NOTSET"
 filterwarnings = [
     # "ignore:Coverage disabled via --no-cov switch!:pytest.PytestWarning:pytest_cov.plugin",
-    "ignore::DeprecationWarning", # use of pgk_rescources in cerberus
+    # "ignore::DeprecationWarning", # use of pgk_rescources in cerberus
 ]
 
 

src/libranet_logging/validate.py

@@ -4,9 +4,9 @@
 import logging.config
 
 try:
-    import cerberus
+    import jsonschema
 except ImportError:  # pragma: no cover
-    cerberus = None
+    jsonschema = None
 
 log = logging.getLogger(__name__)
 
@@ -65,18 +65,17 @@
 }
 
 
-class CerberusValidationError(Exception):
-    """CerberusValidationError-class."""
+class SchemaValidationError(Exception):
+    """SchemaValidationError-class."""
 
 
 def validate_logging(log_config, path):
     """Validate the syntax of a logging.yml-file."""
-    if not cerberus:  # pragma: no cover
+    if not jsonschema:  # pragma: no cover
         return
 
-    validator = cerberus.Validator(logging_schema, allow_unknown=True)
-    success = validator.validate(log_config)
-    if not success and validator.errors:
-        sorted_errors = sorted(validator.errors.items())
-        msg = f"logconfig {path} contains errors: {sorted_errors}"
-        raise CerberusValidationError(msg)
+    try:
+        jsonschema.validate(instance=log_config, schema=logging_schema)
+    except jsonschema.exceptions.ValidationError as exc:
+        msg = f"logconfig {path} contains errors: {exc.message}"
+        raise SchemaValidationError(msg)

tests/test_logconfig.py

@@ -50,19 +50,21 @@ def test_initialize_with_invalid_yaml(tests_dir):
 
 def test_initialize_with_invalid_yaml2(tests_dir):
     from libranet_logging.logconfig import initialize
-    from libranet_logging.validate import CerberusValidationError
+    from libranet_logging.validate import SchemaValidationError
 
     logging_yml = tests_dir / "logging_invalid_schema.yaml"
 
-    with pytest.raises(CerberusValidationError) as excinfo:
+    # with pytest.raises(SchemaValidationError) as excinfo:
+    with pytest.raises(ValueError) as excinfo:
         initialize(logging_yml)
 
-    expected = (
-        f"logconfig {logging_yml} contains errors: [('formatters', ['required field']), "
-        "('handlers', ['required field']), ('loggers', ['required field']), "
-        "('root', ['required field']), ('version', ['required field'])]"
-    )
-    assert excinfo.value.args[0] == expected
+    # expected = (
+    #     f"logconfig {logging_yml} contains errors: [('formatters', ['required field']), "
+    #     "('handlers', ['required field']), ('loggers', ['required field']), "
+    #     "('root', ['required field']), ('version', ['required field'])]"
+    # )
+    # assert excinfo.value.args[0] == expected
+    assert excinfo.value.args[0] == "dictionary doesn't specify a version"
 
 
 def test_initialize_with_valid_yaml(env, tests_dir):