fast-clean 0.4.0__py3-none-any.whl

fast_clean/repositories/__init__.py

@@ -0,0 +1,30 @@
+"""
+Пакет, содержащий репозитории.
+"""
+
+from .cache import CacheManager as CacheManager
+from .cache import CacheRepositoryProtocol as CacheRepositoryProtocol
+from .cache import InMemoryCacheRepository as InMemoryCacheRepository
+from .cache import RedisCacheRepository as RedisCacheRepository
+from .crud import CrudRepositoryOldProtocol as CrudRepositoryOldProtocol
+from .crud import CrudRepositoryProtocol as CrudRepositoryProtocol
+from .crud import DbCrudRepository as DbCrudRepository
+from .crud import DbCrudRepositoryOld as DbCrudRepositoryOld
+from .settings import EnvSettingsRepository as EnvSettingsRepository
+from .settings import SettingsRepositoryError as SettingsRepositoryError
+from .settings import SettingsRepositoryFactoryImpl as SettingsRepositoryFactoryImpl
+from .settings import SettingsRepositoryFactoryProtocol as SettingsRepositoryFactoryProtocol
+from .settings import SettingsRepositoryProtocol as SettingsRepositoryProtocol
+from .settings import SettingsSourceEnum as SettingsSourceEnum
+from .storage import LocalStorageParamsSchema as LocalStorageParamsSchema
+from .storage import LocalStorageRepository as LocalStorageRepository
+from .storage import S3StorageParamsSchema as S3StorageParamsSchema
+from .storage import S3StorageRepository as S3StorageRepository
+from .storage import StorageRepositoryFactoryImpl as StorageRepositoryFactoryImpl
+from .storage import (
+    StorageRepositoryFactoryProtocol as StorageRepositoryFactoryProtocol,
+)
+from .storage import StorageRepositoryProtocol as StorageRepositoryProtocol
+from .storage import StorageTypeEnum as StorageTypeEnum
+from .storage import StreamReaderProtocol as StreamReaderProtocol
+from .storage import StreamReadProtocol as StreamReadProtocol

fast_clean/repositories/cache/__init__.py

@@ -0,0 +1,83 @@
+"""
+Пакет, содержащий репозиторий кеша.
+
+Представлено две реализации:
+- InMemory
+- Redis
+"""
+
+from typing import ClassVar, Protocol, Self, Tuple, cast
+
+from fastapi_cache import FastAPICache
+
+from fast_clean.settings import CoreCacheSettingsSchema
+from redis import asyncio as aioredis
+
+from .in_memory import InMemoryCacheRepository as InMemoryCacheRepository
+from .redis import RedisCacheRepository as RedisCacheRepository
+
+
+class CacheRepositoryProtocol(Protocol):
+    """
+    Протокол репозитория кеша.
+    """
+
+    async def get(self: Self, key: str) -> str | None:
+        """
+        Получаем значение.
+        """
+        ...
+
+    async def set(self: Self, key: str, value: str, expire: int | None = None, nx: bool = False) -> None:
+        """
+        Устанавливаем значение.
+        """
+        ...
+
+    async def get_with_ttl(self: Self, key: str) -> Tuple[int, str | None]:
+        """
+        Получаем значение со сроком жизни.
+        """
+        ...
+
+    async def incr(self: Self, key: str, amount: int = 1) -> int:
+        """
+        Инкрементируем значения.
+        """
+        ...
+
+    async def decr(self: Self, key: str, amount: int = 1) -> int:
+        """
+        Декрементируем значения.
+        """
+        ...
+
+    async def clear(self: Self, namespace: str | None = None, key: str | None = None) -> int:
+        """
+        Удаляем значение.
+        """
+        ...
+
+
+class CacheManager:
+    """
+    Менеджер для реализации кеширования.
+    """
+
+    cache: ClassVar[CacheRepositoryProtocol | None] = None
+
+    @classmethod
+    def init(cls, cache_settings: CoreCacheSettingsSchema, redis: aioredis.Redis | None) -> None:
+        """
+        Инициализируем кеш.
+        """
+        if cls.cache is None:
+            cache_backend: InMemoryCacheRepository | RedisCacheRepository
+            match cache_settings.provider:
+                case 'in_memory':
+                    cache_backend = InMemoryCacheRepository()
+                case 'redis':
+                    assert redis is not None
+                    cache_backend = RedisCacheRepository(redis)
+            FastAPICache.init(cache_backend, prefix=cache_settings.prefix)
+            cls.cache = cast(CacheRepositoryProtocol, cache_backend)

fast_clean/repositories/cache/in_memory.py

@@ -0,0 +1,62 @@
+"""
+Модуль, содержащий репозиторий кеша в памяти.
+"""
+
+from typing import Self
+
+from fastapi_cache.backends.inmemory import InMemoryBackend, Value
+from overrides import override
+
+
+class InMemoryCacheRepository(InMemoryBackend):
+    """
+    Репозиторий кеша в памяти.
+    """
+
+    @override(check_signature=False)
+    def _get(self, key: str) -> Value | None:
+        """
+        Получаем внутреннее значение.
+
+        Родительский метод работает неправильно, т.к. не рассчитан на правильную логику метода `set`.
+        """
+        v = self._store.get(key)
+        if v:
+            if v.ttl_ts == -1 or v.ttl_ts >= self._now:
+                return v
+            else:
+                del self._store[key]
+        return None
+
+    @override(check_signature=False)
+    async def set(self: Self, key: str, value: str, expire: int | None = None, nx: bool = False) -> None:
+        """
+        Устанавливаем значение.
+
+        Родительский метод работает неправильно, т.к. при отсутствии `expire` должно устанавливаться `-1`.
+        Старая логика приводит к тому, что метод работает не так, как `RedisBackend`.
+        """
+        async with self._lock:
+            ttl_ts = self._now + expire if expire is not None else -1
+            existing_value = self._get(key)
+            if not nx or existing_value is None:
+                self._store[key] = Value(value, ttl_ts)  # type: ignore
+
+    async def incr(self: Self, key: str, amount: int = 1) -> int:
+        """
+        Инкремент значения.
+        """
+        v = self._get(key)
+        if v is None:
+            n_value = amount
+            await self.set(key, str(amount))
+            return n_value
+        n_value = int(v.data) + amount
+        await self.set(key, str(n_value))
+        return n_value
+
+    async def decr(self: Self, key: str, amount: int = 1) -> int:
+        """
+        Декремент значения.
+        """
+        return await self.incr(key, -amount)

fast_clean/repositories/cache/redis.py

@@ -0,0 +1,58 @@
+"""
+Модуль, содержащий репозиторий кеша с помощью Redis.
+"""
+
+from typing import Self
+
+from fastapi_cache.backends.redis import RedisBackend
+from overrides import override
+
+from redis.asyncio.client import Redis
+
+
+class RedisCacheRepository(RedisBackend):
+    """
+    Репозиторий кеша с помощью Redis.
+    """
+
+    def __init__(self, redis: Redis):
+        super().__init__(redis)
+        self.redis: Redis
+
+    @override(check_signature=False)
+    async def set(self: Self, key: str, value: str, expire: int | None = None, nx: bool = False) -> None:
+        """
+        Устанавливаем значение.
+        """
+        await self.redis.set(key, value, ex=expire, nx=nx)
+
+    async def incr(self: Self, key: str, amount: int = 1) -> int:
+        """
+        Инкремент значения.
+        """
+        return await self.redis.incr(key, amount)
+
+    async def decr(self: Self, key: str, amount: int = 1) -> int:
+        """
+        Декремент значения.
+        """
+        return await self.redis.decr(key, amount)
+
+    async def clear(self, namespace: str | None = None, key: str | None = None) -> int:
+        """
+        Удаляем значение.
+
+        Родительский метод работает не правильно и не подсчитывает количество удаленных записей.
+        https://github.com/long2ice/fastapi-cache/issues/241
+        """
+        if namespace:
+            cursor = 0
+            removed = 0
+            while True:
+                cursor, keys = await self.redis.scan(cursor, match=f'{namespace}:*', count=500)
+                removed += await self.redis.delete(*keys)
+                if cursor == 0:
+                    return removed
+        elif key:
+            return await self.redis.delete(key)
+        return 0

fast_clean/repositories/crud/__init__.py

@@ -0,0 +1,149 @@
+"""
+Пакет, содержащий репозиторий для выполнения CRUD операций над моделями.
+
+Представлено две реализации:
+- InMemory
+- Db
+"""
+
+import uuid
+from collections.abc import Iterable, Sequence
+from typing import Any, Protocol, Self
+
+from fast_clean.schemas import PaginationResultSchema, PaginationSchema
+
+from .db import DbCrudRepository as DbCrudRepository
+from .db import DbCrudRepositoryOld as DbCrudRepositoryOld
+from .in_memory import InMemoryCrudRepository as InMemoryCrudRepository
+from .in_memory import InMemoryCrudRepositoryOld as InMemoryCrudRepositoryOld
+from .type_vars import (
+    CreateSchemaBaseType,
+    CreateSchemaOldType,
+    CreateSchemaType,
+    IdTypeContravariant,
+    ReadSchemaBaseType,
+    UpdateSchemaBaseType,
+    UpdateSchemaOldType,
+    UpdateSchemaType,
+)
+
+
+class CrudRepositoryBaseProtocol(
+    Protocol[
+        ReadSchemaBaseType,
+        CreateSchemaBaseType,
+        UpdateSchemaBaseType,
+        IdTypeContravariant,
+    ]
+):
+    """
+    Протокол базового репозитория для выполнения CRUD операций над моделями.
+    """
+
+    async def get(self: Self, id: IdTypeContravariant) -> ReadSchemaBaseType:
+        """
+        Получаем модель по идентификатору.
+        """
+        ...
+
+    async def get_or_none(self: Self, id: IdTypeContravariant) -> ReadSchemaBaseType | None:
+        """
+        Получаем модель или None по идентификатору.
+        """
+        ...
+
+    async def get_by_ids(
+        self: Self, ids: Sequence[IdTypeContravariant], *, exact: bool = False
+    ) -> list[ReadSchemaBaseType]:
+        """
+        Получаем список моделей по идентификаторам.
+        """
+        ...
+
+    async def get_all(self: Self) -> list[ReadSchemaBaseType]:
+        """
+        Получаем все модели.
+        """
+        ...
+
+    async def paginate(
+        self: Self,
+        pagination: PaginationSchema,
+        user: Any,
+        policies: list[str],
+        *,
+        search: str | None = None,
+        search_by: Iterable[str] | None = None,
+        sorting: Iterable[str] | None = None,
+    ) -> PaginationResultSchema[ReadSchemaBaseType]:
+        """
+        Получаем список моделей с пагинацией, поиском и сортировкой.
+        """
+        ...
+
+    async def create(self: Self, create_object: CreateSchemaBaseType) -> ReadSchemaBaseType:
+        """
+        Создаем модель.
+        """
+        ...
+
+    async def bulk_create(self: Self, create_objects: list[CreateSchemaBaseType]) -> list[ReadSchemaBaseType]:
+        """
+        Создаем несколько моделей.
+        """
+        ...
+
+    async def update(self: Self, update_object: UpdateSchemaBaseType) -> ReadSchemaBaseType:
+        """
+        Обновляем модель.
+        """
+        ...
+
+    async def bulk_update(self: Self, update_objects: list[UpdateSchemaBaseType]) -> None:
+        """
+        Обновляем несколько моделей.
+        """
+        ...
+
+    async def upsert(self: Self, create_object: CreateSchemaBaseType) -> ReadSchemaBaseType:
+        """
+        Создаем или обновляем модель.
+        """
+        ...
+
+    async def delete(self: Self, ids: Sequence[IdTypeContravariant]) -> None:
+        """
+        Удаляем модели.
+        """
+        ...
+
+
+class CrudRepositoryOldProtocol(
+    CrudRepositoryBaseProtocol[
+        ReadSchemaBaseType,
+        CreateSchemaOldType,
+        UpdateSchemaOldType,
+        int,
+    ],
+    Protocol[
+        ReadSchemaBaseType,
+        CreateSchemaOldType,
+        UpdateSchemaOldType,
+    ],
+):
+    """
+    Протокол репозитория для выполнения CRUD операций над моделями старого типа.
+    """
+
+    ...
+
+
+class CrudRepositoryProtocol(
+    CrudRepositoryBaseProtocol[ReadSchemaBaseType, CreateSchemaType, UpdateSchemaType, uuid.UUID],
+    Protocol[ReadSchemaBaseType, CreateSchemaType, UpdateSchemaType],
+):
+    """
+    Протокол репозитория для выполнения CRUD операций над моделями нового типа.
+    """
+
+    ...