feat: Upgrade to Pydantic 2.11 (#129)

Co-authored-by: Richard Bell <[email protected]>

Author: rbell517

conftest.py

@@ -88,4 +88,4 @@ def enterprise_config(pytestconfig):
 @pytest.fixture(scope="session", autouse=True)
 def pydantic_forbid_extra_fields():
     """Fixture to disable allowing extra fields in our Pydantic models."""
-    JsonModel.Config.extra = Extra.forbid
+    JsonModel.model_config.update(extra='forbid')

mypy.ini

@@ -10,6 +10,7 @@ disallow_untyped_calls=True
 disallow_untyped_defs=True
 disallow_incomplete_defs=True
 disallow_untyped_decorators=True
+disable_error_code=empty-body
 
 strict_equality=True
 

nisystemlink/clients/core/_api_exception.py

@@ -45,7 +45,7 @@ def error(self) -> Optional[core.ApiError]:  # noqa: D401
         if self._error is None:
             return None
         else:
-            return self._error.copy()
+            return self._error.model_copy()
 
     @property
     def http_status_code(self) -> Optional[int]:  # noqa: D401

nisystemlink/clients/core/_http_configuration_manager.py

@@ -30,8 +30,8 @@ class HttpConfigurationManager:
     _SALT_GRAINS_WORKSPACE_KEY = "systemlink_workspace"
     """Key of Workspace ID stored in the salt grains config file."""
 
-    _configs = None
-    _virtual_configs = None
+    _configs: Optional[Dict[str, core.HttpConfiguration]] = None
+    _virtual_configs: Optional[Dict[str, core.HttpConfiguration]] = None
 
     @classmethod
     def get_configuration(

nisystemlink/clients/core/_uplink/_base_client.py

@@ -1,11 +1,10 @@
 # mypy: disable-error-code = misc
 
-from json import loads
 from typing import Any, Callable, Dict, get_origin, Optional, Type, Union
 
 import requests
 from nisystemlink.clients import core
-from pydantic import parse_obj_as
+from pydantic import TypeAdapter
 from requests import JSONDecodeError, Response
 from uplink import commands, Consumer, converters, response_handler, utils
 
@@ -28,7 +27,7 @@ def _handle_http_status(response: Response) -> Optional[Response]:
     try:
         content = response.json()
         if content and "error" in content:
-            err_obj = core.ApiError.parse_obj(content["error"])
+            err_obj = core.ApiError.model_validate(content["error"])
         else:
             err_obj = None
 
@@ -41,12 +40,20 @@ def _handle_http_status(response: Response) -> Optional[Response]:
         raise core.ApiException(msg, http_status_code=response.status_code)
 
 
+_type_adapters: Dict[Type, TypeAdapter] = dict()
+
+
 class _JsonModelConverter(converters.Factory):
+    """A converter that converts between JSON and Pydantic models."""
+
+    def __init__(self) -> None:
+        super().__init__()
+
     def create_request_body_converter(
         self, _class: Type, _: commands.RequestDefinition
     ) -> Optional[Callable[[JsonModel], Dict]]:
         def encoder(model: JsonModel) -> Dict:
-            return loads(model.json(by_alias=True, exclude_unset=True))
+            return model.model_dump(mode="json", by_alias=True, exclude_unset=True)
 
         if utils.is_subclass(_class, JsonModel):
             return encoder
@@ -56,15 +63,24 @@ def encoder(model: JsonModel) -> Dict:
     def create_response_body_converter(
         self, _class: Type, _: commands.RequestDefinition
     ) -> Optional[Callable[[Response], Any]]:
-        def decoder(response: Response) -> Any:
-            try:
-                data = response.json()
-            except AttributeError:
-                data = response
-
-            return parse_obj_as(_class, data)
-
-        if get_origin(_class) is Union or utils.is_subclass(_class, JsonModel):
+        def decoder(response: Union[Response, Any]) -> Any:
+            if response is None:
+                return None
+
+            adapter = _type_adapters[_class]
+            if isinstance(response, Response):
+                if response.status_code == 204:
+                    return None
+                return adapter.validate_json(response.text, by_alias=True, strict=True)
+            else:
+                # In cases where a return_key is specified, the response will already be parsed into a dict
+                return adapter.validate_python(response, by_alias=True, strict=True)
+
+        origin = get_origin(_class)
+        modelable_origin = origin is Union or origin is dict or origin is list
+        if modelable_origin or utils.is_subclass(_class, JsonModel):
+            if _type_adapters.get(_class) is None:
+                _type_adapters[_class] = TypeAdapter(_class)
             return decoder
         else:
             return None

nisystemlink/clients/core/_uplink/_json_model.py

@@ -1,4 +1,4 @@
-from pydantic import BaseModel, Extra
+from pydantic import BaseModel, ConfigDict
 
 
 def _camelcase(s: str) -> str:
@@ -10,7 +10,9 @@ def _camelcase(s: str) -> str:
 class JsonModel(BaseModel):
     """Base class for models that are serialized to and from JSON."""
 
-    class Config:
-        alias_generator = _camelcase
-        allow_population_by_field_name = True
-        extra = Extra.ignore.value
+    model_config = ConfigDict(
+        alias_generator=_camelcase,
+        validate_by_name=True,
+        validate_by_alias=True,
+        extra="ignore",
+    )

nisystemlink/clients/dataframe/models/_column_filter.py

@@ -33,6 +33,6 @@ class ColumnFilter(JsonModel):
     * When ``value`` is ``NaN`` for a floating-point column, the operation must be ``NOT_EQUALS``.
     """
 
-    value: Optional[str]
+    value: Optional[str] = None
     """The comparison value to use for filtering. An error will be returned if
     the value cannot be converted to the column's data type."""

nisystemlink/clients/file/models/_file_metadata.py

@@ -17,62 +17,62 @@ class FileMetadata(JsonModel):
     - updateMetadata: Link to update the file's metadata using a POST request
     """
 
-    created: Optional[datetime]
+    created: Optional[datetime] = None
     """
     The date and time the file was created in the file service.
 
     example :2018-05-15T18:54:27.519Z
     """
 
-    id: Optional[str]
+    id: Optional[str] = None
     """
     The file's ID within the service group.
 
     example: "5afb2ce3741fe11d88838cc9"
     """
 
-    path: Optional[str]
+    path: Optional[str] = None
     """
     The path to the file on the server.  This field is returned only if
     the user has associated privileges to view file paths.
 
     example: C:\temp\4afb2ce3741fe11d88838cc9.txt
     """
 
-    properties: Optional[Dict[str, str]]
+    properties: Optional[Dict[str, str]] = None
     """
     The file's properties
     Example - {"Name": "myfile.txt", "MyProperty": "Value"}
     """
 
-    meta_data_revision: Optional[int]
+    meta_data_revision: Optional[int] = None
     """
     The file's properties revision number. When a file is uploaded, the revision number starts at 1.
     Every time metadata is updated, the revision number is incremented by 1.
     """
 
-    service_group: Optional[str]
+    service_group: Optional[str] = None
     """
     The service group that owns the file
     """
 
-    size: Optional[int]
+    size: Optional[int] = None
     """
     The 32-bit file size in bytes. If the value is larger than a 32-bit integer,
     this value is -1 and the size64 parameter contains the correct value.
     """
 
-    size64: Optional[int]
+    size64: Optional[int] = None
     """
     The 64-bit file size in bytes
     """
 
-    workspace: Optional[str]
+    workspace: Optional[str] = None
     """
     The workspace the file belongs to
     """
 
-    last_updated_timestamp: Optional[datetime]
+    last_updated_timestamp: Optional[datetime] = None
     """
     The date and time the file was last updated in the file service.
 

nisystemlink/clients/file/models/_link.py

@@ -3,7 +3,7 @@
 
 
 class Link(JsonModel):
-    href: str = Field(..., example="/nifile/v1/service-groups")
+    href: str = Field(..., examples=["/nifile/v1/service-groups"])
     """
     URI of the link
     """

nisystemlink/clients/file/models/_operations.py

@@ -5,16 +5,16 @@
 
 
 class Operations(JsonModel):
-    delete_files: Optional[Operation]
-    download_data: Optional[Operation]
-    list_files: Optional[Operation]
-    query_files: Optional[Operation]
-    update_metadata: Optional[Operation]
-    upload_files: Optional[Operation]
+    delete_files: Optional[Operation] = None
+    download_data: Optional[Operation] = None
+    list_files: Optional[Operation] = None
+    query_files: Optional[Operation] = None
+    update_metadata: Optional[Operation] = None
+    upload_files: Optional[Operation] = None
 
 
 class V1Operations(JsonModel):
-    operations: Optional[Operations]
+    operations: Optional[Operations] = None
     """
     Available operations in the v1 version of the API:
     - deleteFiles: The ability to delete uploaded files