fastapi-rtk 2.21.0__tar.gz → 2.21.2__tar.gz

{fastapi_rtk-2.21.0 → fastapi_rtk-2.21.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: fastapi-rtk
-Version: 2.21.0
+Version: 2.21.2
 Summary: A package that provides a set of tools to build a FastAPI application with a Class-Based CRUD API.
 Project-URL: Homepage, https://codeberg.org/datatactics/fastapi-rtk
 Project-URL: Issues, https://codeberg.org/datatactics/fastapi-rtk/issues

fastapi_rtk-2.21.2/fastapi_rtk/_version.py

@@ -0,0 +1 @@
+__version__ = "2.21.2"

{fastapi_rtk-2.21.0 → fastapi_rtk-2.21.2}/fastapi_rtk/cli/commands/db/__init__.py

@@ -501,4 +501,6 @@ def check(
     """Check the current revision."""
     config = Config()
     config.set_main_option("script_location", directory)
+    # The env.py templates test `in config.cmd_opts`; "autogenerate" would empty the directives check reads.
+    config.cmd_opts = []
     alembic.command.check(config)

{fastapi_rtk-2.21.0 → fastapi_rtk-2.21.2}/fastapi_rtk/schemas.py

@@ -418,9 +418,10 @@ class QuerySchema(pydantic.BaseModel):
     page_size: int | None = DEFAULT_API_PAGE_SIZE
     order_column: str | None = None
     order_direction: typing.Literal["asc", "desc"] | None = None
-    columns: str = "[]"
-    filters: str = "[]"
-    opr_filters: str = "[]"
+    # The validators turn these JSON strings into lists, so an omitted field must go through them too
+    columns: str = pydantic.Field(default="[]", validate_default=True)
+    filters: str = pydantic.Field(default="[]", validate_default=True)
+    opr_filters: str = pydantic.Field(default="[]", validate_default=True)
     search: str | None = None
     # TODO: Remove when the deprecated global_filter alias is dropped
     global_filter: str | None = pydantic.Field(
@@ -660,7 +661,8 @@ class LookupQuerySchema(pydantic.BaseModel):
     page: int = 0
     page_size: int | None = DEFAULT_API_MAX_PAGE_SIZE
     search: str | None = None
-    ids: str = "[]"
+    # The validator turns this JSON string into a list, so an omitted field must go through it too
+    ids: str = pydantic.Field(default="[]", validate_default=True)
 
     @pydantic.field_validator("page")
     @classmethod

{fastapi_rtk-2.21.0 → fastapi_rtk-2.21.2}/tests/unit/api/model_rest_api/test_init.py

@@ -199,6 +199,13 @@ class TestValidateQueryParameters:
         with pytest.raises(HTTPWithValidationException):
             api._validate_query_parameters(q)
 
+    def test_omitted_columns_pass(self, Widget_cls):
+        class TierVQ3Api(ModelRestApi):
+            datamodel = SQLAInterface(Widget_cls)
+
+        api = TierVQ3Api()
+        api._validate_query_parameters(QuerySchema())
+
 
 class TestHandleQueryParams:
     def test_returns_db_query_params(self, Widget_cls):
@@ -222,6 +229,16 @@ class TestHandleQueryParams:
         # list_columns from the API used as default (should include name etc.)
         assert "name" in result["list_columns"]
 
+    def test_omitted_query_fields_yield_empty_lists(self, Widget_cls):
+        class TierHQ3Api(ModelRestApi):
+            datamodel = SQLAInterface(Widget_cls)
+
+        api = TierHQ3Api()
+        result = api._handle_query_params(QuerySchema())
+        assert result["list_columns"] == api.list_select_columns
+        assert result["filters"] == []
+        assert result["opr_filters"] == []
+
     def test_base_order_applied_when_q_lacks_order(self, Widget_cls):
         class TierHQBaseApi(ModelRestApi):
             datamodel = SQLAInterface(Widget_cls)

{fastapi_rtk-2.21.0 → fastapi_rtk-2.21.2}/tests/unit/cli/commands/test_db.py

@@ -2,8 +2,10 @@
 
 import unittest.mock
 
+import alembic.util
+import pytest
+import sqlalchemy
 import typer.testing
-
 from fastapi_rtk.cli.cli import app
 
 runner = typer.testing.CliRunner()
@@ -228,3 +230,58 @@ class TestAppCheckPartition:
         # migrate is undecorated; the single check fires through revision.
         neutralize_app_check.get_import_data.assert_called_once()
         neutralize_app_check.run_in_current_event_loop.assert_called_once()
+
+
+@pytest.mark.parametrize("multidb", [False, True], ids=["fastapi", "fastapi-multidb"])
+class TestCheckAgainstTemplate:
+    """`db check` runs the real alembic check through the env.py each bundled template writes."""
+
+    @pytest.fixture
+    def migrations(self, tmp_path, monkeypatch, config_setter, multidb):
+        """
+        Init a migration repository from the template against an empty sqlite database.
+
+        Args:
+            tmp_path: Per-test directory holding the database and the repository.
+            monkeypatch: Swaps the toolkit metadata for an empty one.
+            config_setter: Sets the database URI the env.py reads.
+            multidb: Whether to init from the multidb template.
+
+        Returns:
+            The repository directory and the metadata the env.py compares against.
+        """
+        from fastapi_rtk.cli.commands.db import init
+        from fastapi_rtk.const import DEFAULT_METADATA_KEY
+
+        config_setter(
+            "SQLALCHEMY_DATABASE_URI", f"sqlite+aiosqlite:///{tmp_path / 'app.db'}"
+        )
+        metadata = sqlalchemy.MetaData()
+        monkeypatch.setattr("fastapi_rtk.metadata", metadata)
+        monkeypatch.setattr("fastapi_rtk.metadatas", {DEFAULT_METADATA_KEY: metadata})
+        directory = str(tmp_path / "migrations")
+        init(directory=directory, multidb=multidb)
+        return directory, metadata
+
+    def test_no_drift_reports_clean(
+        self, migrations, neutralize_app_check, monkeypatch
+    ):
+        from fastapi_rtk.cli.commands.db import Config, check
+
+        printed = unittest.mock.MagicMock()
+        monkeypatch.setattr(Config, "print_stdout", printed)
+        directory, _ = migrations
+        check(directory=directory)
+        printed.assert_called_once_with("No new upgrade operations detected.")
+
+    def test_drift_is_reported(self, migrations, neutralize_app_check):
+        from fastapi_rtk.cli.commands.db import check
+
+        directory, metadata = migrations
+        sqlalchemy.Table(
+            "drifted",
+            metadata,
+            sqlalchemy.Column("id", sqlalchemy.Integer, primary_key=True),
+        )
+        with pytest.raises(alembic.util.AutogenerateDiffsDetected):
+            check(directory=directory)

{fastapi_rtk-2.21.0 → fastapi_rtk-2.21.2}/tests/unit/test_schemas.py

@@ -9,6 +9,7 @@ import pytest
 from fastapi_rtk.exceptions import HTTPWithValidationException
 from fastapi_rtk.schemas import (
     FilterSchema,
+    LookupQuerySchema,
     OprFilterSchema,
     QueryBody,
     QuerySchema,
@@ -72,6 +73,18 @@ class TestOprFiltersValidator:
             QuerySchema(opr_filters="not-json")
 
 
+class TestOmittedListFields:
+    @pytest.mark.parametrize("schema", [QuerySchema, QueryBody])
+    def test_omitted_fields_are_empty_lists(self, schema):
+        q = schema()
+        assert q.columns == []
+        assert q.filters == []
+        assert q.opr_filters == []
+
+    def test_omitted_lookup_ids_is_empty_list(self):
+        assert LookupQuerySchema(mode="search").ids == []
+
+
 class TestSearch:
     def test_search_is_copied_to_global_filter(self):
         q = QuerySchema(search="abc")

fastapi_rtk-2.21.0/fastapi_rtk/_version.py

@@ -1 +0,0 @@
-__version__ = "2.21.0"