alpha-python 0.1.0__py3-none-any.whl

alpha/interfaces/openapi_model.py

@@ -0,0 +1,21 @@
+from typing import Any, ClassVar, Protocol, runtime_checkable
+
+
+@runtime_checkable
+class OpenAPIModel(Protocol):
+    """OpenAPIModel interface"""
+
+    openapi_types: ClassVar[dict[str, type]]
+    attribute_map: ClassVar[dict[str, str]]
+
+    def __init__(self) -> None: ...
+
+    def to_dict(self) -> dict[str, Any]: ...
+
+    def to_str(self): ...
+
+    def __repr__(self): ...
+
+    def __eq__(self, other): ...
+
+    def __ne__(self, other): ...

alpha/interfaces/patchable.py

@@ -0,0 +1,8 @@
+from typing import Protocol
+
+from alpha.domain.models.base_model import DomainModelCovariant
+from alpha.infra.models.json_patch import JsonPatch
+
+
+class Patchable(Protocol[DomainModelCovariant]):
+    def patch(self, patches: JsonPatch) -> DomainModelCovariant: ...

alpha/interfaces/sql_database.py

@@ -0,0 +1,36 @@
+from typing import Protocol, runtime_checkable, ClassVar
+
+import sqlalchemy as sa
+from sqlalchemy.engine import Engine
+from sqlalchemy.orm.session import Session
+
+from alpha.interfaces.sql_mapper import SqlMapper
+
+
+@runtime_checkable
+class SqlDatabase(Protocol):
+    _host: ClassVar[str]
+    _port: ClassVar[int]
+    _username: ClassVar[str]
+    _password: ClassVar[str]
+    _db_name: ClassVar[str]
+    _db_type: ClassVar[str]
+    _schema_name: ClassVar[str]
+    _mapper: ClassVar[SqlMapper | None]
+    _connection_string: ClassVar[str]
+    _engine: ClassVar[Engine]
+    _session_factory: ClassVar[Session]
+
+    def get_session(self) -> Session: ...
+
+    def engine(self) -> Engine: ...
+
+    def create_tables(
+        self, metadata: sa.MetaData, tables: list[sa.Table] | None = None
+    ) -> None: ...
+
+    def drop_tables(
+        self, metadata: sa.MetaData, tables: list[sa.Table] | None = None
+    ) -> None: ...
+
+    def _create_schema(self, engine: Engine, schema_name: str) -> None: ...

alpha/interfaces/sql_mapper.py

@@ -0,0 +1,23 @@
+"""_summary_
+"""
+from typing import Any, ClassVar, Protocol, runtime_checkable
+
+import sqlalchemy as sa
+from sqlalchemy.orm import registry
+
+
+@runtime_checkable
+class SqlMapper(Protocol):
+    """_summary_"""
+
+    convention: ClassVar[dict[str, Any]]
+    started: ClassVar[bool]
+    schema_name: ClassVar[str]
+
+    metadata: ClassVar[sa.MetaData]
+
+    mapper_registry: ClassVar[registry]
+
+    @classmethod
+    def start_mapping(cls) -> None:
+        """_summary_"""

alpha/interfaces/sql_repository.py

@@ -0,0 +1,380 @@
+"""_summary_"""
+
+from enum import Enum
+from typing import Any, Literal, Protocol, overload, runtime_checkable
+from uuid import UUID
+
+from sqlalchemy.orm import (
+    Query,
+    Session,
+)
+from sqlalchemy.orm.attributes import InstrumentedAttribute
+
+from alpha.domain.models.base_model import BaseDomainModel, DomainModel
+from alpha.infra.models.search_filter import SearchFilter
+from alpha.infra.models.query_clause import QueryClause
+from alpha.interfaces.patchable import Patchable
+from alpha.interfaces.updateable import Updateable
+
+
+@runtime_checkable
+class SqlRepository(Protocol[DomainModel]):
+    """_summary_
+
+    Parameters
+    ----------
+    Protocol : _type_
+        _description_
+    """
+
+    session: Session
+    _default_model: DomainModel
+
+    def __init__(self, session: Session, default_model: DomainModel) -> None:
+        """_summary_
+
+        Parameters
+        ----------
+        session : Session
+            _description_
+        default_model : DomainModel
+            _description_
+        """
+
+    @overload
+    def add(
+        self,
+        obj: DomainModel,
+        return_obj: Literal[True] = True,
+        raise_if_exists: bool = False,
+    ) -> DomainModel: ...
+
+    @overload
+    def add(
+        self,
+        obj: DomainModel,
+        return_obj: Literal[False],
+        raise_if_exists: bool = False,
+    ) -> None: ...
+
+    def add(
+        self,
+        obj: DomainModel,
+        return_obj: bool = True,
+        raise_if_exists: bool = False,
+    ) -> DomainModel | None:
+        """_summary_
+
+        Parameters
+        ----------
+        obj : DomainModel
+            _description_
+        raise_if_exists : bool, optional
+            _description_, by default False
+        """
+
+    def add_all(
+        self,
+        objs: list[DomainModel],
+        return_obj: bool = False,
+        raise_if_exists: bool = False,
+    ) -> list[DomainModel] | None:
+        """_summary_
+
+        Parameters
+        ----------
+        objs : list[DomainModel]
+            _description_
+        raise_if_exists : bool, optional
+            _description_, by default False
+        """
+
+    def count(
+        self,
+        model: DomainModel | None = None,
+        **kwargs: Any,
+    ) -> int:
+        """_summary_
+
+        Parameters
+        ----------
+        model : DomainModel | None, optional
+            _description_, by default None
+
+        Returns
+        -------
+        int
+            _description_
+        """
+        ...
+
+    def get(
+        self,
+        attr: str | InstrumentedAttribute[Any],
+        value: str | int | float | Enum | UUID | BaseDomainModel,
+        cursor_result: str = "first",
+        model: DomainModel | None = None,
+        **kwargs: Any,
+    ) -> DomainModel:
+        """_summary_
+
+        Parameters
+        ----------
+        attr : str | InstrumentedAttribute
+            _description_
+        value : str | int | float | Enum | UUID
+            _description_
+        cursor_result : str, optional
+            _description_, by default "first"
+        model : DomainModel | None, optional
+            _description_, by default None
+
+        Returns
+        -------
+        DomainModel
+            _description_
+        """
+        ...
+
+    def get_all(
+        self,
+        attr: str | InstrumentedAttribute[Any],
+        value: str | int | float | Enum | UUID | BaseDomainModel,
+        cursor_result: str = "all",
+        model: DomainModel | None = None,
+        **kwargs: Any,
+    ) -> list[DomainModel]:
+        """_summary_
+
+        Parameters
+        ----------
+        attr : str | InstrumentedAttribute
+            _description_
+        value : str | int | float | Enum | UUID
+            _description_
+        cursor_result : str, optional
+            _description_, by default "all"
+        model : DomainModel | None, optional
+            _description_, by default None
+
+        Returns
+        -------
+        list[DomainModel]
+            _description_
+        """
+        ...
+
+    def get_one(
+        self,
+        attr: str | InstrumentedAttribute[Any],
+        value: str | int | float | Enum | UUID,
+        cursor_result: str = "one",
+        model: DomainModel | None = None,
+        **kwargs: Any,
+    ) -> DomainModel:
+        """_summary_
+
+        Parameters
+        ----------
+        attr : str | InstrumentedAttribute
+            _description_
+        value : str | int | float | Enum | UUID
+            _description_
+        cursor_result : str, optional
+            _description_, by default "one"
+        model : DomainModel | None, optional
+            _description_, by default None
+
+        Returns
+        -------
+        DomainModel
+            _description_
+        """
+        ...
+
+    def get_one_or_none(
+        self,
+        attr: str | InstrumentedAttribute[Any],
+        value: str | int | float | Enum | UUID,
+        cursor_result: str = "one_or_none",
+        model: DomainModel | None = None,
+        **kwargs: Any,
+    ) -> DomainModel | None:
+        """_summary_
+
+        Parameters
+        ----------
+        attr : str | InstrumentedAttribute
+            _description_
+        value : str | int | float | Enum | UUID
+            _description_
+        cursor_result : str, optional
+            _description_, by default "one_or_none"
+        model : DomainModel | None, optional
+            _description_, by default None
+
+        Returns
+        -------
+        DomainModel | None
+            _description_
+        """
+        ...
+
+    def get_by_id(
+        self,
+        value: str | int | UUID,
+        attr: str | InstrumentedAttribute[Any] = "id",
+        cursor_result: str = "one_or_none",
+        model: DomainModel | None = None,
+        **kwargs: Any,
+    ) -> DomainModel | None:
+        """_summary_
+
+        Parameters
+        ----------
+        value : str | int | UUID
+            _description_
+        attr : str | InstrumentedAttribute, optional
+            _description_, by default "id"
+        cursor_result : str, optional
+            _description_, by default "one_or_none"
+        model : DomainModel | None, optional
+            _description_, by default None
+
+        Returns
+        -------
+        DomainModel | None
+            _description_
+        """
+        ...
+
+    def patch(self, obj: Patchable, patches: dict[str, Any]) -> DomainModel:
+        """_summary_
+
+        Parameters
+        ----------
+        obj : Patchable
+            _description_
+        patches : dict[str, Any]
+            _description_
+
+        Returns
+        -------
+        DomainModel
+            _description_
+        """
+
+    def remove(self, obj: DomainModel) -> None:
+        """_summary_
+
+        Parameters
+        ----------
+        obj : DomainModel
+            _description_
+        """
+
+    def remove_all(
+        self,
+        objs: list[DomainModel] | None,
+        **kwargs: Any,
+    ) -> None:
+        """_summary_
+
+        Parameters
+        ----------
+        objs : list[DomainModel] | None
+            _description_
+        """
+
+    def select(
+        self,
+        model: DomainModel | None = None,
+        cursor_result: str = "all",
+        **kwargs: Any,
+    ) -> list[DomainModel]:
+        """_summary_
+
+        Parameters
+        ----------
+        model : DomainModel | None, optional
+            _description_, by default None
+        cursor_result : str, optional
+            _description_, by default "all"
+
+        Returns
+        -------
+        list[DomainModel]
+            _description_
+        """
+        ...
+
+    def update(self, obj: Updateable, other: DomainModel) -> DomainModel:
+        """_summary_
+
+        Parameters
+        ----------
+        obj : DomainModel
+            _description_
+        other : DomainModel
+            _description_
+
+        Returns
+        -------
+        DomainModel
+            _description_
+        """
+        ...
+
+    def view(
+        self,
+        model: DomainModel,
+        cursor_result: str = "all",
+        **kwargs: Any,
+    ) -> list[DomainModel]:
+        """_summary_
+
+        Parameters
+        ----------
+        model : DomainModel
+            _description_
+        cursor_result : str, optional
+            _description_, by default "all"
+
+        Returns
+        -------
+        list[DomainModel]
+            _description_
+        """
+        ...
+
+    def _query(
+        self,
+        cursor_result: str | None = None,
+        model: DomainModel | None = None,
+        filters: list[SearchFilter] = [],
+        **kwargs: Any,
+    ) -> Any:
+        """_summary_
+
+        Parameters
+        ----------
+        cursor_result : str | None, optional
+            _description_, by default None
+        model : DomainModel | None, optional
+            _description_, by default None
+        filters : list[SearchFilter], optional
+            _description_, by default []
+
+        Returns
+        -------
+        Any
+            _description_
+        """
+        ...
+
+    def _query_clause(
+        self,
+        clause: QueryClause,
+        query: Query[Any],
+        model: DomainModel,
+    ) -> Query[Any]: ...

alpha/interfaces/token_factory.py

@@ -0,0 +1,56 @@
+from typing import Protocol
+
+
+class TokenFactory(Protocol):
+    """Token Factory interface for creating and validating authentication
+    tokens.
+    """
+
+    def create(self, user_id: str, payload: dict[str, str]) -> str:
+        """Create an authentication token for a user.
+
+        Parameters
+        ----------
+        user_id
+            The unique identifier for the user.
+        payload
+            A dictionary containing payload data, such as an object containing
+            user information.
+
+        Returns
+        -------
+            str
+                The generated authentication token as a string.
+        """
+        ...
+
+    def validate(self, token: str) -> bool:
+        """Validate an authentication token.
+
+        Parameters
+        ----------
+        token
+            The authentication token to be validated.
+
+        Returns
+        -------
+            bool
+                True if the token is valid, False otherwise.
+        """
+        ...
+
+    def get_payload(self, token: str) -> dict[str, str]:
+        """Retrieve the payload from an authentication token.
+
+        Parameters
+        ----------
+        token
+            The authentication token from which to extract the payload.
+
+        Returns
+        -------
+            dict[str, str]
+                A dictionary containing the payload data extracted from the
+                token.
+        """
+        ...

alpha/interfaces/unit_of_work.py

@@ -0,0 +1,53 @@
+"""_summary_
+"""
+
+from typing import (
+    Any,
+    Protocol,
+    TypeVar,
+    runtime_checkable,
+)
+
+from sqlalchemy.orm.session import Session
+
+UOW = TypeVar("UOW", bound="UnitOfWork")
+
+
+@runtime_checkable
+class UnitOfWork(Protocol):
+    """_summary_
+
+    Parameters
+    ----------
+    Protocol : _type_
+        _description_
+    """
+
+    def __enter__(self: UOW) -> UOW:
+        """_summary_"""
+        ...
+
+    def __exit__(self, *args: Any) -> None:
+        """_summary_"""
+
+    def commit(self) -> None:
+        """_summary_"""
+
+    def flush(self) -> None:
+        """_summary_"""
+
+    def rollback(self) -> None:
+        """_summary_"""
+
+    def refresh(self, obj: object) -> None:
+        """_summary_"""
+
+    @property
+    def session(self) -> Session:
+        """_summary_
+
+        Returns
+        -------
+        Session
+            _description_
+        """

alpha/interfaces/updateable.py

@@ -0,0 +1,7 @@
+from typing import Protocol
+
+from alpha.domain.models.base_model import DomainModel
+
+
+class Updateable(Protocol):
+    def update(self, obj: DomainModel) -> DomainModel: ...