apexdevkit 2.1.3__tar.gz → 2.2.1__tar.gz

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: apexdevkit
-Version: 2.1.3
+Version: 2.2.1
 Summary: Apex Development Tools for python.
 License-File: LICENSE
 Author: Apex Dev
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3.15
 Requires-Dist: fastapi
 Requires-Dist: pydantic
 Requires-Dist: pymssql (==2.*)
-Requires-Dist: pypebbles (==0.3.*)
+Requires-Dist: pypebbles (==0.4.*)
 Requires-Dist: python-dotenv
 Requires-Dist: sentry-sdk[fastapi]
 Requires-Dist: uvicorn

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/__init__.py

@@ -2,8 +2,8 @@ from dotenv import load_dotenv
 from fastapi import APIRouter, FastAPI, HTTPException
 
 __all__ = [
-    "FastAPI",
     "APIRouter",
+    "FastAPI",
     "HTTPException",
     "load_dotenv",
 ]

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/annotation/deprecate.py

@@ -25,7 +25,7 @@ def deprecated(warning: str) -> Callable[[F], F]:
         if inspect.isfunction(obj) or inspect.ismethod(obj):
             return _wrap_function(obj, warning)
         if inspect.isclass(obj):
-            return cast(F, _deprecate_class(obj, warning))
+            return cast("F", _deprecate_class(obj, warning))
         raise TypeError(
             f"Unsupported type for deprecation: {type(obj)}"
         )  # pragma: no cover
@@ -38,7 +38,7 @@ def _wrap_function[F: Callable[..., Any]](func: F, warning: str) -> F:
         warn(warning, category=DeprecationWarning, stacklevel=2)
         return func(*args, **kwargs)
 
-    return cast(F, wrapper)
+    return cast("F", wrapper)
 
 
 def _deprecate_class(cls: type, warning: str) -> type:
@@ -47,4 +47,4 @@ def _deprecate_class(cls: type, warning: str) -> type:
             warn(warning, category=DeprecationWarning, stacklevel=2)
             super().__init__(*args, **kwargs)
 
-    return cast(type, DeprecatedClass)
+    return cast("type", DeprecatedClass)

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/date.py

@@ -36,28 +36,28 @@ class DateTime:
     # Date in format of "yyyy-mm-dd"
     @classmethod
     def from_date(cls, date: str, time_zone: ZoneInfo | None = None) -> DateTime:
-        if time_zone is None:
-            time_zone = ZoneInfo("UTC")
-
-        dt = datetime.strptime(date, "%Y-%m-%d")
-        dt = dt.replace(tzinfo=time_zone)
-        timestamp_ms = int(dt.timestamp() * 1000)
-
-        return cls(timestamp_ms=timestamp_ms)
+        return cls(
+            timestamp_ms=int(
+                datetime.strptime(date, "%Y-%m-%d")
+                .replace(tzinfo=time_zone or ZoneInfo("UTC"))
+                .timestamp()
+                * 1000
+            )
+        )
 
     # Date in format of "yyyy-mm-ddTHH:MM:SS"
     @classmethod
     def from_date_time(
         cls, date_time: str, time_zone: ZoneInfo | None = None
     ) -> DateTime:
-        if time_zone is None:
-            time_zone = ZoneInfo("UTC")
-
-        dt = datetime.strptime(date_time, "%Y-%m-%dT%H:%M:%S")
-        dt = dt.replace(tzinfo=time_zone)
-        timestamp_ms = int(dt.timestamp() * 1000)
-
-        return cls(timestamp_ms=timestamp_ms)
+        return cls(
+            timestamp_ms=int(
+                datetime.strptime(date_time, "%Y-%m-%dT%H:%M:%S")
+                .replace(tzinfo=time_zone or ZoneInfo("UTC"))
+                .timestamp()
+                * 1000
+            )
+        )
 
     @classmethod
     def from_timestamp(cls, timestamp: float) -> DateTime:

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/fastapi/__init__.py

@@ -5,9 +5,9 @@ from apexdevkit.fastapi.service import RestfulRepository
 
 __all__ = [
     "FastApiBuilder",
-    "RestfulServiceBuilder",
-    "inject",
     "RestfulRepository",
     "RestfulRouter",
+    "RestfulServiceBuilder",
     "RouterWithHiddenUnderscoreRoutes",
+    "inject",
 ]

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/fastapi/builder.py

@@ -1,9 +1,8 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
-from collections.abc import Mapping, MutableSet
 from dataclasses import dataclass, field
-from typing import Any, Protocol, Self
+from typing import TYPE_CHECKING, Any, Protocol, Self
 
 from fastapi import APIRouter, FastAPI
 from fastapi.middleware.cors import CORSMiddleware
@@ -12,7 +11,11 @@ from fastapi.responses import JSONResponse
 from apexdevkit.annotation import deprecated
 from apexdevkit.error import ApiError
 from apexdevkit.fastapi.dependable import DependableBuilder
-from apexdevkit.fastapi.service import RestfulService
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping, MutableSet
+
+    from apexdevkit.fastapi.service import RestfulService
 
 
 @dataclass

apexdevkit-2.2.1/apexdevkit/fastapi/resource.py

@@ -0,0 +1,103 @@
+from collections.abc import Callable
+from dataclasses import dataclass
+from typing import Any
+
+from fastapi.responses import JSONResponse
+
+from apexdevkit.error import DoesNotExistError, ExistsError, ForbiddenError
+from apexdevkit.fastapi.response import RestfulResponse
+
+_Response = JSONResponse | dict[str, Any]
+_Endpoint = Callable[..., _Response]
+
+
+@dataclass(frozen=True)
+class RestfulResource:
+    response: RestfulResponse
+
+    def create_one_endpoint(self, Service, Item) -> _Endpoint:
+        def endpoint(service: Service, item: Item) -> _Response:
+            try:
+                result = service.create_one(item)
+            except ExistsError as e:
+                return JSONResponse(self.response.exists(e), 409)
+            except ForbiddenError as e:
+                return JSONResponse(self.response.forbidden(e), 403)
+
+            return self.response.created_one(result)
+
+        return endpoint
+
+    def read_one_endpoint(self, Service, ItemId) -> _Endpoint:
+        def endpoint(service: Service, item_id: ItemId) -> _Response:
+            try:
+                result = service.read_one(item_id)
+            except DoesNotExistError as e:
+                return JSONResponse(self.response.not_found(e), 404)
+            except ForbiddenError as e:
+                return JSONResponse(self.response.forbidden(e), 403)
+
+            return self.response.found_one(result)
+
+        return endpoint
+
+    def read_many_endpoint(self, Service, QueryParams) -> _Endpoint:
+        def endpoint(service: Service, params: QueryParams) -> _Response:
+            try:
+                result = list(service.read_many(**dict(params)))
+            except ForbiddenError as e:
+                return JSONResponse(self.response.forbidden(e), 403)
+
+            return self.response.found_many(result)
+
+        return endpoint
+
+    def read_all_endpoint(self, Service) -> _Endpoint:
+        def endpoint(service: Service) -> _Response:
+            try:
+                result = list(service.read_all())
+            except ForbiddenError as e:
+                return JSONResponse(self.response.forbidden(e), 403)
+
+            return self.response.found_many(result)
+
+        return endpoint
+
+    def update_one_endpoint(self, Service, ItemId, Updates) -> _Endpoint:
+        def endpoint(service: Service, item_id: ItemId, updates: Updates) -> _Response:
+            try:
+                service.update_one(item_id, **updates)
+            except DoesNotExistError as e:
+                return JSONResponse(self.response.not_found(e), 404)
+            except ForbiddenError as e:
+                return JSONResponse(self.response.forbidden(e), 403)
+
+            return self.response.ok()
+
+        return endpoint
+
+    def replace_one_endpoint(self, Service, Item) -> _Endpoint:
+        def endpoint(service: Service, item: Item) -> _Response:
+            try:
+                service.replace_one(item)
+            except DoesNotExistError as e:
+                return JSONResponse(self.response.not_found(e), 404)
+            except ForbiddenError as e:
+                return JSONResponse(self.response.forbidden(e), 403)
+
+            return self.response.ok()
+
+        return endpoint
+
+    def delete_one_endpoint(self, Service, ItemId) -> _Endpoint:
+        def endpoint(service: Service, item_id: ItemId) -> _Response:
+            try:
+                service.delete_one(item_id)
+            except DoesNotExistError as e:
+                return JSONResponse(self.response.not_found(e), 404)
+            except ForbiddenError as e:
+                return JSONResponse(self.response.forbidden(e), 403)
+
+            return self.response.ok()
+
+        return endpoint

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/fastapi/router.py

@@ -1,7 +1,7 @@
 from collections.abc import Callable
 from dataclasses import dataclass, field
 from enum import Enum
-from typing import Annotated, Any, Protocol, Self, TypeVar
+from typing import Annotated, Any, Protocol, Self
 
 from fastapi import APIRouter, Depends, Path, Query
 from fastapi.responses import JSONResponse
@@ -47,8 +47,6 @@ class RouterWithHiddenUnderscoreRoutes(APIRouter):
 
 _Response = JSONResponse | dict[str, Any]
 
-T = TypeVar("T")
-
 
 class Dependency(Protocol):  # pragma: no cover
     def as_dependable(self) -> type[RestfulService]:
@@ -123,11 +121,12 @@ class RestfulRouter:
     def with_create_one(
         self,
         dependency: Dependency | None = None,
+        *,
         is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             "",
-            self.resource.create_one(
+            self.resource.create_one_endpoint(
                 Service=self._resolve(dependency),
                 Item=Annotated[
                     RawItem,
@@ -147,11 +146,12 @@ class RestfulRouter:
     def with_read_one(
         self,
         dependency: Dependency | None = None,
+        *,
         is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             self.item_path,
-            self.resource.read_one(
+            self.resource.read_one_endpoint(
                 Service=self._resolve(dependency),
                 ItemId=Annotated[
                     str,
@@ -172,14 +172,18 @@ class RestfulRouter:
         self,
         query: FluentDict[Any],
         dependency: Dependency | None = None,
+        *,
         is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             "",
-            self.resource.read_many(
+            self.resource.read_many_endpoint(
                 Service=self._resolve(dependency),
                 QueryParams=Annotated[
-                    Schema(self.name.singular).optional_schema_for("ReadMany", query),
+                    Schema(self.name.singular).optional_schema_for(
+                        action="ReadMany",
+                        fields=query,
+                    ),
                     Query(),
                 ],
             ),
@@ -196,11 +200,14 @@ class RestfulRouter:
     def with_read_all(
         self,
         dependency: Dependency | None = None,
+        *,
         is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             "",
-            self.resource.read_all(Service=self._resolve(dependency)),
+            self.resource.read_all_endpoint(
+                Service=self._resolve(dependency),
+            ),
             methods=["GET"],
             status_code=200,
             responses={},
@@ -214,11 +221,12 @@ class RestfulRouter:
     def with_update_one(
         self,
         dependency: Dependency | None = None,
+        *,
         is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             self.item_path,
-            self.resource.update_one(
+            self.resource.update_one_endpoint(
                 Service=self._resolve(dependency),
                 ItemId=Annotated[
                     str,
@@ -242,11 +250,12 @@ class RestfulRouter:
     def with_replace_one(
         self,
         dependency: Dependency | None = None,
+        *,
         is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             "",
-            self.resource.replace_one(
+            self.resource.replace_one_endpoint(
                 Service=self._resolve(dependency),
                 Item=Annotated[
                     RawItem,
@@ -266,11 +275,12 @@ class RestfulRouter:
     def with_delete_one(
         self,
         dependency: Dependency | None = None,
+        *,
         is_documented: bool = True,
     ) -> Self:
         self.router.add_api_route(
             self.item_path,
-            self.resource.delete_one(
+            self.resource.delete_one_endpoint(
                 Service=self._resolve(dependency),
                 ItemId=Annotated[
                     str,

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/fastapi/schema.py

@@ -11,9 +11,6 @@ from apexdevkit.fastapi.name import RestfulName
 
 
 class SchemaFields(ABC):
-    def id(self) -> FluentDict[type]:
-        return self.readable().select("id")
-
     def writable(self) -> FluentDict[type]:
         return self.readable().drop("id")
 

apexdevkit-2.2.1/apexdevkit/fastapi/service.py

@@ -0,0 +1,68 @@
+from __future__ import annotations
+
+from collections.abc import Iterable, Mapping
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Any
+
+from apexdevkit.repository import Entity, Repository
+
+if TYPE_CHECKING:
+    from apexdevkit.formatter import Formatter
+
+RawItem = Mapping[str, Any]
+RawCollection = Iterable[RawItem]
+
+
+class RestfulService:  # pragma: no cover
+    def create_one(self, item: RawItem) -> RawItem:
+        raise NotImplementedError(self.create_one.__name__)
+
+    def read_one(self, item_id: str) -> RawItem:
+        raise NotImplementedError(self.read_one.__name__)
+
+    def read_many(self, **params: Any) -> RawCollection:
+        raise NotImplementedError(self.read_many.__name__)
+
+    def read_all(self) -> RawCollection:
+        raise NotImplementedError(self.read_all.__name__)
+
+    def update_one(self, item_id: str, **with_fields: Any) -> RawItem:
+        raise NotImplementedError(self.update_one.__name__)
+
+    def replace_one(self, item: RawItem) -> RawItem:
+        raise NotImplementedError(self.replace_one.__name__)
+
+    def delete_one(self, item_id: str) -> None:
+        raise NotImplementedError(self.delete_one.__name__)
+
+
+@dataclass(frozen=True)
+class RestfulRepository[ItemT: Entity](RestfulService):
+    repository: Repository[ItemT]
+
+    formatter: Formatter[Mapping[str, Any], ItemT]
+
+    def create_one(self, item: RawItem) -> RawItem:
+        return self.formatter.dump(self.repository.create(self.formatter.load(item)))
+
+    def read_one(self, item_id: str) -> RawItem:
+        return self.formatter.dump(self.repository.read(item_id))
+
+    def read_all(self) -> RawCollection:
+        return [self.formatter.dump(item) for item in self.repository]
+
+    def update_one(self, item_id: str, **with_fields: Any) -> RawItem:
+        data = dict(self.formatter.dump(self.repository.read(item_id)))
+        data.update(**with_fields)
+
+        self.repository.update(self.formatter.load(data))
+
+        return data
+
+    def replace_one(self, item: RawItem) -> RawItem:
+        self.repository.update(self.formatter.load(item))
+
+        return item
+
+    def delete_one(self, item_id: str) -> None:
+        self.repository.delete(item_id)

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/query/generator.py

@@ -1,9 +1,8 @@
 from __future__ import annotations
 
 from collections import defaultdict
-from collections.abc import Iterable, Mapping
 from dataclasses import dataclass, field
-from typing import Any, ClassVar, Protocol, TypeVar
+from typing import TYPE_CHECKING, Any, ClassVar, Protocol
 
 from apexdevkit.annotation import deprecated
 from apexdevkit.error import ForbiddenError
@@ -24,44 +23,45 @@ from apexdevkit.query.query import (
 )
 from apexdevkit.repository import Database, DatabaseCommand
 
-ItemT = TypeVar("ItemT", covariant=True)
+if TYPE_CHECKING:
+    from collections.abc import Iterable, Mapping
 
 
-class _Loader(Protocol[ItemT]):
-    def load(self, raw: Mapping[str, Any]) -> ItemT:
+class _Loader[T](Protocol):
+    def load(self, raw: Mapping[str, Any]) -> T:
         pass
 
 
 @dataclass
-class DefaultMsSqlFilter[ItemT]:
+class DefaultMsSqlFilter[T]:
     _database: Database = field(init=False)
     _query_builder: MsSqlQueryBuilder = field(init=False)
     _options: QueryOptions = field(init=False)
-    _formatter: _Loader[ItemT] = field(init=False)
+    _formatter: _Loader[T] = field(init=False)
 
-    def with_database(self, value: Database) -> DefaultMsSqlFilter[ItemT]:
+    def with_database(self, value: Database) -> DefaultMsSqlFilter[T]:
         self._database = value
 
         return self
 
-    def with_query_builder(self, value: MsSqlQueryBuilder) -> DefaultMsSqlFilter[ItemT]:
+    def with_query_builder(self, value: MsSqlQueryBuilder) -> DefaultMsSqlFilter[T]:
         self._query_builder = value
 
         return self
 
-    def with_options(self, value: QueryOptions) -> DefaultMsSqlFilter[ItemT]:
+    def with_options(self, value: QueryOptions) -> DefaultMsSqlFilter[T]:
         self._options = value
 
         return self
 
-    def with_formatter(self, value: _Loader[ItemT]) -> DefaultMsSqlFilter[ItemT]:
+    def with_formatter(self, value: _Loader[T]) -> DefaultMsSqlFilter[T]:
         self._formatter = value
 
         return self
 
-    def retrieve(self) -> Iterable[ItemT]:
+    def retrieve(self) -> Iterable[T]:
         if not any(sort.name == "id" for sort in self._options.ordering):
-            self._options.ordering.append(Sort("id", False))
+            self._options.ordering.append(Sort(name="id", is_descending=False))
 
         result = self._database.execute(
             self._query_builder.filter(self._options)
@@ -101,7 +101,7 @@ class DefaultMsSqlAggregate:
             for aggregation in self._options.aggregations
             for value in [
                 result[
-                    f"{aggregation.name if aggregation.name else 'general'}"
+                    f"{aggregation.name or 'general'}"
                     f"_{aggregation.aggregation.value.lower()}"
                 ]
             ]
@@ -215,7 +215,7 @@ class MsSqlField:
 
         return result
 
-    def as_order_part(self, is_descending: bool = False) -> str:
+    def as_order_part(self, *, is_descending: bool = False) -> str:
         result = self.name
 
         if is_descending:
@@ -278,7 +278,7 @@ class MsSqlOrderGenerator:
         return f"ORDER BY {clause}"
 
     def generate_one(self, item: Sort) -> str:
-        return self.field_for(item.name).as_order_part(item.is_descending)
+        return self.field_for(item.name).as_order_part(is_descending=item.is_descending)
 
     def field_for(self, name: str) -> MsSqlField:
         for f in self.fields:

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/repository/__init__.py

@@ -19,23 +19,20 @@ from .in_memory import (
 from .sql import MsSqlRepository, SqliteRepository
 
 __all__ = [
-    "Entity",
-    # Core
     "BruteForceBatch",
+    "CacheMixin",
     "Connection",
     "Connector",
     "Cursor",
     "Database",
     "DatabaseCommand",
-    "NoRepository",
-    "Repository",
-    "RepositoryDecorator",
-    # In-memory
-    "CacheMixin",
+    "Entity",
     "InMemoryByteStore",
     "InMemoryRepository",
     "KeyValueStore",
-    # SQL
     "MsSqlRepository",
+    "NoRepository",
+    "Repository",
+    "RepositoryDecorator",
     "SqliteRepository",
 ]

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/repository/core/__init__.py

@@ -11,22 +11,18 @@ from .interface import Entity, ItemT, KeyFn, Repository
 from .mixin import ContainsMixin
 
 __all__ = [
-    # Database
+    "BruteForceBatch",
     "Connection",
     "ConnectionContextManager",
     "Connector",
+    "ContainsMixin",
     "Cursor",
     "Database",
     "DatabaseCommand",
-    # Decorator
-    "RepositoryDecorator",
-    "BruteForceBatch",
-    # Interface
     "Entity",
     "ItemT",
     "KeyFn",
-    "Repository",
     "NoRepository",
-    # Mixin
-    "ContainsMixin",
+    "Repository",
+    "RepositoryDecorator",
 ]

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/repository/core/database.py

@@ -106,6 +106,6 @@ class ConnectionContextManager(AbstractContextManager[Connection]):
     def __enter__(self) -> Connection:
         return self.connection
 
-    def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None:
+    def __exit__(self, exc_type: object, exc_value: object, traceback: object) -> None:
         self.connection.cursor().close()
         self.connection.close()

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/repository/in_memory/__init__.py

@@ -4,7 +4,7 @@ from .store import InMemoryByteStore, KeyValueStore
 
 __all__ = [
     "CacheMixin",
-    "InMemoryRepository",
     "InMemoryByteStore",
+    "InMemoryRepository",
     "KeyValueStore",
 ]

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/repository/in_memory/repository.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
-from collections.abc import Iterator
 from contextlib import suppress
 from dataclasses import dataclass, field
+from typing import TYPE_CHECKING
 
 from apexdevkit.error import DoesNotExistError, ExistsError
 from apexdevkit.key_fn import AttributeKey
@@ -10,6 +10,9 @@ from apexdevkit.repository.core import ContainsMixin, ItemT, KeyFn, Repository
 
 from .store import InMemoryByteStore, KeyValueStore
 
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
 
 @dataclass(frozen=True)
 class InMemoryRepository(ContainsMixin, Repository[ItemT]):

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/repository/in_memory/store.py

@@ -1,11 +1,13 @@
 from __future__ import annotations
 
-from collections.abc import Iterable
 from dataclasses import dataclass, field
-from typing import Protocol
+from typing import TYPE_CHECKING, Protocol
 
 from apexdevkit.formatter import Formatter, PickleFormatter
 
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+
 
 class KeyValueStore[ItemT](Protocol):  # pragma: no cover
     def count(self) -> int:

{apexdevkit-2.1.3 → apexdevkit-2.2.1}/apexdevkit/repository/sql/__init__.py

@@ -3,9 +3,9 @@ from .mssql import MsSqlRepository
 from .sqlite import SqliteRepository
 
 __all__ = [
+    "MsSqlRepository",
     "NotNone",
     "SqlFieldBuilder",
     "SqlFieldManager",
-    "MsSqlRepository",
     "SqliteRepository",
 ]