Add option to raise errors (#68)

* rename validate_once to validate

* add option to raise error when validation fails

performance/test_benchmark.py

@@ -5,15 +5,15 @@
 import pytest
 
 from performance.large_schema import SCHEMA
-from pyjschema.draft_2019_09 import construct_validator, validate_once
+from pyjschema.draft_2019_09 import construct_validator, validate
 
 INSTANCE = [9, "hello", [1, "a", True], {"a": "a", "b": "b", "d": "d"}, 42, 3]
 
 
 @pytest.mark.benchmark(group="compile+run", min_time=0.1, max_time=0.5, min_rounds=5)
 def test_pyjschema(benchmark):
     def validate_pyjschema():
-        validate_once(SCHEMA, INSTANCE)
+        validate(SCHEMA, INSTANCE)
 
     benchmark(validate_pyjschema)
 

src/pyjschema/draft_2019_09/__init__.py

@@ -1,8 +1,8 @@
 from .validator_construction import (
     Validator,
     build_validator,
-    validate_once,
+    validate,
     construct_validator,
 )
 
-__all__ = ["validate_once", "build_validator", "Validator", "construct_validator"]
+__all__ = ["validate", "build_validator", "Validator", "construct_validator"]

src/pyjschema/draft_2019_09/boolean_applicators_test.py

@@ -1,9 +1,9 @@
 import unittest
 
-from pyjschema.draft_2019_09 import validate_once
+from pyjschema.draft_2019_09 import validate
 
 
 class Test(unittest.TestCase):
     def test(self):
-        res = validate_once(schema={"not": True}, instance="123")
+        res = validate(schema={"not": True}, instance="123")
         self.assertFalse(res)

src/pyjschema/draft_2019_09/types/array_test.py

@@ -1,6 +1,6 @@
 import unittest
 
-from pyjschema.draft_2019_09 import validate_once
+from pyjschema.draft_2019_09 import validate
 
 
 class Test(unittest.TestCase):
@@ -25,4 +25,4 @@ def test(self):
             "items": [{"$ref": "#/$defs/item"},],
         }
 
-        self.assertEqual(bool(validate_once(schema=schema, instance=instance)), False)
+        self.assertEqual(bool(validate(schema=schema, instance=instance)), False)

src/pyjschema/draft_2019_09/validator_construction.py

@@ -1,24 +1,23 @@
 import json
 import os
 import typing
-
-from pyjschema.exceptions import SchemaError
+from pyjschema.exceptions import SchemaError, ValidationError
 
 from .context import BUILD_VALIDATOR, VOCABULARIES
 from .referencing import resolve_references
 from .types import AcceptAll, RejectAll
 from .validator import Validator
 from .vocabularies import METASCHEMA_VALIDATORS, get_vocabularies
 
-__all__ = ["validate_once", "Validator", "construct_validator"]
+__all__ = ["validate", "Validator", "construct_validator"]
 
 
 def construct_validator(schema, check_schema=False):
     if check_schema:
         schema_validator = meta_schema_validator(schema=schema)
         # Need to wrap schema errors here and reraisr as SchemaErrors
         if not schema_validator(instance=schema):
-            raise SchemaError("Schema is invalid according to the meta-schema")
+            raise SchemaError(message="Schema is invalid according to the meta-schema")
     else:
         validator = build_validator_and_resolve_references(
             schema=schema,
@@ -28,16 +27,21 @@ def construct_validator(schema, check_schema=False):
 
         def validate(instance):
             # USE_SHORTCIRCUITING.set(True)
-            return bool(validator(instance=instance, location="/"))
+            return validator(instance=instance, location="/")
 
         return validate
 
 
-def validate_once(
-    schema: typing.Union[dict, bool], instance: dict, check_schema=False
+def validate(
+    schema: typing.Union[dict, bool],
+    instance: dict,
+    check_schema=False,
+    raise_exceptions=False,
 ) -> bool:
     validate = construct_validator(schema=schema, check_schema=check_schema)
     res = validate(instance=instance)
+    if not res and raise_exceptions:
+        raise ValidationError(message="This instance doesnt conform to this schema")
     return res
 
 

src/pyjschema/draft_2019_09/validator_test.py

@@ -5,7 +5,7 @@
 from pyjschema.exceptions import SchemaError
 
 from .validator import Validator
-from .validator_construction import validate_once
+from .validator_construction import validate
 
 
 class TestValidator(unittest.TestCase):
@@ -34,7 +34,7 @@ def test_recursive_ref(self, instance, result):
         }
 
         self.assertEqual(
-            result, bool(validate_once(schema=schema, instance=instance)),
+            result, bool(validate(schema=schema, instance=instance)),
         )
 
     @parameterized.parameterized.expand(
@@ -76,5 +76,5 @@ def test_recursive_ref(self, instance, result):
         }
 
         self.assertEqual(
-            result, bool(validate_once(schema=schema, instance=instance)),
+            result, bool(validate(schema=schema, instance=instance)),
         )

src/pyjschema/exceptions.py

@@ -1,9 +1,20 @@
+from typing import Optional
+
+
 class SchemaError(Exception):
-    pass
+    def __init__(self, message, details: Optional[dict] = None):
+        super().__init__()
+        details = details if details else {}
+        self.message = message
+        self.details = details
 
 
-class InstanceError(Exception):
-    pass
+class ValidationError(Exception):
+    def __init__(self, message, details: Optional[dict] = None):
+        super().__init__()
+        details = details if details else {}
+        self.message = message
+        self.details = details
 
 
 class ProgrammerError(Exception):

tests/draft_2019_09/accept_all_test.py

@@ -2,7 +2,7 @@
 
 import parameterized
 
-from pyjschema.draft_2019_09 import validate_once
+from pyjschema.draft_2019_09 import validate
 
 
 class TestTrue(unittest.TestCase):
@@ -17,7 +17,7 @@ class TestTrue(unittest.TestCase):
         ]
     )
     def test_true(self, name, schema, instance):
-        self.assertTrue(validate_once(schema=schema, instance=instance))
+        self.assertTrue(validate(schema=schema, instance=instance))
 
     @parameterized.parameterized.expand(
         [
@@ -38,4 +38,4 @@ def test_true(self, name, schema, instance):
         ]
     )
     def test_empty_schema(self, name, schema, instance):
-        self.assertTrue(validate_once(schema=schema, instance=instance))
+        self.assertTrue(validate(schema=schema, instance=instance))

tests/draft_2019_09/boolean_applicators_test.py

@@ -2,7 +2,7 @@
 
 import parameterized
 
-from pyjschema.draft_2019_09 import validate_once
+from pyjschema.draft_2019_09 import validate
 
 
 class TestBooleanLogic(unittest.TestCase):
@@ -31,7 +31,7 @@ class TestBooleanLogic(unittest.TestCase):
         ]
     )
     def test_true(self, name, schema, instance):
-        res = validate_once(schema, instance)
+        res = validate(schema, instance)
         self.assertTrue(res)
 
     @parameterized.parameterized.expand(
@@ -59,5 +59,5 @@ def test_true(self, name, schema, instance):
         ]
     )
     def test_false(self, name, schema, instance):
-        res = validate_once(schema, instance)
+        res = validate(schema, instance)
         self.assertFalse(res)

tests/draft_2019_09/rand_test.py

@@ -1,11 +1,11 @@
 import unittest
 
-from pyjschema.draft_2019_09 import validate_once
+from pyjschema.draft_2019_09 import validate
 
 
 class TestRand(unittest.TestCase):
     def test(self):
-        res = validate_once(
+        res = validate(
             schema={
                 "$schema": "https://json-schema.org/draft/2019-09/schema",
                 "$id": "http://example.com/product.schema.json",

tests/draft_2019_09/referencing/ref_test.py

@@ -2,7 +2,7 @@
 
 import parameterized  # type: ignore
 
-from pyjschema.draft_2019_09 import validate_once
+from pyjschema.draft_2019_09 import validate
 
 
 class TestRefValidate(unittest.TestCase):
@@ -45,7 +45,7 @@ class TestRefValidate(unittest.TestCase):
         ]
     )
     def test_true(self, name, schema, instance):
-        result = validate_once(schema=schema, instance=instance)
+        result = validate(schema=schema, instance=instance)
         self.assertTrue(result)
 
     @parameterized.parameterized.expand(
@@ -69,5 +69,5 @@ def test_true(self, name, schema, instance):
         ]
     )
     def test_false(self, name, schema, instance):
-        result = validate_once(schema=schema, instance=instance)
+        result = validate(schema=schema, instance=instance)
         self.assertFalse(result)

tests/draft_2019_09/reject_all_test.py

@@ -2,7 +2,7 @@
 
 import parameterized
 
-from pyjschema.draft_2019_09 import validate_once
+from pyjschema.draft_2019_09 import validate
 
 
 class TestRejectAll(unittest.TestCase):
@@ -17,4 +17,4 @@ class TestRejectAll(unittest.TestCase):
         ]
     )
     def test_true(self, name, schema, instance):
-        self.assertFalse(validate_once(schema=schema, instance=instance))
+        self.assertFalse(validate(schema=schema, instance=instance))

tests/draft_2019_09/types/array_test.py

@@ -2,7 +2,7 @@
 
 import parameterized
 
-from pyjschema.draft_2019_09 import validate_once
+from pyjschema.draft_2019_09 import validate
 
 
 class TestArrayValidation(unittest.TestCase):
@@ -136,7 +136,7 @@ class TestArrayValidation(unittest.TestCase):
         ]
     )
     def test_true(self, name, schema, instance):
-        res = validate_once(schema=schema, instance=instance)
+        res = validate(schema=schema, instance=instance)
         self.assertTrue(res)
 
     @parameterized.parameterized.expand(
@@ -252,4 +252,4 @@ def test_true(self, name, schema, instance):
         ]
     )
     def test_false(self, name, schema, instance):
-        self.assertFalse(validate_once(schema=schema, instance=instance))
+        self.assertFalse(validate(schema=schema, instance=instance))

tests/draft_2019_09/types/boolean_test.py

@@ -2,7 +2,7 @@
 
 import parameterized
 
-from pyjschema.draft_2019_09 import validate_once
+from pyjschema.draft_2019_09 import validate
 
 
 class TestBoolean(unittest.TestCase):
@@ -13,10 +13,10 @@ class TestBoolean(unittest.TestCase):
         ]
     )
     def test_instance_true(self, name, schema, instance):
-        self.assertTrue(validate_once(schema=schema, instance=instance))
+        self.assertTrue(validate(schema=schema, instance=instance))
 
     def test_instance_not_boolean(self):
-        res = validate_once(
+        res = validate(
             schema={"$id": "https://example.com/ope", "type": "boolean"}, instance=123
         )
         self.assertFalse(res)

tests/draft_2019_09/types/number_test.py

@@ -2,7 +2,7 @@
 
 import parameterized
 
-from pyjschema.draft_2019_09 import validate_once
+from pyjschema.draft_2019_09 import validate
 
 
 class TestNumber(unittest.TestCase):
@@ -46,7 +46,7 @@ class TestNumber(unittest.TestCase):
         ]
     )
     def test_true(self, name, schema, instance):
-        self.assertTrue(validate_once(schema=schema, instance=instance))
+        self.assertTrue(validate(schema=schema, instance=instance))
 
     @parameterized.parameterized.expand(
         [
@@ -92,4 +92,4 @@ def test_true(self, name, schema, instance):
         ]
     )
     def test_false(self, name, schema, instance):
-        self.assertFalse(validate_once(schema=schema, instance=instance))
+        self.assertFalse(validate(schema=schema, instance=instance))

tests/draft_2019_09/types/object_test.py

@@ -2,7 +2,7 @@
 
 import parameterized
 
-from pyjschema.draft_2019_09 import validate_once
+from pyjschema.draft_2019_09 import validate
 
 
 class TestObject(unittest.TestCase):
@@ -117,7 +117,7 @@ class TestObject(unittest.TestCase):
         ]
     )
     def test_true(self, name, schema, instance):
-        self.assertTrue(validate_once(schema=schema, instance=instance))
+        self.assertTrue(validate(schema=schema, instance=instance))
 
     @parameterized.parameterized.expand(
         [
@@ -225,4 +225,4 @@ def test_true(self, name, schema, instance):
         ]
     )
     def test_false(self, name, schema, instance):
-        self.assertFalse(validate_once(schema=schema, instance=instance))
+        self.assertFalse(validate(schema=schema, instance=instance))