pjdev-postgres 3.5.0__py3-none-any.whl

pjdev_postgres/__about__.py

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

pjdev_postgres/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present Chris O'Neill <chris@purplejay.io>
+#
+# SPDX-License-Identifier: MIT

pjdev_postgres/concurrency_service.py

@@ -0,0 +1,33 @@
+from typing import TypeVar, Optional
+from uuid import UUID, uuid4
+from loguru import logger
+
+from pjdev_postgres.models import Versioned, ConcurrencyException
+
+T = TypeVar("T", bound=Versioned)
+
+
+def parse_concurrency_token(token: str) -> Optional[UUID]:
+    try:
+        concurrency_token = UUID(token) if token is not None else None
+        return concurrency_token
+    except TypeError as e:
+        logger.warning(f"{e}")
+        logger.warning(f"Tried parsing invalid uuid: {token}")
+
+
+def increment_version(obj: T) -> T:
+    obj.concurrency_token = uuid4()
+
+    return obj
+
+
+def validate_version(obj: T, token: Optional[str | UUID] = None) -> T:
+    concurrency_token = token
+    if not isinstance(token, UUID):
+        concurrency_token = parse_concurrency_token(token)
+
+    if obj.concurrency_token is not None and obj.concurrency_token != concurrency_token:
+        raise ConcurrencyException("Stale data detected")
+
+    return increment_version(obj)

pjdev_postgres/model_validators.py

@@ -0,0 +1,58 @@
+from datetime import date, datetime, UTC
+from typing import Callable, List, Optional, Type, Any
+from loguru import logger
+from pydantic import BeforeValidator
+
+
+def make_date_validator(
+    date_format: str, date_obj_type: Type[date | datetime] = datetime
+) -> Callable[[str], Optional[date]]:
+    def validator(v: Optional[Any]) -> Optional[date]:
+        if not v:
+            return None
+
+        if isinstance(v, datetime):
+            formatted_value = v
+            if date_format == "iso":
+                formatted_value = v.astimezone(UTC)
+            return (
+                formatted_value if date_obj_type is datetime else formatted_value.date()
+            )
+
+        if isinstance(v, date):
+            return v
+
+        if not isinstance(v, str):
+            return None
+
+        stripped_value = v.strip()
+
+        if stripped_value in ["-", ""]:
+            return None
+
+        if date_format == "iso":
+            value = datetime.fromisoformat(v).replace(tzinfo=UTC)
+        else:
+            value = datetime.strptime(v, date_format)
+        return value.date() if date_obj_type is date else value
+
+    return validator
+
+
+def make_date_validator_for_formats(
+    date_formats: List[str], date_obj_type: Type[date | datetime] = datetime
+) -> Callable[[str], Optional[date]]:
+    def validator(v: Optional[Any]) -> Optional[date]:
+        for fmt in date_formats:
+            try:
+                return make_date_validator(fmt, date_obj_type)(v)
+            except ValueError as e:
+                logger.warning(e)
+                continue
+
+        return None
+
+    return validator
+
+
+date_validator = BeforeValidator(make_date_validator_for_formats(["iso"], date))

pjdev_postgres/models.py

@@ -0,0 +1,57 @@
+from datetime import datetime, UTC
+from typing import Optional, Annotated
+from uuid import UUID
+
+from pydantic import BaseModel
+from sqlmodel import SQLModel, Field, Index
+
+from pjdev_postgres.model_validators import date_validator
+
+
+class ConnectionOptions(BaseModel):
+    echo: bool = False
+    pool_size: int = 5
+    max_overflow: int = 10
+
+
+class Versioned(BaseModel):
+    concurrency_token: Optional[UUID] = None
+
+
+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))
+    ]
+    last_modified_by_id: Optional[str] = None
+    last_modified_by: Optional[str] = None
+    last_modified_datetime: Annotated[Optional[datetime], date_validator] = None
+
+
+class TableModel(SQLModel):
+    row_id: Optional[int] = Field(default=None, primary_key=True)
+
+
+class Savable(Versioned, Auditable, TableModel):
+    pass
+
+
+class History(TableModel, table=True):
+    entity_name: str
+    entity_id: int
+    value: str
+    timestamp: Annotated[
+        datetime, date_validator, Field(default_factory=lambda: datetime.now(UTC))
+    ]
+
+    __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):
+        super().__init__(message)

pjdev_postgres/postgres_service.py

@@ -0,0 +1,95 @@
+from contextlib import contextmanager
+from datetime import datetime, UTC
+from typing import List, Optional, Type, TypeVar, Callable, Tuple
+from uuid import UUID
+
+from sqlalchemy import Engine
+from sqlmodel import SQLModel, create_engine, Session as SQLModelSession
+
+from pjdev_postgres import postgres_settings, concurrency_service
+from pjdev_postgres.models import ConnectionOptions, Savable, History
+
+T = TypeVar("T", bound=Savable)
+
+
+class Context:
+    engine: Optional[Engine] = None
+
+
+__ctx = Context()
+
+
+def initialize_engine(
+    tables: List[Type[SQLModel]],
+    options: Optional[ConnectionOptions] = None,
+) -> Engine:
+    if options is None:
+        options = ConnectionOptions()
+
+    settings = postgres_settings.get_settings()
+
+    if len(tables) == 0:
+        raise ValueError("Must specify at least one table")
+
+    db_url = f"postgresql+psycopg://{settings.username}:{settings.password}@{settings.host}/{settings.name}"
+
+    engine = create_engine(
+        db_url,
+        echo=options.echo,
+        pool_size=options.pool_size,
+        max_overflow=options.max_overflow,
+    )
+
+    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
+):
+    __ctx.engine = initialize_engine(tables, options)
+
+
+@contextmanager
+def session_context() -> SQLModelSession:
+    with SQLModelSession(__ctx.engine) as session:
+        try:
+            yield session
+        finally:
+            session.close()
+
+
+def get_session() -> SQLModelSession:
+    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,
+) -> T:
+    updated_obj = concurrency_service.validate_version(obj, concurrency_token)
+    updated_obj.last_modified_datetime = datetime.now(UTC)
+    user_oid, username = user_resolver()
+    updated_obj.last_modified_by_id = user_oid
+    updated_obj.last_modified_by = username
+
+    session.flush([updated_obj])
+
+    history = History(
+        entity_name=updated_obj.__class__.__name__.lower(),
+        entity_id=updated_obj.row_id,
+        value=updated_obj.model_dump_json(),
+    )
+    session.add(history)
+
+    if commit:
+        session.commit()
+        session.refresh(updated_obj)
+
+    return updated_obj

pjdev_postgres/postgres_settings.py

@@ -0,0 +1,35 @@
+from pathlib import Path
+from typing import Optional
+
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class PostgresSettings(BaseSettings):
+    host: str = "localhost"
+    name: str
+    password: Optional[str] = None
+    username: Optional[str] = None
+    model_config = SettingsConfigDict(
+        case_sensitive=False,
+        extra="ignore",
+        env_nested_delimiter="__",
+        env_prefix="db_",
+    )
+
+
+class Context:
+    settings: Optional[PostgresSettings] = None
+
+
+__ctx = Context()
+
+
+def init_settings(root: Path):
+    __ctx.settings = PostgresSettings(_env_file=root / ".env")
+
+
+def get_settings() -> PostgresSettings:
+    if __ctx.settings is None:
+        msg = "Settings are not initialized -- call init_settings()"
+        raise Exception(msg)
+    return __ctx.settings

pjdev_postgres-3.5.0.dist-info/METADATA

@@ -0,0 +1,47 @@
+Metadata-Version: 2.3
+Name: pjdev-postgres
+Version: 3.5.0
+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
+Author-email: Purple Jay LLC <it@purplejay.io>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.12
+Requires-Dist: loguru
+Requires-Dist: psycopg[binary,pool]>=3.1.19
+Requires-Dist: pydantic-settings>=2.3.1
+Requires-Dist: sqlmodel>=0.0.19
+Provides-Extra: dev
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/markdown
+
+# keystone-postgres
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pjdev-postgres.svg)](https://pypi.org/project/pjdev-postgres)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pjdev-postgres.svg)](https://pypi.org/project/pjdev-postgres)
+
+-----
+
+**Table of Contents**
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install pjdev-postgres
+```
+
+## License
+
+`pjdev-postgres` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

pjdev_postgres-3.5.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+pjdev_postgres/__about__.py,sha256=-OJwVAONjchMJifFqKPLSg4cwo1wWGkZ5Mdg8P0ReWc,129
+pjdev_postgres/__init__.py,sha256=p8HS8DuMfFNAzuLS_PWRIyHOQdNes0L5TqNE9M-L7nc,107
+pjdev_postgres/concurrency_service.py,sha256=_FdPc4i40OZmEkREPv-rL3fkmey1ct55qCkUpLxhmqQ,960
+pjdev_postgres/model_validators.py,sha256=p2sxXcs-wWjRGbUByMjwoM8IiposWGu23Sr7bISLD8U,1688
+pjdev_postgres/models.py,sha256=6Gk-GeLrt6CRydsKrFqA7azcWPzIdx2xsFYuwTUmEdY,1491
+pjdev_postgres/postgres_service.py,sha256=obJ3wm6RTYFUbuItNds7WWH81nCLBHv9MILeN4PPm60,2464
+pjdev_postgres/postgres_settings.py,sha256=oDgMVQuir-XC-x1YssBgmYKBAW9kRCHUSZv7yWwaxJg,807
+pjdev_postgres-3.5.0.dist-info/METADATA,sha256=1iaBZuyQn0Yvqi97L-PO1q64UQfT8nVzZK2UP5i3xTw,1570
+pjdev_postgres-3.5.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+pjdev_postgres-3.5.0.dist-info/licenses/LICENSE.txt,sha256=0wYf-NtzsFHBi7LG7ANo5X1v8sZfdv-7ZoslV6Vy3nA,1099
+pjdev_postgres-3.5.0.dist-info/RECORD,,

pjdev_postgres-3.5.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.25.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pjdev_postgres-3.5.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present Chris O'Neill <chris@purplejay.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.