perfact-api-base 0.6__py2.py3-none-any.whl

perfact/api/base/__init__.py

@@ -0,0 +1,17 @@
+from .authinfo import AuthInfo
+from .model import Base, PydanticBase, View
+from .visibility import (
+    VisibilityAwareModel,
+    VisibilityPolicy,
+    VisibilityPolicyRegistry,
+)
+
+__all__ = [
+    "AuthInfo",
+    "Base",
+    "PydanticBase",
+    "View",
+    "VisibilityAwareModel",
+    "VisibilityPolicy",
+    "VisibilityPolicyRegistry",
+]

perfact/api/base/authinfo.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class AuthInfo:
+    name: Optional[str]
+    roles: list[str]
+    appstc: Optional[int]
+
+    @staticmethod
+    def get_unauthorized_authinfo() -> AuthInfo:
+        """
+        Returns a predefined AuthInfo for unauthorized requests.
+        """
+        return AuthInfo(None, [], None)

perfact/api/base/model.py

@@ -0,0 +1,65 @@
+from datetime import datetime
+
+from pydantic import BaseModel, ConfigDict
+from sqlalchemy import BigInteger, DateTime, ForeignKey, String, func
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
+
+# Re-export for easier use
+ForeignKey = ForeignKey
+relationship = relationship
+
+
+class Base(DeclarativeBase):
+    """
+    Base class for table mappings. Allows declaring fields without their table prefix,
+    the subclass hook will automatically rewrite them.
+    """
+
+    type_annotation_map = {str: String(), int: BigInteger()}
+
+    id: Mapped[int] = mapped_column(primary_key=True)
+    modtime: Mapped[datetime] = mapped_column(
+        DateTime(timezone=True), server_default=func.now()
+    )
+    author: Mapped[str | None] = mapped_column(server_default=func.db_username())
+
+    def __init_subclass__(cls, **kw):
+        """
+        Automatically add __tablename__ and prefix mapped columns with table name
+        """
+        # 1. Ensure tablename exists before mapping
+        if "__tablename__" not in cls.__dict__:
+            cls.__tablename__ = cls.__name__.lower()
+
+        # 2. Let SQLAlchemy build the mapper, table, columns, etc.
+        super().__init_subclass__(**kw)
+
+        # 3. Now we have cls.__table__ and real Column objects. Adjust these so they
+        # map to the prefixed column names on the database
+        if hasattr(cls, "__table__"):
+            prefix = cls.__tablename__ + "_"
+
+            for col in cls.__table__.columns:
+                # Only touch columns that still use their key as name
+                # (i.e., no explicit name was given)
+                if col.name == col.key:
+                    new_name = prefix + col.key
+                    col.name = new_name
+                    col.key = new_name  # keep ORM key in sync
+
+
+class View(DeclarativeBase):
+    """
+    Separate base for view definitions, so they are not created as tables but
+    can be used like tables
+    """
+
+    type_annotation_map = {str: String(), int: BigInteger()}
+
+
+class PydanticBase(BaseModel):
+    model_config = ConfigDict(from_attributes=True)
+
+    id: int
+    author: str | None
+    modtime: datetime

perfact/api/base/visibility.py

@@ -0,0 +1,37 @@
+from abc import ABC, abstractmethod
+from typing import ClassVar
+
+from sqlalchemy.sql.elements import ColumnElement
+
+from .authinfo import AuthInfo
+
+
+class VisibilityAwareModel:
+    """Marker mixin; signals that a model has an associated VisibilityPolicy."""
+
+
+class VisibilityPolicy(ABC):
+    """Row-level visibility rule; subclasses must set model and implement filter()."""
+
+    model: ClassVar[type]
+
+    @abstractmethod
+    def filter(self, auth: AuthInfo) -> ColumnElement[bool]: ...
+
+
+class VisibilityPolicyRegistry:
+    """Model-to-policy map; register() skips if already set, override() always wins."""
+
+    def __init__(self) -> None:
+        self._policies: dict[type, VisibilityPolicy] = {}
+
+    def register(self, model: type, policy_cls: type[VisibilityPolicy]) -> None:
+        if model not in self._policies:
+            self._policies[model] = policy_cls()
+
+    def override(self, model: type, policy_cls: type[VisibilityPolicy]) -> None:
+        self._policies[model] = policy_cls()
+
+    def get(self, model: type) -> VisibilityPolicy:
+        """Raises KeyError if no policy is registered for model."""
+        return self._policies[model]

perfact_api_base-0.6.dist-info/METADATA

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: perfact-api-base
+Version: 0.6
+Summary: PerFact API - base package for common infrastructure
+Author-email: Viktor Dick <viktor.dick@perfact.de>
+License: GPL-2.0-or-later
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: SQL
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: psycopg[binary]
+Requires-Dist: sqlalchemy
+Requires-Dist: pydantic-settings
+
+# perfact-api-base
+
+Base package for PerFact API common infrastructure. Part of the `perfact.api.base` namespace.
+
+## What it provides
+
+### `Base`
+
+Declarative base for all ORM table mappings. Subclasses automatically get:
+
+- `id` — `BigInteger` primary key
+- `modtime` — `DateTime` with timezone, defaults to `now()`
+- `author` — set from the DB session user via `db_username()`
+- Column names are automatically prefixed with the table name (e.g. a field `name` on `AppUser` becomes the DB column `appuser_name`)
+- `__tablename__` is derived from the class name in lowercase if not set explicitly
+
+### `View`
+
+Separate declarative base for SQL view definitions. Views are not created as tables during schema generation. Columns must be declared with explicit names matching the view definition.
+
+### Re-exports
+
+`ForeignKey`, `relationship`, `Mapped`, `mapped_column` are re-exported so model packages only need to import from this module.
+
+## Usage
+
+```python
+from perfact.api.base.model import Base, ForeignKey, Mapped, mapped_column, relationship
+
+class MyEntity(Base):
+    name: Mapped[str]
+    parent_id: Mapped[int | None] = mapped_column(ForeignKey("myentity.myentity_id"))
+```
+
+## Dependencies
+
+- `sqlalchemy`
+- `psycopg[c]`
+- `pydantic-settings`
+
+## Maintainers
+
+- Viktor Dick <viktor.dick@perfact.de>
+- Alexander Rolfes <alexander.rolfes@perfact.de>

perfact_api_base-0.6.dist-info/RECORD

@@ -0,0 +1,9 @@
+perfact/api/base/__init__.py,sha256=ALT8E3u0sHO1hXPuSxH56FsQL5jdaJYlb7Gl3KPVPE0,340
+perfact/api/base/authinfo.py,sha256=w9vXRZg1JUsE_g4CP4STsk3Gsin12dqSMv_A0nLMgTU,395
+perfact/api/base/model.py,sha256=jQnQyF6nwf2DP67gV1LiruM8jgN4996DQ_BQ0aLcWNs,2157
+perfact/api/base/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+perfact/api/base/visibility.py,sha256=QQirZqxWzEjMxMLDcY9pggOtMD7FMUs3I8CEogxT-GU,1158
+perfact_api_base-0.6.dist-info/METADATA,sha256=bPm8uA3Q1ANZqACM_PE4_iXxcraBw2WG1VMyjLdKp2c,1854
+perfact_api_base-0.6.dist-info/WHEEL,sha256=TdQ5LtNwLuxTCjgxN51AgdU5w-KkB9ttmLbzjTH02pg,109
+perfact_api_base-0.6.dist-info/top_level.txt,sha256=1odO3B1JiDF2Lqgnop8k7K4Xs1y_LdwehM53l1NDOnc,8
+perfact_api_base-0.6.dist-info/RECORD,,

perfact_api_base-0.6.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any
+

perfact_api_base-0.6.dist-info/top_level.txt

@@ -0,0 +1 @@
+perfact