👷 Add support for Pydantic v1 (#116)

* 👷 Run tests on Pydantic v1

* T

* Add pydantic compat

* More compat

* Re add cache

Author: patrick91

.github/workflows/test.yml

@@ -23,16 +23,23 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version:
-          - "3.8"
-          - "3.9"
-          - "3.10"
-          - "3.11"
-          - "3.12"
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+        pydantic-version: ["v2"]
+        include:
+          - python-version: "3.8"
+            pydantic-version: "v1"
+          - python-version: "3.9"
+            pydantic-version: "v1"
+          - python-version: "3.10"
+            pydantic-version: "v1"
+          - python-version: "3.11"
+            pydantic-version: "v1"
+          - python-version: "3.12"
+            pydantic-version: "v1"
       fail-fast: false
+    runs-on: ubuntu-latest
     steps:
       - name: Dump GitHub context
         env:
@@ -50,7 +57,7 @@ jobs:
         id: cache
         with:
           path: ${{ env.pythonLocation }}
-          key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-tests.txt') }}
+          key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-tests.txt') }}-{{ matrix.pydantic-version }}
       # Allow debugging with tmate
       - name: Setup tmate session
         uses: mxschmitt/action-tmate@v3
@@ -60,6 +67,9 @@ jobs:
       - name: Install Dependencies
         if: steps.cache.outputs.cache-hit != 'true'
         run: pip install -r requirements-tests.txt
+      - name: Install Pydantic v1
+        if: matrix.pydantic-version == 'v1'
+        run: pip install "pydantic<2.0.0"
       - name: Lint
         run: bash scripts/lint.sh
       - run: mkdir coverage
@@ -71,7 +81,7 @@ jobs:
       - name: Store coverage files
         uses: actions/upload-artifact@v4
         with:
-          name: coverage-${{ matrix.python-version }}
+          name: coverage-${{ matrix.python-version }}-${{ matrix.pydantic-version }}
           path: coverage
           include-hidden-files: true
 

src/fastapi_cloud_cli/commands/deploy.py

@@ -13,7 +13,7 @@
 import rignore
 import typer
 from httpx import Client
-from pydantic import BaseModel, EmailStr, TypeAdapter, ValidationError
+from pydantic import BaseModel, EmailStr, ValidationError
 from rich.text import Text
 from rich_toolkit import RichToolkit
 from rich_toolkit.menu import Option
@@ -24,6 +24,11 @@
 from fastapi_cloud_cli.utils.apps import AppConfig, get_app_config, write_app_config
 from fastapi_cloud_cli.utils.auth import is_logged_in
 from fastapi_cloud_cli.utils.cli import get_rich_toolkit, handle_http_errors
+from fastapi_cloud_cli.utils.pydantic_compat import (
+    TypeAdapter,
+    model_dump,
+    model_validate,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -91,7 +96,7 @@ def _get_teams() -> List[Team]:
 
         data = response.json()["data"]
 
-    return [Team.model_validate(team) for team in data]
+    return [model_validate(Team, team) for team in data]
 
 
 class AppResponse(BaseModel):
@@ -108,7 +113,7 @@ def _create_app(team_id: str, app_name: str) -> AppResponse:
 
         response.raise_for_status()
 
-        return AppResponse.model_validate(response.json())
+        return model_validate(AppResponse, response.json())
 
 
 class DeploymentStatus(str, Enum):
@@ -161,7 +166,7 @@ def _create_deployment(app_id: str) -> CreateDeploymentResponse:
         response = client.post(f"/apps/{app_id}/deployments/")
         response.raise_for_status()
 
-        return CreateDeploymentResponse.model_validate(response.json())
+        return model_validate(CreateDeploymentResponse, response.json())
 
 
 class RequestUploadResponse(BaseModel):
@@ -186,7 +191,7 @@ def _upload_deployment(deployment_id: str, archive_path: Path) -> None:
         response = fastapi_client.post(f"/deployments/{deployment_id}/upload")
         response.raise_for_status()
 
-        upload_data = RequestUploadResponse.model_validate(response.json())
+        upload_data = model_validate(RequestUploadResponse, response.json())
         logger.debug("Received upload URL: %s", upload_data.url)
 
         # Upload the archive
@@ -221,7 +226,7 @@ def _get_app(app_slug: str) -> Optional[AppResponse]:
 
         data = response.json()
 
-    return AppResponse.model_validate(data)
+    return model_validate(AppResponse, data)
 
 
 def _get_apps(team_id: str) -> List[AppResponse]:
@@ -231,7 +236,7 @@ def _get_apps(team_id: str) -> List[AppResponse]:
 
         data = response.json()["data"]
 
-    return [AppResponse.model_validate(app) for app in data]
+    return [model_validate(AppResponse, app) for app in data]
 
 
 def _stream_build_logs(deployment_id: str) -> Generator[str, None, None]:
@@ -416,9 +421,7 @@ def _send_waitlist_form(
     with toolkit.progress("Sending your request...") as progress:
         with APIClient() as client:
             with handle_http_errors(progress):
-                response = client.post(
-                    "/users/waiting-list", json=result.model_dump(mode="json")
-                )
+                response = client.post("/users/waiting-list", json=model_dump(result))
 
                 response.raise_for_status()
 
@@ -443,7 +446,7 @@ def _waitlist_form(toolkit: RichToolkit) -> None:
 
     toolkit.print_line()
 
-    result = SignupToWaitingList(email=email)
+    result = model_validate(SignupToWaitingList, {"email": email})
 
     if toolkit.confirm(
         "Do you want to get access faster by giving us more information?",
@@ -467,11 +470,12 @@ def _waitlist_form(toolkit: RichToolkit) -> None:
         result = form.run()  # type: ignore
 
         try:
-            result = SignupToWaitingList.model_validate(
+            result = model_validate(
+                SignupToWaitingList,
                 {
                     "email": email,
                     **result,  # type: ignore
-                }
+                },
             )
         except ValidationError:
             toolkit.print(

src/fastapi_cloud_cli/commands/env.py

@@ -11,6 +11,7 @@
 from fastapi_cloud_cli.utils.auth import is_logged_in
 from fastapi_cloud_cli.utils.cli import get_rich_toolkit, handle_http_errors
 from fastapi_cloud_cli.utils.env import validate_environment_variable_name
+from fastapi_cloud_cli.utils.pydantic_compat import model_validate
 
 logger = logging.getLogger(__name__)
 
@@ -29,7 +30,7 @@ def _get_environment_variables(app_id: str) -> EnvironmentVariableResponse:
         response = client.get(f"/apps/{app_id}/environment-variables/")
         response.raise_for_status()
 
-        return EnvironmentVariableResponse.model_validate(response.json())
+        return model_validate(EnvironmentVariableResponse, response.json())
 
 
 def _delete_environment_variable(app_id: str, name: str) -> bool:

src/fastapi_cloud_cli/commands/login.py

@@ -16,6 +16,7 @@
     write_auth_config,
 )
 from fastapi_cloud_cli.utils.cli import get_rich_toolkit, handle_http_errors
+from fastapi_cloud_cli.utils.pydantic_compat import model_validate_json
 
 logger = logging.getLogger(__name__)
 
@@ -43,7 +44,7 @@ def _start_device_authorization(
 
     response.raise_for_status()
 
-    return AuthorizationData.model_validate(response.json())
+    return model_validate_json(AuthorizationData, response.text)
 
 
 def _fetch_access_token(client: httpx.Client, device_code: str, interval: int) -> str:
@@ -73,7 +74,7 @@ def _fetch_access_token(client: httpx.Client, device_code: str, interval: int) -
 
         time.sleep(interval)
 
-    response_data = TokenResponse.model_validate(response.json())
+    response_data = model_validate_json(TokenResponse, response.text)
 
     return response_data.access_token
 

src/fastapi_cloud_cli/utils/apps.py

@@ -4,6 +4,8 @@
 
 from pydantic import BaseModel
 
+from fastapi_cloud_cli.utils.pydantic_compat import model_dump_json, model_validate_json
+
 logger = logging.getLogger("fastapi_cli")
 
 
@@ -21,7 +23,7 @@ def get_app_config(path_to_deploy: Path) -> Optional[AppConfig]:
         return None
 
     logger.debug("App config loaded successfully")
-    return AppConfig.model_validate_json(config_path.read_text(encoding="utf-8"))
+    return model_validate_json(AppConfig, config_path.read_text(encoding="utf-8"))
 
 
 README = """
@@ -50,7 +52,7 @@ def write_app_config(path_to_deploy: Path, app_config: AppConfig) -> None:
     config_path.parent.mkdir(parents=True, exist_ok=True)
 
     config_path.write_text(
-        app_config.model_dump_json(),
+        model_dump_json(app_config),
         encoding="utf-8",
     )
     readme_path.write_text(README, encoding="utf-8")

src/fastapi_cloud_cli/utils/auth.py

@@ -7,6 +7,8 @@
 
 from pydantic import BaseModel
 
+from fastapi_cloud_cli.utils.pydantic_compat import model_dump_json, model_validate_json
+
 from .config import get_auth_path
 
 logger = logging.getLogger("fastapi_cli")
@@ -20,7 +22,7 @@ def write_auth_config(auth_data: AuthConfig) -> None:
     auth_path = get_auth_path()
     logger.debug("Writing auth config to: %s", auth_path)
 
-    auth_path.write_text(auth_data.model_dump_json(), encoding="utf-8")
+    auth_path.write_text(model_dump_json(auth_data), encoding="utf-8")
     logger.debug("Auth config written successfully")
 
 
@@ -44,7 +46,7 @@ def read_auth_config() -> Optional[AuthConfig]:
         return None
 
     logger.debug("Auth config loaded successfully")
-    return AuthConfig.model_validate_json(auth_path.read_text(encoding="utf-8"))
+    return model_validate_json(AuthConfig, auth_path.read_text(encoding="utf-8"))
 
 
 def get_auth_token() -> Optional[str]:

src/fastapi_cloud_cli/utils/pydantic_compat.py

@@ -0,0 +1,63 @@
+from typing import Any, Dict, Generic, Type, TypeVar
+
+from pydantic import BaseModel
+from pydantic.version import VERSION as PYDANTIC_VERSION
+
+PYDANTIC_VERSION_MINOR_TUPLE = tuple(int(x) for x in PYDANTIC_VERSION.split(".")[:2])
+PYDANTIC_V2 = PYDANTIC_VERSION_MINOR_TUPLE[0] == 2
+
+
+T = TypeVar("T")
+Model = TypeVar("Model", bound=BaseModel)
+
+
+def model_validate(model_class: Type[Model], data: Dict[Any, Any]) -> Model:
+    if PYDANTIC_V2:
+        return model_class.model_validate(data)  # type: ignore[no-any-return, unused-ignore, attr-defined]
+    else:
+        return model_class.parse_obj(data)  # type: ignore[no-any-return, unused-ignore, attr-defined]
+
+
+def model_validate_json(model_class: Type[Model], data: str) -> Model:
+    if PYDANTIC_V2:
+        return model_class.model_validate_json(data)  # type: ignore[no-any-return, unused-ignore, attr-defined]
+    else:
+        return model_class.parse_raw(data)  # type: ignore[no-any-return, unused-ignore, attr-defined]
+
+
+def model_dump(obj: BaseModel, **kwargs: Any) -> Dict[Any, Any]:
+    if PYDANTIC_V2:
+        return obj.model_dump(**kwargs)  # type: ignore[no-any-return, unused-ignore, attr-defined]
+    else:
+        return obj.dict(**kwargs)  # type: ignore[no-any-return, unused-ignore, attr-defined]
+
+
+def model_dump_json(obj: BaseModel) -> str:
+    if PYDANTIC_V2:
+        return obj.model_dump_json()  # type: ignore[no-any-return, unused-ignore, attr-defined]
+    else:
+        # Use compact separators to match Pydantic v2's output format
+        return obj.json(separators=(",", ":"))  # type: ignore[no-any-return, unused-ignore, attr-defined]
+
+
+class TypeAdapter(Generic[T]):
+    def __init__(self, type_: Type[T]) -> None:
+        self.type_ = type_
+
+        if PYDANTIC_V2:
+            from pydantic import (  # type: ignore[attr-defined, unused-ignore]
+                TypeAdapter as PydanticTypeAdapter,
+            )
+
+            self._adapter = PydanticTypeAdapter(type_)
+        else:
+            self._adapter = None  # type: ignore[assignment, unused-ignore]
+
+    def validate_python(self, value: Any) -> T:
+        """Validate a Python object against the type."""
+        if PYDANTIC_V2:
+            return self._adapter.validate_python(value)  # type: ignore[no-any-return, union-attr, unused-ignore]
+        else:
+            from pydantic import parse_obj_as
+
+            return parse_obj_as(self.type_, value)  # type: ignore[no-any-return, unused-ignore]