feat: update pydantic version

impocode · impocode · commit 093428e028e5 · 2023-08-04T16:44:59.000+05:00
fix: change conlist to Set

fix missing required field for JsonApi object

fix not required fields
diff --git a/jsonapi_pydantic/__init__.py b/jsonapi_pydantic/__init__.py
@@ -1,5 +1,5 @@
 from jsonapi_pydantic import constants, v1_0
 
-__version__ = "0.1.5"
+__version__ = "0.2.0"
 
 __all__ = ["constants", "v1_0"]
diff --git a/jsonapi_pydantic/v1_0/error.py b/jsonapi_pydantic/v1_0/error.py
@@ -1,6 +1,8 @@
 from typing import Any, Optional, Union
 
-from pydantic import AnyUrl, BaseModel, Field
+from pydantic.fields import Field
+from pydantic.main import BaseModel
+from pydantic.networks import AnyUrl
 
 from jsonapi_pydantic.v1_0.links import Link
 from jsonapi_pydantic.v1_0.meta import Meta as MetaObject
@@ -15,27 +17,19 @@ class ErrorLinks(BaseModel):
 
 
 class Source(BaseModel):
-    pointer: Pointer = Field(title="Pointer")
-    parameter: Parameter = Field(title="Parameter")
-
-
-Id = Optional[Any]
-Status = Optional[str]
-Code = Optional[str]
-Title = Optional[str]
-Detail = Optional[str]
-Meta = Optional[MetaObject]
+    pointer: Pointer = Field(None, title="Pointer")
+    parameter: Parameter = Field(None, title="Parameter")
 
 
 class Error(BaseModel):
-    id: Id = Field(title="Id")
-    links: Optional[ErrorLinks] = Field(title="Links")
-    status: Status = Field(title="Status")
-    code: Code = Field(title="Code")
-    title: Title = Field(title="Title")
-    detail: Detail = Field(title="Detail")
-    source: Optional[Source] = Field(title="Source")
-    meta: Meta = Field(title="Meta")
+    id: Optional[Any] = Field(None, title="Id")
+    links: Optional[ErrorLinks] = Field(None, title="Links")
+    status: Optional[Union[str, int]] = Field(None, title="Status")
+    code: Optional[str] = Field(None, title="Code")
+    title: Optional[str] = Field(None, title="Title")
+    detail: Optional[str] = Field(None, title="Detail")
+    source: Optional[Source] = Field(None, title="Source")
+    meta: Optional[MetaObject] = Field(None, title="Meta")
 
 
 __all__ = ["ErrorLinks", "Source", "Error"]
diff --git a/jsonapi_pydantic/v1_0/jsonapi.py b/jsonapi_pydantic/v1_0/jsonapi.py
@@ -1,6 +1,7 @@
 from typing import Optional
 
-from pydantic import BaseModel, Field
+from pydantic.fields import Field
+from pydantic.main import BaseModel
 
 from jsonapi_pydantic.v1_0.meta import Meta as MetaObject
 
@@ -9,8 +10,8 @@
 
 
 class JsonApi(BaseModel):
-    version: Version = Field(title="Version")
-    meta: Meta = Field(title="Meta")
+    version: Version = Field(None, title="Version")
+    meta: Meta = Field(None, title="Meta")
 
 
 __all__ = ["JsonApi"]
diff --git a/jsonapi_pydantic/v1_0/links.py b/jsonapi_pydantic/v1_0/links.py
@@ -1,6 +1,9 @@
 from typing import Dict, Optional, Union
 
-from pydantic import AnyUrl, BaseModel, Field, root_validator
+from pydantic.fields import Field
+from pydantic.functional_validators import model_validator
+from pydantic.main import BaseModel
+from pydantic.networks import AnyUrl
 
 from jsonapi_pydantic.v1_0.meta import Meta as MetaObject
 
@@ -9,15 +12,15 @@
 
 
 class Link(BaseModel):
-    href: Href = Field(title="Href")
-    meta: Meta = Field(title="Meta")
+    href: Href = Field(None, title="Href")
+    meta: Meta = Field(None, title="Meta")
 
-    @root_validator
-    def check_all_values(cls, values: dict) -> dict:
+    @model_validator(mode="before")
+    def check_all_values(cls, data: dict) -> dict:
         # More about these restrictions: https://jsonapi.org/format/#document-links
-        if len(values) < 1:
+        if len(data) < 1:
             raise ValueError("A link object can contain the following members: href, meta.")
-        return values
+        return data
 
 
 Links = Dict[str, Union[AnyUrl, Link, None]]
diff --git a/jsonapi_pydantic/v1_0/resource/relationship.py b/jsonapi_pydantic/v1_0/resource/relationship.py
@@ -1,31 +1,31 @@
-from typing import Optional, Union
+from typing import Optional, Set, Union
 
-from pydantic import BaseModel, Field, conlist, root_validator
+from pydantic.fields import Field
+from pydantic.functional_validators import model_validator
+from pydantic.main import BaseModel
 
 from jsonapi_pydantic.v1_0.meta import Meta as MetaObject
 from jsonapi_pydantic.v1_0.resource.relationship_links import RelationshipLinks
 from jsonapi_pydantic.v1_0.resource_identifier import ResourceIdentifier
 
 Links = Optional[RelationshipLinks]
-ResourceLinkage = Union[
-    None, ResourceIdentifier, conlist(ResourceIdentifier, min_items=0, unique_items=True)
-]
+ResourceLinkage = Union[None, ResourceIdentifier, Set[ResourceIdentifier]]
 Meta = Optional[MetaObject]
 
 
 class Relationship(BaseModel):
-    links: Links = Field(title="Links")
-    data: ResourceLinkage = Field(title="Resource linkage")
-    meta: Meta = Field(title="Meta")
+    links: Links = Field(None, title="Links")
+    data: ResourceLinkage = Field(None, title="Resource linkage")
+    meta: Meta = Field(None, title="Meta")
 
-    @root_validator
-    def check_all_values(cls, values: dict) -> dict:
+    @model_validator(mode="before")
+    def check_all_values(cls, data: dict) -> dict:
         # More about these restrictions: https://jsonapi.org/format/#document-resource-object-relationships
-        if len(values) < 1:
+        if len(data) < 1:
             raise ValueError(
                 "A relationship object MUST contain at least one of the following: links, data, meta."
             )
-        return values
+        return data
 
 
 __all__ = ["Relationship"]
diff --git a/jsonapi_pydantic/v1_0/resource/relationship_links.py b/jsonapi_pydantic/v1_0/resource/relationship_links.py
@@ -1,6 +1,9 @@
 from typing import Union
 
-from pydantic import AnyUrl, BaseModel, Field, root_validator
+from pydantic.fields import Field
+from pydantic.functional_validators import model_validator
+from pydantic.main import BaseModel
+from pydantic.networks import AnyUrl
 
 from jsonapi_pydantic.v1_0.links import Link
 
@@ -9,17 +12,17 @@
 
 
 class RelationshipLinks(BaseModel):
-    self: RelationshipLink = Field(title="Relationship link")
-    related: RelatedResourceLink = Field(title="Related resource link")
+    self: RelationshipLink = Field(None, title="Relationship link")
+    related: RelatedResourceLink = Field(None, title="Related resource link")
 
-    @root_validator
-    def check_all_values(cls, values: dict) -> dict:
+    @model_validator(mode="before")
+    def check_all_values(cls, data: dict) -> dict:
         # More about these restrictions: https://jsonapi.org/format/#document-resource-object-relationships
-        if len(values) < 1:
+        if len(data) < 1:
             raise ValueError(
                 "A links object for a relationship that contains at least one of the following: self, related."
             )
-        return values
+        return data
 
 
 __all__ = ["RelationshipLinks"]
diff --git a/jsonapi_pydantic/v1_0/resource/resource.py b/jsonapi_pydantic/v1_0/resource/resource.py
@@ -1,6 +1,8 @@
 from typing import Any, Dict, Optional
 
-from pydantic import BaseModel, Field, root_validator
+from pydantic.fields import Field
+from pydantic.functional_validators import model_validator
+from pydantic.main import BaseModel
 
 from jsonapi_pydantic.v1_0.links import Links as LinksObject
 from jsonapi_pydantic.v1_0.meta import Meta as MetaObject
@@ -15,17 +17,17 @@
 
 class Resource(BaseModel):
     type: str = Field(title="Type")
-    id: Id = Field(title="Id")
-    attributes: Attributes = Field(title="Attributes")
-    relationships: Relationships = Field(title="Relationships")
-    links: Links = Field(title="Links")
-    meta: Meta = Field(title="Meta")
-
-    @root_validator
-    def check_all_values(cls, values: dict) -> dict:
-        attributes, relationships = values.get("attributes"), values.get("relationships")
+    id: Id = Field(None, title="Id")
+    attributes: Attributes = Field(None, title="Attributes")
+    relationships: Relationships = Field(None, title="Relationships")
+    links: Links = Field(None, title="Links")
+    meta: Meta = Field(None, title="Meta")
+
+    @model_validator(mode="before")
+    def check_all_values(cls, data: dict) -> dict:
+        attributes, relationships = data.get("attributes"), data.get("relationships")
         if not attributes and not relationships:
-            return values
+            return data
 
         # More about these restrictions: https://jsonapi.org/format/#document-resource-object-fields
         try:
@@ -47,7 +49,7 @@ def check_all_values(cls, values: dict) -> dict:
                         f"A resource can not have an attribute and relationship with the same name. Name: {key}."
                     )
 
-        return values
+        return data
 
 
 __all__ = ["Resource"]
diff --git a/jsonapi_pydantic/v1_0/resource_identifier.py b/jsonapi_pydantic/v1_0/resource_identifier.py
@@ -1,6 +1,7 @@
 from typing import Optional
 
-from pydantic import BaseModel, Field
+from pydantic.fields import Field
+from pydantic.main import BaseModel
 
 from jsonapi_pydantic.v1_0.meta import Meta as MetaObject
 
@@ -10,7 +11,7 @@
 class ResourceIdentifier(BaseModel):
     id: str = Field(title="Id")
     type: str = Field(title="Type")
-    meta: Meta = Field(title="Meta")
+    meta: Meta = Field(None, title="Meta")
 
 
 __all__ = ["ResourceIdentifier"]
diff --git a/jsonapi_pydantic/v1_0/toplevel.py b/jsonapi_pydantic/v1_0/toplevel.py
@@ -1,6 +1,8 @@
-from typing import List, Optional, Union
+from typing import List, Optional, Set, Union
 
-from pydantic import BaseModel, Field, conlist, root_validator
+from pydantic.fields import Field
+from pydantic.functional_validators import model_validator
+from pydantic.main import BaseModel
 
 from jsonapi_pydantic.v1_0.error import Error
 from jsonapi_pydantic.v1_0.jsonapi import JsonApi as JsonApiObject
@@ -13,40 +15,40 @@
     None,
     Resource,
     ResourceIdentifier,
-    conlist(Resource, min_items=0, unique_items=True),
-    conlist(ResourceIdentifier, min_items=0, unique_items=True),
+    Set[Resource],
+    Set[ResourceIdentifier],
 ]
 Errors = Optional[List[Error]]
 Meta = Optional[MetaObject]
 
 JsonApi = Optional[JsonApiObject]
 Links = Optional[LinksObject]
-Included = Optional[conlist(Resource, min_items=0, unique_items=True)]
+Included = Optional[Set[Resource]]
 
 
 class TopLevel(BaseModel):
-    data: Data = Field(title="Data")
-    errors: Errors = Field(title="Errors")
-    meta: Meta = Field(title="Meta")
+    data: Data = Field(None, title="Data")
+    errors: Errors = Field(None, title="Errors")
+    meta: Meta = Field(None, title="Meta")
 
-    jsonapi: JsonApi = Field(title="JSON:API")
-    links: Links = Field(title="Links")
-    included: Included = Field(title="Included")
+    jsonapi: JsonApi = Field(None, title="JSON:API")
+    links: Links = Field(None, title="Links")
+    included: Included = Field(None, title="Included")
 
-    @root_validator
-    def check_all_values(cls, values: dict) -> dict:
+    @model_validator(mode="before")
+    def check_all_values(cls, data: dict) -> dict:
         # More about these restrictions: https://jsonapi.org/format/#document-top-level
-        if values.get("data") and values.get("errors"):
+        if data.get("data") and data.get("errors"):
             raise ValueError("The members data and errors MUST NOT coexist in the same document.")
-        if values.get("included") and not values.get("data"):
+        if data.get("included") and not data.get("data"):
             raise ValueError(
                 "If a document does not contain a top-level data key, the included member MUST NOT be present either."
             )
-        if not values.get("data") and not values.get("errors") and not values.get("meta"):
+        if not data.get("data") and not data.get("errors") and not data.get("meta"):
             raise ValueError(
                 "A document MUST contain at least one of the following top-level members: data, errors, meta."
             )
-        return values
+        return data
 
 
 __all__ = ["TopLevel"]
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "jsonapi-pydantic"
-version = "0.1.5"
+version = "0.2.0"
 description = "JSON:API implementation with pydantic."
 
 authors = ["impocode <impocode@impocode.com>"]
@@ -16,6 +16,7 @@ classifiers = [
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
     "Typing :: Typed",
 ]
 
@@ -25,7 +26,7 @@ documentation = "https://github.com/impocode/jsonapi-pydantic"
 
 [tool.poetry.dependencies]
 python = "^3.7"
-pydantic = "^1.10.2"
+pydantic = "^2.1.1"
 
 [tool.poetry.urls]
 "Bug Tracker" = "https://github.com/impocode/jsonapi-pydantic/issues"
