amati 0.1.0__py3-none-any.whl → 0.2__py3-none-any.whl

amati/model_validators.py

@@ -10,7 +10,7 @@ from pydantic._internal._decorators import (
     PydanticDescriptorProxy,
 )
 
-from amati.logging import Log, LogMixin
+from amati.logging import LogMixin
 from amati.validators.generic import GenericObject
 
 
@@ -107,14 +107,13 @@ def at_least_one_of(
         The validator that ensures at least one public field is non-empty.
 
     Example:
-        >>> from amati import Reference
         >>> LogMixin.logs = []
         >>>
         >>> class User(GenericObject):
         ...     name: str = ""
         ...     email: str = None
         ...     _at_least_one_of = at_least_one_of()
-        ...     _reference: Reference = Reference(title="test")
+        ...     _reference_uri = "https://example.com"
         ...
         >>> user = User()
         >>> assert len(LogMixin.logs) == 1
@@ -125,7 +124,7 @@ def at_least_one_of(
         ...     email: str = None
         ...     age: int = None
         ...     _at_least_one_of = at_least_one_of(fields=["name", "email"])
-        ...     _reference: Reference = Reference(title="test")
+        ...     _reference_uri = "https://example.com"
         ...
         >>>
         >>> user = User(name="John")  # Works fine
@@ -159,11 +158,13 @@ def at_least_one_of(
 
         msg = f"{public_fields} do not have values, expected at least one."
         LogMixin.log(
-            Log(
-                message=msg,
-                type=ValueError,
-                reference=self._reference,  # pylint: disable=protected-access # type: ignore
-            )
+            {
+                "msg": msg,
+                "type": "value_error",
+                "loc": (self.__class__.__name__,),
+                "input": candidates,
+                "url": self._reference_uri,  # pylint: disable=protected-access # type: ignore
+            }
         )
 
         return self
@@ -173,6 +174,7 @@ def at_least_one_of(
 
 def only_one_of(
     fields: Optional[Sequence[str]] = None,
+    type_: Optional[str] = "value_error",
 ) -> PydanticDescriptorProxy[ModelValidatorDecoratorInfo]:
     """Factory that adds validation to ensure one public field is non-empty.
 
@@ -189,14 +191,13 @@ def only_one_of(
         The validator that ensures at one public field is non-empty.
 
     Example:
-        >>> from amati import Reference
         >>> LogMixin.logs = []
         >>>
         >>> class User(GenericObject):
         ...     email: str = ""
         ...     name: str = ""
         ...     _only_one_of = only_one_of()
-        ...     _reference: Reference = Reference(title="test")
+        ...     _reference_uri = "https://example.com"
         ...
         >>> user = User(email="test@example.com")  # Works fine
         >>> user = User(name="123-456-7890")  # Works fine
@@ -210,7 +211,7 @@ def only_one_of(
         ...     email: str = ""
         ...     age: int = None
         ...     _only_one_of = only_one_of(["name", "email"])
-        ...     _reference: Reference = Reference(title="test")
+        ...     _reference_uri = "https://example.com"
         ...
         >>> user = User(name="Bob")  # Works fine
         >>> user = User(email="test@example.com")  # Works fine
@@ -242,14 +243,20 @@ def only_one_of(
                 truthy.append(name)
 
         if len(truthy) != 1:
-            msg = f"Expected at most one field to have a value, {", ".join(truthy)} did"
+            if truthy:
+                field_string = ", ".join(truthy)
+            else:
+                field_string = "none"
+            msg = f"Expected at most one field to have a value, {field_string} did"
 
             LogMixin.log(
-                Log(
-                    message=msg,
-                    type=ValueError,
-                    reference=self._reference,  # pylint: disable=protected-access # type: ignore
-                )
+                {
+                    "msg": msg,
+                    "type": type_ or "value_error",
+                    "loc": (self.__class__.__name__,),
+                    "input": candidates,
+                    "url": self._reference_uri,  # pylint: disable=protected-access # type: ignore
+                }
             )
 
         return self
@@ -275,14 +282,13 @@ def all_of(
         The validator that ensures at most one public field is non-empty.
 
     Example:
-        >>> from amati import Reference
         >>> LogMixin.logs = []
         >>>
         >>> class User(GenericObject):
         ...     email: str = ""
         ...     name: str = ""
         ...     _all_of = all_of()
-        ...     _reference: Reference = Reference(title="test")
+        ...     _reference_uri = "https://example.com"
         ...
         >>> user = User(email="a@b.com", name="123") # Works fine
         >>> assert not LogMixin.logs
@@ -296,7 +302,7 @@ def all_of(
         ...     email: str = ""
         ...     age: int = None
         ...     _all_of = all_of(["name", "email"])
-        ...     _reference: Reference = Reference(title="test")
+        ...     _reference_uri = "https://example.com"
         ...
         >>> LogMixin.logs = []
         >>> user = User(name="Bob", email="a@b.com") # Works fine
@@ -334,11 +340,13 @@ def all_of(
             msg = f"Expected at all fields to have a value, {", ".join(falsy)} did not"
 
             LogMixin.log(
-                Log(
-                    message=msg,
-                    type=ValueError,
-                    reference=self._reference,  # pylint: disable=protected-access # type: ignore
-                )
+                {
+                    "msg": msg,
+                    "type": "value_error",
+                    "loc": (self.__class__.__name__,),
+                    "input": candidates,
+                    "url": self._reference_uri,  # pylint: disable=protected-access # type: ignore
+                }
             )
 
         return self
@@ -370,7 +378,6 @@ def if_then(
         ValueError: If a condition and consequence are not present
 
     Example:
-        >>> from amati import Reference
         >>> LogMixin.logs = []
         >>>
         >>> class User(GenericObject):
@@ -380,7 +387,7 @@ def if_then(
         ...         conditions={"role": "admin"},
         ...         consequences={"can_edit": True}
         ...     )
-        ...     _reference: Reference = Reference(title="test")
+        ...     _reference_uri = "https://example.com"
         ...
         >>> user = User(role="admin", can_edit=True)  # Works fine
         >>> assert not LogMixin.logs
@@ -425,12 +432,14 @@ def if_then(
                 continue
 
             LogMixin.log(
-                Log(
-                    message=f"Expected {field} to be {"in " if iterable else ""}"
+                {
+                    "msg": f"Expected {field} to be {"in " if iterable else ""}"
                     f"{value} found {actual}",
-                    type=ValueError,
-                    reference=self._reference,  # pylint: disable=protected-access # type: ignore
-                )
+                    "type": "value_error",
+                    "loc": (self.__class__.__name__,),
+                    "input": candidates,
+                    "url": self._reference_uri,  # pylint: disable=protected-access # type: ignore
+                }
             )
 
         return self

amati/validators/generic.py

@@ -20,17 +20,16 @@ from typing import (
 from pydantic import BaseModel, ConfigDict, PrivateAttr
 from pydantic_core._pydantic_core import PydanticUndefined
 
-from amati import Reference
-from amati.logging import Log, LogMixin
+from amati.logging import LogMixin
 
 
-class GenericObject(LogMixin, BaseModel):
+class GenericObject(BaseModel):
     """
     A generic model to overwrite provide extra functionality
     to pydantic.BaseModel.
     """
 
-    _reference: ClassVar[Reference] = PrivateAttr()
+    _reference_uri: ClassVar[str] = PrivateAttr()
     _extra_field_pattern: Optional[Pattern[str]] = PrivateAttr()
 
     def __init__(self, **data: Any) -> None:
@@ -48,11 +47,14 @@ class GenericObject(LogMixin, BaseModel):
                 and field not in self.get_field_aliases()
             ):
                 message = f"{field} is not a valid field for {self.__repr_name__()}."
-                self.log(
-                    Log(
-                        message=message,
-                        type=ValueError,
-                    )
+                LogMixin.log(
+                    {
+                        "msg": message,
+                        "type": "value_error",
+                        "loc": (self.__repr_name__(),),
+                        "input": field,
+                        "url": self._reference_uri,
+                    }
                 )
 
     def model_post_init(self, __context: Any) -> None:
@@ -78,10 +80,13 @@ class GenericObject(LogMixin, BaseModel):
         for field in excess_fields:
             message = f"{field} is not a valid field for {self.__repr_name__()}."
             LogMixin.log(
-                Log(
-                    message=message,
-                    type=ValueError,
-                )
+                {
+                    "msg": message,
+                    "type": "value_error",
+                    "loc": (self.__repr_name__(),),
+                    "input": field,
+                    "url": self._reference_uri,
+                }
             )
 
     def get_field_aliases(self) -> list[str]: