Merge pull request #225 from developmentseed/patch/remove-tipg-schema-alias-settings

remove alias for tipg-schema in DatabaseSettings

Author: vincentsarago

CHANGES.md

@@ -8,6 +8,10 @@ Note: Minor version `0.X.0` update might break the API, It's recommended to pin
 
 ## [unreleased]
 
+## [1.1.1] - 2025-06-13
+
+* remove `tipg_schema` alias in `DatabaseSettings` to support env variable settings
+
 ## [1.1.0] - 2025-05-06
 
 * update geojson-pydantic requirement to `>=1.0,<3.0`
@@ -394,7 +398,8 @@ Note: Minor version `0.X.0` update might break the API, It's recommended to pin
 
 - Initial release
 
-[unreleased]: https://github.com/developmentseed/tipg/compare/1.1.0...HEAD
+[unreleased]: https://github.com/developmentseed/tipg/compare/1.1.1...HEAD
+[1.1.1]: https://github.com/developmentseed/tipg/compare/1.1.1...1.1.1
 [1.1.0]: https://github.com/developmentseed/tipg/compare/1.0.1...1.1.0
 [1.0.1]: https://github.com/developmentseed/tipg/compare/1.0.0...1.0.1
 [1.0.0]: https://github.com/developmentseed/tipg/compare/0.10.0...1.0.0

tests/test_settings.py

@@ -3,7 +3,7 @@
 import pytest
 from pydantic import ValidationError
 
-from tipg.settings import PostgresSettings
+from tipg.settings import DatabaseSettings, PostgresSettings
 
 
 def test_pg_settings(monkeypatch):
@@ -48,3 +48,31 @@ def test_pg_settings(monkeypatch):
     )
     assert str(settings.database_url) == "postgresql://user:secret@0.0.0.0:8888/db"
     assert not settings.postgres_port
+
+
+def test_db_settings(monkeypatch):
+    """test DatabaseSettings class."""
+    monkeypatch.delenv("TIPG_DB_SCHEMAS", raising=False)
+    monkeypatch.delenv("TIPG_DB_APPLICATION_SCHEMA", raising=False)
+
+    settings = DatabaseSettings(_env_file=None)
+    assert settings.schemas == ["public"]
+    assert settings.tipg_schema == "pg_temp"
+
+    settings = DatabaseSettings(
+        schemas=["private"],
+        application_schema="pg_tipg_temp",
+        _env_file=None,
+    )
+    assert settings.schemas == ["private"]
+    assert settings.tipg_schema == "pg_tipg_temp"
+
+
+def test_db_settings_env(monkeypatch):
+    """test DatabaseSettings class with env variable."""
+    monkeypatch.setenv("TIPG_DB_SCHEMAS", '["private"]')
+    monkeypatch.setenv("TIPG_DB_APPLICATION_SCHEMA", "pg_tipg_temp")
+
+    settings = DatabaseSettings(_env_file=None)
+    assert settings.schemas == ["private"]
+    assert settings.tipg_schema == "pg_tipg_temp"

tipg/settings.py

@@ -164,7 +164,7 @@ class DatabaseSettings(BaseSettings):
     """TiPg Database settings."""
 
     schemas: List[str] = ["public"]
-    tipg_schema: str = Field("pg_temp", alias="application_schema")
+    application_schema: str = "pg_temp"
     tables: Optional[List[str]] = None
     exclude_tables: Optional[List[str]] = None
     exclude_table_schemas: Optional[List[str]] = None
@@ -178,6 +178,13 @@ class DatabaseSettings(BaseSettings):
 
     model_config = {"env_prefix": "TIPG_DB_", "env_file": ".env", "extra": "ignore"}
 
+    @property
+    def tipg_schema(self):
+        """Compat: use application_schema for input and tipg_schema for attribute.
+        see https://github.com/developmentseed/tipg/issues/224
+        """
+        return self.application_schema
+
 
 class CustomSQLSettings(BaseSettings):
     """TiPg Custom SQL settings."""