vtjson 2.2.1__tar.gz → 2.2.3__tar.gz

{vtjson-2.2.1/src/vtjson.egg-info → vtjson-2.2.3}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: vtjson
-Version: 2.2.1
-Summary: A lightweight package for validating JSON like Python objects
+Version: 2.2.3
+Summary: An easy to use validation library compatible with Python type annotations
 Author-email: Michel Van den Bergh <michel.vandenbergh@uhasselt.be>
 Project-URL: Homepage, https://github.com/vdbergh/vtjson
 Project-URL: Bug Tracker, https://github.com/vdbergh/vtjson/issues
@@ -78,7 +78,7 @@ class book_schema(TypedDict):
     year: int
 ```
 
-Attempting to validate the bad book would raise the same exception as before.
+Attempting to validate the bad book would raise a similar exception as before.
 
 Schemas can of course be more complicated and in particular they can be nested.
 Here is an example that shows more of the features of `vtjson`.
@@ -126,7 +126,7 @@ class person_schema(TypedDict):
 class book_schema(TypedDict):
     title: str
     authors: list[person_schema]
-    editor: NotRequired[list[person_schema]]
+    editor: NotRequired[person_schema]
     year: Annotated[int, ge(1900)]
 ```
 

{vtjson-2.2.1 → vtjson-2.2.3}/README.md

@@ -58,7 +58,7 @@ class book_schema(TypedDict):
     year: int
 ```
 
-Attempting to validate the bad book would raise the same exception as before.
+Attempting to validate the bad book would raise a similar exception as before.
 
 Schemas can of course be more complicated and in particular they can be nested.
 Here is an example that shows more of the features of `vtjson`.
@@ -106,7 +106,7 @@ class person_schema(TypedDict):
 class book_schema(TypedDict):
     title: str
     authors: list[person_schema]
-    editor: NotRequired[list[person_schema]]
+    editor: NotRequired[person_schema]
     year: Annotated[int, ge(1900)]
 ```
 

{vtjson-2.2.1 → vtjson-2.2.3}/pyproject.toml

@@ -8,7 +8,7 @@ dynamic = ["version"]
 authors = [
   { name="Michel Van den Bergh", email="michel.vandenbergh@uhasselt.be" },
 ]
-description = "A lightweight package for validating JSON like Python objects"
+description = "An easy to use validation library compatible with Python type annotations"
 readme = "README.md"
 dependencies = ["dnspython", "email_validator", "idna", "python-magic", "typing_extensions"]
 requires-python = ">=3.7"

{vtjson-2.2.1 → vtjson-2.2.3}/src/vtjson/vtjson.py

@@ -204,7 +204,7 @@ class SchemaError(Exception):
     pass
 
 
-__version__ = "2.2.1"
+__version__ = "2.2.3"
 
 
 @dataclass
@@ -323,7 +323,7 @@ T = TypeVar("T")
 
 
 @overload
-def _canonize_key(key: str | optional_key[str]) -> optional_key[str]: ...
+def _canonize_key(key: StringKeyType) -> optional_key[str]: ...
 
 
 @overload
@@ -445,6 +445,9 @@ class optional_key(Generic[K]):
         return hash(self.key)
 
 
+StringKeyType = TypeVar("StringKeyType", bound=Union[str, optional_key[str]])
+
+
 class _union(compiled_schema):
     schemas: list[compiled_schema]
 
@@ -786,9 +789,8 @@ class _set_name(compiled_schema):
 
 class set_name(wrapper):
     """
-    An object matches the schema `set_name(schema, name, reason=False)` if it
-    matches `schema`, but the `name` argument will be used in non-validation
-    messages.
+    An object matches the schema `set_name(schema, name)` if it matches `schema`,
+    but the `name` argument will be used in non-validation messages.
     """
 
     reason: bool
@@ -799,8 +801,8 @@ class set_name(wrapper):
         """
         :param schema: the original schema
         :param name: name for use in non-validation messages
-        :param reason: indicates whether the original non-validation message
-          should be suppressed
+        :param reason: if `True` then the original non-validation message
+          will not be suppressed
         """
         if not isinstance(name, str):
             raise SchemaError(f"The name {_c(name)} is not a string")
@@ -1493,7 +1495,9 @@ def _compile(
         origin = object()
 
     ret: compiled_schema
-    if isinstance(schema, type) and issubclass(schema, compiled_schema):
+    if isinstance(schema, compiled_schema):
+        ret = schema
+    elif isinstance(schema, type) and issubclass(schema, compiled_schema):
         try:
             ret = schema()
         except Exception:
@@ -1504,8 +1508,6 @@ def _compile(
         ret = _validate_schema(schema)
     elif isinstance(schema, wrapper):
         ret = schema.__compile__(_deferred_compiles=_deferred_compiles)
-    elif isinstance(schema, compiled_schema):
-        ret = schema
     elif supports_TypedDict and typing.is_typeddict(schema):
         ret = _compile(
             protocol(schema, dict=True), _deferred_compiles=_deferred_compiles
@@ -2037,7 +2039,7 @@ class one_of(compiled_schema):
 class keys(compiled_schema):
     """
     This represents a dictionary containing all the keys in a collection of
-    keys
+    keys.
     """
 
     args: tuple[object, ...]
@@ -2238,12 +2240,12 @@ class fields(wrapper):
     """
     Matches Python objects with attributes `field1, field2, ..., fieldN` whose
     corresponding values should validate against `schema1, schema2, ...,
-    schemaN` respectively
+    schemaN` respectively.
     """
 
     d: dict[optional_key[str], object]
 
-    def __init__(self, d: Mapping[str | optional_key[str], object]) -> None:
+    def __init__(self, d: Mapping[StringKeyType, object]) -> None:
         """
         :param d: a dictionary associating fields with schemas
 
@@ -2720,7 +2722,7 @@ class protocol(wrapper):
     ) -> compiled_schema:
         if not self.dict:
             return _set_name(
-                _fields(self.type_dict),
+                fields(self.type_dict),
                 self.__name__,
                 reason=True,
                 _deferred_compiles=_deferred_compiles,

{vtjson-2.2.1 → vtjson-2.2.3/src/vtjson.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: vtjson
-Version: 2.2.1
-Summary: A lightweight package for validating JSON like Python objects
+Version: 2.2.3
+Summary: An easy to use validation library compatible with Python type annotations
 Author-email: Michel Van den Bergh <michel.vandenbergh@uhasselt.be>
 Project-URL: Homepage, https://github.com/vdbergh/vtjson
 Project-URL: Bug Tracker, https://github.com/vdbergh/vtjson/issues
@@ -78,7 +78,7 @@ class book_schema(TypedDict):
     year: int
 ```
 
-Attempting to validate the bad book would raise the same exception as before.
+Attempting to validate the bad book would raise a similar exception as before.
 
 Schemas can of course be more complicated and in particular they can be nested.
 Here is an example that shows more of the features of `vtjson`.
@@ -126,7 +126,7 @@ class person_schema(TypedDict):
 class book_schema(TypedDict):
     title: str
     authors: list[person_schema]
-    editor: NotRequired[list[person_schema]]
+    editor: NotRequired[person_schema]
     year: Annotated[int, ge(1900)]
 ```
 

{vtjson-2.2.1 → vtjson-2.2.3}/tests/test_vtjson.py

@@ -309,6 +309,12 @@ class TestValidation(unittest.TestCase):
             object_ = {"b": "c"}
             validate(schema, object_)
         show(mc)
+        schema = {optional_key("a?", _optional=False): str, "b": str}
+        with self.assertRaises(ValidationError) as mc:
+            object_ = {"b": "c"}
+            validate(schema, object_)
+        show(mc)
+
         with self.assertRaises(ValidationError) as mc:
             object_ = {"a": "c", "b": "d"}
             validate(schema, object_)