python3-commons 0.6.20__tar.gz → 0.7.1__tar.gz

{python3_commons-0.6.20 → python3_commons-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: python3-commons
-Version: 0.6.20
+Version: 0.7.1
 Summary: Re-usable Python3 code
 Author-email: Oleg Korsak <kamikaze.is.waiting.you@gmail.com>
 License: gpl-3
@@ -14,12 +14,15 @@ License-File: LICENSE
 License-File: AUTHORS.rst
 Requires-Dist: aiohttp[speedups]~=3.11.13
 Requires-Dist: asyncpg~=0.30.0
+Requires-Dist: fastapi-users-db-sqlalchemy~=7.0.0
+Requires-Dist: fastapi-users[sqlalchemy]~=14.0.1
 Requires-Dist: lxml~=5.3.1
 Requires-Dist: minio~=7.2.15
 Requires-Dist: msgpack~=1.1.0
 Requires-Dist: msgspec~=0.19.0
 Requires-Dist: pydantic[email]~=2.10.6
 Requires-Dist: pydantic-settings~=2.8.1
+Requires-Dist: SQLAlchemy[asyncio]~=2.0.38
 Requires-Dist: zeep~=4.3.1
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"

{python3_commons-0.6.20 → python3_commons-0.7.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python3-commons"
-version = "0.6.20"
+version = "0.7.1"
 description = "Re-usable Python3 code"
 authors = [
     {name = "Oleg Korsak", email = "kamikaze.is.waiting.you@gmail.com"}
@@ -19,12 +19,15 @@ keywords = []
 dependencies = [
     "aiohttp[speedups]~=3.11.13",
     "asyncpg~=0.30.0",
+    "fastapi-users-db-sqlalchemy~=7.0.0",
+    "fastapi-users[sqlalchemy]~=14.0.1",
     "lxml~=5.3.1",
     "minio~=7.2.15",
     "msgpack~=1.1.0",
     "msgspec~=0.19.0",
     "pydantic[email]~=2.10.6",
     "pydantic-settings~=2.8.1",
+    "SQLAlchemy[asyncio]~=2.0.38",
     "zeep~=4.3.1"
     # Replace msgspec Git dependency for PyPI compatibility, consider releasing
     # a vendorized or fixed version to your environment

{python3_commons-0.6.20 → python3_commons-0.7.1}/requirements.txt

@@ -1,9 +1,12 @@
 aiohttp[speedups]~=3.11.13
 asyncpg~=0.30.0
+fastapi-users-db-sqlalchemy~=7.0.0
+fastapi-users[sqlalchemy]~=14.0.1
 lxml~=5.3.1
 minio~=7.2.15
 msgpack~=1.1.0
 msgspec~=0.19.0
 pydantic[email]~=2.10.6
 pydantic-settings~=2.8.1
+SQLAlchemy[asyncio]~=2.0.38
 zeep~=4.3.1

{python3_commons-0.6.20 → python3_commons-0.7.1}/src/python3_commons/conf.py

@@ -1,4 +1,4 @@
-from pydantic import SecretStr
+from pydantic import SecretStr, PostgresDsn
 from pydantic_settings import BaseSettings
 
 
@@ -8,6 +8,10 @@ class CommonSettings(BaseSettings):
     logging_formatter: str = 'default'
 
 
+class DBSettings(BaseSettings):
+    db_dsn: PostgresDsn | None = None
+
+
 class S3Settings(BaseSettings):
     s3_endpoint_url: str | None = None
     s3_region_name: str | None = None
@@ -20,4 +24,5 @@ class S3Settings(BaseSettings):
 
 
 settings = CommonSettings()
+db_settings = DBSettings()
 s3_settings = S3Settings()

python3_commons-0.7.1/src/python3_commons/db/__init__.py

@@ -0,0 +1,60 @@
+import asyncio
+import contextlib
+import logging
+from typing import AsyncGenerator
+
+from asyncpg import CannotConnectNowError
+from pydantic import PostgresDsn
+from sqlalchemy import MetaData
+from sqlalchemy.ext.asyncio import create_async_engine, AsyncSession
+from sqlalchemy.ext.asyncio.session import async_sessionmaker
+from sqlalchemy.orm import declarative_base
+
+from python3_commons.conf import db_settings
+
+logger = logging.getLogger(__name__)
+
+metadata = MetaData()
+Base = declarative_base(metadata=metadata)
+engine = create_async_engine(
+    str(db_settings.db_dsn),
+    # echo=True,
+    pool_size=20,
+    max_overflow=0,
+    pool_timeout=30,
+    pool_recycle=1800,  # 30 minutes
+)
+async_session_maker = async_sessionmaker(engine, expire_on_commit=False)
+
+
+async def get_async_session() -> AsyncGenerator[AsyncSession, None]:
+    async with async_session_maker() as session:
+        yield session
+
+
+get_async_session_context = contextlib.asynccontextmanager(get_async_session)
+
+
+async def is_healthy(pg) -> bool:
+    return await pg.fetchval('SELECT 1 FROM alembic_version;') == 1
+
+
+async def connect_to_db(database, dsn: PostgresDsn):
+    logger.info('Waiting for services')
+    logger.debug(f'DB_DSN: {dsn}')
+    timeout = 0.001
+    total_timeout = 0
+
+    for i in range(15):
+        try:
+            await database.connect()
+        except (ConnectionRefusedError, CannotConnectNowError):
+            timeout *= 2
+            await asyncio.sleep(timeout)
+            total_timeout += timeout
+        else:
+            break
+    else:
+        msg = f'Unable to connect database for {int(total_timeout)}s'
+        logger.error(msg)
+        raise ConnectionRefusedError(msg)

python3_commons-0.7.1/src/python3_commons/db/helpers.py

@@ -0,0 +1,61 @@
+import logging
+from typing import Mapping
+
+import sqlalchemy as sa
+from sqlalchemy import desc, asc, func
+from sqlalchemy.sql.elements import BooleanClauseList, UnaryExpression
+
+logger = logging.getLogger(__name__)
+
+
+def get_query(search: Mapping[str, str] | None = None,
+              order_by: str | None = None,
+              columns: Mapping | None = None) -> tuple[BooleanClauseList, UnaryExpression]:
+    """
+        :columns:
+            Param name ->
+            0: Model column
+            1: case-insensitive if True
+            2: cast value to type
+            3: exact match if True, LIKE %value% if False
+    """
+
+    if order_by:
+        if order_by.startswith('-'):
+            direction = desc
+            order_by = order_by[1:]
+        else:
+            direction = asc
+
+        order_by_clause = direction(columns[order_by][0])
+    else:
+        order_by_clause = None
+
+    if search:
+        where_parts = [
+            *(
+                (func.upper(columns[k][0])
+                 if columns[k][1]
+                 else columns[k][0]
+                 ) == columns[k][2](v)
+                for k, v in search.items()
+                if columns[k][3]
+            ),
+            *(
+                (func.upper(columns[k][0])
+                 if columns[k][1]
+                 else columns[k][0]
+                 ).like(f'%{v.upper()}%')
+                for k, v in search.items()
+                if not columns[k][3]
+            )
+        ]
+    else:
+        where_parts = None
+
+    if where_parts:
+        where_clause = sa.and_(*where_parts)
+    else:
+        where_clause = None
+
+    return where_clause, order_by_clause

python3_commons-0.7.1/src/python3_commons/db/models/__init__.py

@@ -0,0 +1,4 @@
+from python3_commons.db.models.auth import ApiKey, User, UserGroup
+from python3_commons.db.models.rbac import (
+    RBACRole, RBACPermission, RBACRolePermission, RBACUserRole, RBACApiKeyRole
+)

python3_commons-0.7.1/src/python3_commons/db/models/auth.py

@@ -0,0 +1,43 @@
+import uuid
+
+from fastapi_users_db_sqlalchemy import GUID, SQLAlchemyBaseUserTableUUID
+from pydantic import AwareDatetime
+from sqlalchemy import (
+    String, BIGINT, ForeignKey, DateTime
+)
+from sqlalchemy.orm import Mapped, mapped_column
+
+from python3_commons.db import Base
+from python3_commons.db.models.common import BaseDBModel, BaseDBUUIDModel
+
+
+class UserGroup(BaseDBModel, Base):
+    __tablename__ = 'user_groups'
+
+    name: Mapped[str] = mapped_column(String, nullable=False)
+
+
+class User(SQLAlchemyBaseUserTableUUID, Base):
+    __tablename__ = 'users'
+
+    username: Mapped[str] = mapped_column(String, unique=True, index=True, nullable=False)
+    group_id: Mapped[int | None] = mapped_column(BIGINT, ForeignKey('user_groups.id'))
+    role_id: Mapped[uuid.UUID | None] = mapped_column(
+        GUID,
+        ForeignKey('permissions.id', name='fk_api_key_permission_api_key', ondelete='RESTRICT'),
+        nullable=False,
+        index=True,
+    )
+
+
+class ApiKey(BaseDBUUIDModel, Base):
+    __tablename__ = 'api_keys'
+
+    user_id: Mapped[uuid.UUID | None] = mapped_column(
+        GUID,
+        ForeignKey('users.id', name='fk_api_key_user', ondelete='RESTRICT'),
+        index=True,
+    )
+    partner_name: Mapped[str] = mapped_column(String, unique=True)
+    key: Mapped[str] = mapped_column(String, unique=True)
+    expires_at: Mapped[AwareDatetime] = mapped_column(DateTime(timezone=True))

python3_commons-0.7.1/src/python3_commons/db/models/common.py

@@ -0,0 +1,37 @@
+from pydantic import AwareDatetime
+from sqlalchemy import (
+    DateTime, BIGINT
+)
+from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.ext.compiler import compiles
+from sqlalchemy.orm import Mapped, mapped_column
+from sqlalchemy.sql import expression
+from sqlalchemy.sql.ddl import CreateColumn
+
+
+class UTCNow(expression.FunctionElement):
+    type = DateTime(timezone=True)
+
+
+@compiles(UTCNow, 'postgresql')
+def pg_utcnow(element, compiler, **kw):
+    return "TIMEZONE('utc', CURRENT_TIMESTAMP)"
+
+
+@compiles(CreateColumn, 'postgresql')
+def use_identity(element, compiler, **kw):
+    result = compiler.visit_create_column(element, **kw).replace('SERIAL', 'INT GENERATED BY DEFAULT AS IDENTITY')
+
+    return result.replace('BIGSERIAL', 'BIGINT GENERATED BY DEFAULT AS IDENTITY')
+
+
+class BaseDBModel:
+    id: Mapped[int] = mapped_column(BIGINT, primary_key=True)
+    created_at: Mapped[AwareDatetime] = mapped_column(DateTime(timezone=True), nullable=False, server_default=UTCNow())
+    updated_at: Mapped[AwareDatetime] = mapped_column(DateTime(timezone=True), onupdate=UTCNow())
+
+
+class BaseDBUUIDModel:
+    uid: Mapped[UUID] = mapped_column(UUID, primary_key=True)
+    created_at: Mapped[AwareDatetime] = mapped_column(DateTime(timezone=True), nullable=False, server_default=UTCNow())
+    updated_at: Mapped[AwareDatetime | None] = mapped_column(DateTime(timezone=True), onupdate=UTCNow())

python3_commons-0.7.1/src/python3_commons/db/models/rbac.py

@@ -0,0 +1,101 @@
+import uuid
+
+from fastapi_users_db_sqlalchemy import GUID
+from pydantic import AwareDatetime
+from sqlalchemy import (
+    String, DateTime, ForeignKey, PrimaryKeyConstraint, CheckConstraint
+)
+from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.orm import Mapped, mapped_column
+
+from python3_commons.db import Base
+
+
+class RBACRole(Base):
+    __tablename__ = 'rbac_roles'
+
+    uid: Mapped[uuid.UUID] = mapped_column(UUID, primary_key=True)
+    name: Mapped[str] = mapped_column(String, unique=True, nullable=False)
+
+
+class RBACPermission(Base):
+    __tablename__ = 'rbac_permissions'
+
+    uid: Mapped[uuid.UUID] = mapped_column(UUID, primary_key=True)
+    name: Mapped[str] = mapped_column(String, unique=True, nullable=False)
+
+    __table_args__ = (
+        CheckConstraint("name ~ '^[a-z0-9_.]+$'", name='check_rbac_permissions_name'),
+    )
+
+
+class RBACRolePermission(Base):
+    __tablename__ = 'rbac_role_permissions'
+
+    role_uid: Mapped[uuid.UUID | None] = mapped_column(
+        UUID,
+        ForeignKey('rbac_roles.uid', name='fk_rbac_role_permissions_role', ondelete='CASCADE'),
+        index=True,
+    )
+    permission_uid: Mapped[uuid.UUID | None] = mapped_column(
+        UUID,
+        ForeignKey('rbac_permissions.uid', name='fk_rbac_role_permissions_permission', ondelete='CASCADE'),
+        index=True,
+    )
+
+    __table_args__ = (
+        PrimaryKeyConstraint('role_uid', 'permission_uid', name='pk_rbac_role_permissions'),
+    )
+
+
+class RBACUserRole(Base):
+    __tablename__ = 'rbac_user_roles'
+
+    user_id: Mapped[uuid.UUID | None] = mapped_column(
+        GUID,
+        ForeignKey('users.id', name='fk_rbac_user_roles_user', ondelete='CASCADE'),
+        index=True,
+    )
+    role_uid: Mapped[uuid.UUID | None] = mapped_column(
+        UUID,
+        ForeignKey('rbac_roles.uid', name='fk_rbac_user_roles_role', ondelete='CASCADE'),
+        index=True,
+    )
+    starts_at: Mapped[AwareDatetime] = mapped_column(DateTime(timezone=True), nullable=False)
+    expires_at: Mapped[AwareDatetime | None] = mapped_column(DateTime(timezone=True))
+
+    __table_args__ = (
+        PrimaryKeyConstraint('user_id', 'role_uid', name='pk_rbac_user_roles'),
+    )
+
+
+class RBACApiKeyRole(Base):
+    __tablename__ = 'rbac_api_key_roles'
+
+    api_key_uid: Mapped[uuid.UUID | None] = mapped_column(
+        UUID,
+        ForeignKey('api_keys.uid', name='fk_rbac_api_key_roles_user', ondelete='CASCADE'),
+        index=True,
+    )
+    role_uid: Mapped[uuid.UUID | None] = mapped_column(
+        UUID,
+        ForeignKey('rbac_roles.uid', name='fk_rbac_api_key_roles_role', ondelete='CASCADE'),
+        index=True,
+    )
+    starts_at: Mapped[AwareDatetime] = mapped_column(DateTime(timezone=True), nullable=False)
+    expires_at: Mapped[AwareDatetime | None] = mapped_column(DateTime(timezone=True))
+
+    __table_args__ = (
+        PrimaryKeyConstraint('api_key_uid', 'role_uid', name='pk_rbac_api_key_roles'),
+    )
+
+
+# class RBACRoleRelation(Base):
+#     __tablename__ = 'rbac_role_relations'
+#
+#     parent_uid: Mapped[uuid.UUID] = mapped_column(UUID)
+#     child_uid: Mapped[uuid.UUID] = mapped_column(UUID)
+#
+#     __table_args__ = (
+#         PrimaryKeyConstraint('parent_uid', 'child_uid', name='pk_rbac_role_relations'),
+#     )

python3_commons-0.7.1/src/python3_commons/permissions.py

@@ -0,0 +1,29 @@
+import logging
+from uuid import UUID
+
+import sqlalchemy as sa
+from sqlalchemy import func, exists, and_
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from python3_commons.db.models import RBACPermission, RBACApiKeyRole, RBACRolePermission
+
+logger = logging.getLogger(__name__)
+
+
+async def has_api_key_permission(session: AsyncSession, api_key_uid: UUID, permission: str) -> bool:
+    query = sa.select(
+        exists().where(
+            and_(
+                RBACApiKeyRole.api_key_uid == api_key_uid,
+                (RBACApiKeyRole.expires_at.is_(None) | (RBACApiKeyRole.expires_at > func.now())),
+                RBACApiKeyRole.role_uid == RBACRolePermission.role_uid,
+                RBACRolePermission.permission_uid == RBACPermission.uid,
+                RBACPermission.name == permission
+            )
+        )
+    )
+
+    cursor = await session.execute(query)
+    result = cursor.scalar()
+
+    return result

{python3_commons-0.6.20 → python3_commons-0.7.1}/src/python3_commons.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: python3-commons
-Version: 0.6.20
+Version: 0.7.1
 Summary: Re-usable Python3 code
 Author-email: Oleg Korsak <kamikaze.is.waiting.you@gmail.com>
 License: gpl-3
@@ -14,12 +14,15 @@ License-File: LICENSE
 License-File: AUTHORS.rst
 Requires-Dist: aiohttp[speedups]~=3.11.13
 Requires-Dist: asyncpg~=0.30.0
+Requires-Dist: fastapi-users-db-sqlalchemy~=7.0.0
+Requires-Dist: fastapi-users[sqlalchemy]~=14.0.1
 Requires-Dist: lxml~=5.3.1
 Requires-Dist: minio~=7.2.15
 Requires-Dist: msgpack~=1.1.0
 Requires-Dist: msgspec~=0.19.0
 Requires-Dist: pydantic[email]~=2.10.6
 Requires-Dist: pydantic-settings~=2.8.1
+Requires-Dist: SQLAlchemy[asyncio]~=2.0.38
 Requires-Dist: zeep~=4.3.1
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"

{python3_commons-0.6.20 → python3_commons-0.7.1}/src/python3_commons.egg-info/SOURCES.txt

@@ -22,15 +22,21 @@ src/python3_commons/__init__.py
 src/python3_commons/api_client.py
 src/python3_commons/audit.py
 src/python3_commons/conf.py
-src/python3_commons/db.py
 src/python3_commons/fs.py
 src/python3_commons/helpers.py
 src/python3_commons/object_storage.py
+src/python3_commons/permissions.py
 src/python3_commons.egg-info/PKG-INFO
 src/python3_commons.egg-info/SOURCES.txt
 src/python3_commons.egg-info/dependency_links.txt
 src/python3_commons.egg-info/requires.txt
 src/python3_commons.egg-info/top_level.txt
+src/python3_commons/db/__init__.py
+src/python3_commons/db/helpers.py
+src/python3_commons/db/models/__init__.py
+src/python3_commons/db/models/auth.py
+src/python3_commons/db/models/common.py
+src/python3_commons/db/models/rbac.py
 src/python3_commons/logging/__init__.py
 src/python3_commons/logging/filters.py
 src/python3_commons/logging/formatters.py

{python3_commons-0.6.20 → python3_commons-0.7.1}/src/python3_commons.egg-info/requires.txt

@@ -1,11 +1,14 @@
 aiohttp[speedups]~=3.11.13
 asyncpg~=0.30.0
+fastapi-users-db-sqlalchemy~=7.0.0
+fastapi-users[sqlalchemy]~=14.0.1
 lxml~=5.3.1
 minio~=7.2.15
 msgpack~=1.1.0
 msgspec~=0.19.0
 pydantic[email]~=2.10.6
 pydantic-settings~=2.8.1
+SQLAlchemy[asyncio]~=2.0.38
 zeep~=4.3.1
 
 [testing]

python3_commons-0.6.20/src/python3_commons/db.py

@@ -1,28 +0,0 @@
-import asyncio
-import logging
-
-from asyncpg import CannotConnectNowError
-from pydantic import PostgresDsn
-
-logger = logging.getLogger(__name__)
-
-
-async def connect_to_db(database, dsn: PostgresDsn):
-    logger.info('Waiting for services')
-    logger.debug(f'DB_DSN: {dsn}')
-    timeout = 0.001
-    total_timeout = 0
-
-    for i in range(15):
-        try:
-            await database.connect()
-        except (ConnectionRefusedError, CannotConnectNowError):
-            timeout *= 2
-            await asyncio.sleep(timeout)
-            total_timeout += timeout
-        else:
-            break
-    else:
-        msg = f'Unable to connect database for {int(total_timeout)}s'
-        logger.error(msg)
-        raise ConnectionRefusedError(msg)