pjdev-postgres 4.1.0a2__tar.gz → 4.2.0a2__tar.gz

{pjdev_postgres-4.1.0a2 → pjdev_postgres-4.2.0a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pjdev-postgres
-Version: 4.1.0a2
+Version: 4.2.0a2
 Project-URL: Documentation, https://gitlab.purplejay.net/keystone/python/-/tree/main/keystone-postgres/README.md
 Project-URL: Issues, https://gitlab.purplejay.net/keystone/python/-/issues
 Project-URL: Source, https://gitlab.purplejay.net/keystone/python
@@ -22,6 +22,7 @@ Requires-Dist: ruff; extra == 'dev'
 Provides-Extra: test
 Requires-Dist: coverage; extra == 'test'
 Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytz; extra == 'test'
 Description-Content-Type: text/markdown
 
 # keystone-postgres

{pjdev_postgres-4.1.0a2 → pjdev_postgres-4.2.0a2}/pyproject.toml

@@ -34,7 +34,8 @@ dev = [
 
 test = [
     "pytest",
-    "coverage"
+    "coverage",
+    "pytz"
 ]
 
 [project.urls]

{pjdev_postgres-4.1.0a2 → pjdev_postgres-4.2.0a2}/src/pjdev_postgres/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2024-present Chris O'Neill <chris@purplejay.io>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "4.1.0a2"
+__version__ = "4.2.0a2"

{pjdev_postgres-4.1.0a2 → pjdev_postgres-4.2.0a2}/src/pjdev_postgres/model_validators.py

@@ -55,4 +55,4 @@ def make_date_validator_for_formats(
     return validator
 
 
-date_validator = BeforeValidator(make_date_validator_for_formats(["iso"], date))
+date_validator = BeforeValidator(make_date_validator_for_formats(["iso"], datetime))

{pjdev_postgres-4.1.0a2 → pjdev_postgres-4.2.0a2}/src/pjdev_postgres/models.py

@@ -1,9 +1,9 @@
-from datetime import datetime, UTC
+from datetime import datetime, timezone
 from typing import Optional, Annotated
-from uuid import UUID
+from uuid import UUID, uuid4
 
 from pydantic import BaseModel
-from sqlmodel import SQLModel, Field, Index
+from sqlmodel import SQLModel, Field
 
 from pjdev_postgres.model_validators import date_validator
 
@@ -22,7 +22,7 @@ class Auditable(BaseModel):
     created_by_id: Optional[str] = None
     created_by: Optional[str] = None
     created_datetime: Annotated[
-        datetime, date_validator, Field(default_factory=lambda: datetime.now(UTC))
+        datetime, date_validator, Field(default_factory=lambda: datetime.now(timezone.utc), index=True)
     ]
     last_modified_by_id: Optional[str] = None
     last_modified_by: Optional[str] = None
@@ -30,7 +30,7 @@ class Auditable(BaseModel):
 
 
 class TableModel(SQLModel):
-    row_id: Optional[int] = Field(default=None, primary_key=True)
+    id: Annotated[UUID, Field(default_factory=uuid4, primary_key=True)]
 
 
 class Savable(Versioned, Auditable, TableModel):
@@ -38,19 +38,13 @@ class Savable(Versioned, Auditable, TableModel):
 
 
 class History(TableModel, table=True):
-    entity_name: str
-    entity_id: int
+    entity_name: Annotated[str, Field(index=True)]
+    entity_id: Annotated[UUID, Field(index=True)]
     value: str
     timestamp: Annotated[
-        datetime, date_validator, Field(default_factory=lambda: datetime.now(UTC))
+        datetime, date_validator, Field(default_factory=lambda: datetime.now(timezone.utc), index=True)
     ]
 
-    __table_args__ = (
-        Index("ix_history_entity_id", "entity_id"),
-        Index("ix_history_entity_name", "entity_name"),
-        Index("ix_history_timestamp", "timestamp"),
-    )
-
 
 class ConcurrencyException(BaseException):
     def __init__(self, message: str):

{pjdev_postgres-4.1.0a2 → pjdev_postgres-4.2.0a2}/src/pjdev_postgres/postgres_service.py

@@ -1,10 +1,10 @@
 from contextlib import contextmanager
-from datetime import datetime, UTC
-from typing import List, Optional, Type, TypeVar, Callable, Tuple
+from datetime import datetime, timezone
+from typing import List, Optional, Type, TypeVar, Callable, Tuple, Any, Generator
 from uuid import UUID
 
 from sqlalchemy import Engine
-from sqlmodel import SQLModel, create_engine, Session as SQLModelSession
+from sqlmodel import SQLModel, create_engine, Session as SQLModelSession, Session
 
 from pjdev_postgres import postgres_settings, concurrency_service
 from pjdev_postgres.models import ConnectionOptions, Savable, History
@@ -20,8 +20,9 @@ __ctx = Context()
 
 
 def initialize_engine(
-    tables: List[Type[SQLModel]],
-    options: Optional[ConnectionOptions] = None,
+        tables: List[Type[SQLModel]],
+        options: Optional[ConnectionOptions] = None,
+        create_tables: bool = False,
 ) -> Engine:
     if options is None:
         options = ConnectionOptions()
@@ -31,7 +32,7 @@ def initialize_engine(
     if len(tables) == 0:
         raise ValueError("Must specify at least one table")
 
-    db_url = f"postgresql+psycopg://{settings.username}:{settings.password}@{settings.host}:{settings.port}/{settings.name}"
+    db_url = settings.get_url()
 
     engine = create_engine(
         db_url,
@@ -40,20 +41,21 @@ def initialize_engine(
         max_overflow=options.max_overflow,
     )
 
-    for t in tables:
-        t.__table__.create(bind=engine, checkfirst=True)
+    if create_tables:
+        for t in tables:
+            t.__table__.create(bind=engine, checkfirst=True)
 
     return engine
 
 
 def configure_single_context(
-    tables: List[Type[SQLModel]], options: Optional[ConnectionOptions] = None
+        tables: List[Type[SQLModel]], options: Optional[ConnectionOptions] = None
 ):
     __ctx.engine = initialize_engine(tables, options)
 
 
 @contextmanager
-def session_context() -> SQLModelSession:
+def session_context() -> Generator[Session, Any, None]:
     with SQLModelSession(__ctx.engine) as session:
         try:
             yield session
@@ -61,20 +63,20 @@ def session_context() -> SQLModelSession:
             session.close()
 
 
-def get_session() -> SQLModelSession:
+def get_session() -> Generator[Session, Any, None]:
     with SQLModelSession(__ctx.engine) as session:
         yield session
 
 
 def save(
-    obj: T,
-    user_resolver: Callable[[], Tuple[Optional[str], str]],
-    session: SQLModelSession,
-    concurrency_token: Optional[UUID] = None,
-    commit: bool = True,
+        obj: T,
+        user_resolver: Callable[[], Tuple[Optional[str], str]],
+        session: SQLModelSession,
+        concurrency_token: Optional[UUID] = None,
+        commit: bool = True,
 ) -> T:
     updated_obj = concurrency_service.validate_version(obj, concurrency_token)
-    updated_obj.last_modified_datetime = datetime.now(UTC)
+    updated_obj.last_modified_datetime = datetime.now(timezone.utc)
     user_oid, username = user_resolver()
     updated_obj.last_modified_by_id = user_oid
     updated_obj.last_modified_by = username
@@ -83,7 +85,7 @@ def save(
 
     history = History(
         entity_name=updated_obj.__class__.__name__.lower(),
-        entity_id=updated_obj.row_id,
+        entity_id=updated_obj.id,
         value=updated_obj.model_dump_json(),
     )
     session.add(history)

{pjdev_postgres-4.1.0a2 → pjdev_postgres-4.2.0a2}/src/pjdev_postgres/postgres_settings.py

@@ -16,6 +16,9 @@ class PostgresSettings(BaseSettings):
         env_prefix="db_",
     )
 
+    def get_url(self) -> str:
+        return f"postgresql+psycopg://{self.username}:{self.password}@{self.host}:{self.port}/{self.name}"
+
 
 class Context:
     settings: Optional[PostgresSettings] = None

{pjdev_postgres-4.1.0a2 → pjdev_postgres-4.2.0a2}/test_report_pjdev-postgres.txt

@@ -7,4 +7,4 @@ collecting ... collected 1 item
 
 tests/tests_for_history.py::test_history_item_is_created_and_saved PASSED [100%]
 
-============================== 1 passed in 0.63s ===============================
+============================== 1 passed in 1.06s ===============================

{pjdev_postgres-4.1.0a2 → pjdev_postgres-4.2.0a2}/tests/tests_for_history.py

@@ -2,7 +2,7 @@ from pjdev_postgres import postgres_service
 from pjdev_postgres.models import Savable, History
 from sqlmodel import Session, select
 from utilities import init_test_db
-
+import pytz
 
 def test_history_item_is_created_and_saved():
     class MockObj(Savable):
@@ -25,8 +25,8 @@ def test_history_item_is_created_and_saved():
         assert saved_obj.last_modified_by_id is not None
 
     with Session(engine) as session2:
-        mock_row = session2.exec(
-            select(MockTable).where(MockTable.row_id == obj.row_id)
+        mock_row: MockTable = session2.exec(
+            select(MockTable).where(MockTable.id == obj.id)
         ).one_or_none()
         history_mock = session2.exec(select(History)).all()
         assert len(history_mock) == 1
@@ -37,6 +37,11 @@ def test_history_item_is_created_and_saved():
         #   https://github.com/tiangolo/sqlmodel/issues/52#issuecomment-1311987732
 
         historical_mock_row = MockObj.model_validate_json(history_mock[0].value)
+
+        # Must add the utc timezone info due to sqlite not preserving tz info
+        mock_row.last_modified_datetime = pytz.utc.localize(mock_row.last_modified_datetime)
+        mock_row.created_datetime = pytz.utc.localize(mock_row.created_datetime)
+
         assert historical_mock_row == MockObj.model_validate(mock_row)
         assert mock_row.last_modified_datetime is not None
         assert mock_row.last_modified_by is not None