fastapi-mongo-base 0.12.2__tar.gz → 0.12.4__tar.gz

fastapi_mongo_base-0.12.4/MANIFEST.in

@@ -0,0 +1 @@
+include pytest.ini

{fastapi_mongo_base-0.12.2/src/fastapi_mongo_base.egg-info → fastapi_mongo_base-0.12.4}/PKG-INFO

@@ -1,29 +1,10 @@
 Metadata-Version: 2.4
 Name: fastapi-mongo-base
-Version: 0.12.2
+Version: 0.12.4
 Summary: A simple boilerplate application, including models and schemas and abstract router, for FastAPI with MongoDB
 Author-email: Mahdi Kiani <mahdikiany@gmail.com>
 Maintainer-email: Mahdi Kiani <mahdikiany@gmail.com>
-License: Copyright (c) 2016 The Python Packaging Authority (PyPA)
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy of
-        this software and associated documentation files (the "Software"), to deal in
-        the Software without restriction, including without limitation the rights to
-        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-        of the Software, and to permit persons to whom the Software is furnished to do
-        so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/mahdikiani/fastapi-mongo-base-app
 Project-URL: Bug Reports, https://github.com/mahdikiani/fastapi-mongo-base-app/issues
 Project-URL: Funding, https://github.com/mahdikiani/fastapi-mongo-base-app
@@ -33,7 +14,6 @@ Keywords: fastapi,mongodb,beanie
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Build Tools
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -53,6 +33,8 @@ Requires-Dist: uvicorn[standard]>=0.13.0
 Provides-Extra: image
 Requires-Dist: Pillow>=9.0.0; extra == "image"
 Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: mongomock_motor; extra == "test"
 Requires-Dist: coverage; extra == "test"
 Dynamic: license-file
 

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/pyproject.toml

@@ -4,23 +4,19 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fastapi-mongo-base"
-version = "0.12.2"
+version = "0.12.4"
 description = "A simple boilerplate application, including models and schemas and abstract router, for FastAPI with MongoDB"
 readme = "README.md"
 requires-python = ">=3.9"
-license = {file = "LICENSE.txt"}
+license = "MIT"
+license-files = ["LICENSE.txt"]
 keywords = ["fastapi", "mongodb", "beanie"]
-authors = [
-  {name = "Mahdi Kiani", email = "mahdikiany@gmail.com"}
-]
-maintainers = [
-  {name = "Mahdi Kiani", email = "mahdikiany@gmail.com"}
-]
+authors = [{ name = "Mahdi Kiani", email = "mahdikiany@gmail.com" }]
+maintainers = [{ name = "Mahdi Kiani", email = "mahdikiany@gmail.com" }]
 classifiers = [
   "Development Status :: 3 - Alpha",
   "Intended Audience :: Developers",
   "Topic :: Software Development :: Build Tools",
-  "License :: OSI Approved :: MIT License",
   "Programming Language :: Python :: 3",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
@@ -35,9 +31,18 @@ dependencies = [
   "uuid6",
   "pytz",
   "fastapi>=0.65.0",
-  "uvicorn[standard]>=0.13.0"
+  "uvicorn[standard]>=0.13.0",
+]
+
+[project.optional-dependencies]
+image = [
+  "Pillow>=9.0.0",
+]
+test = [
+  "pytest",
+  "mongomock_motor",
+  "coverage",
 ]
-optional-dependencies = {"image" = ["Pillow>=9.0.0"],"test" = ["coverage"]}
 
 [project.urls]
 "Homepage" = "https://github.com/mahdikiani/fastapi-mongo-base-app"
@@ -47,4 +52,17 @@ optional-dependencies = {"image" = ["Pillow>=9.0.0"],"test" = ["coverage"]}
 "Source" = "https://github.com/mahdikiani/fastapi-mongo-base-app"
 
 [tool.setuptools]
-package-data = {"usso" = ["*.dat"]}
+package-data = { "usso" = ["*.dat"] }
+
+[tool.ruff]
+line-length = 79
+target-version = "py313"
+fix = true
+unsafe-fixes = true
+preview = true
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B"]
+
+[tool.ruff.format]
+quote-style = "double"

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base/core/app_factory.py

@@ -18,9 +18,15 @@ async def health(request: fastapi.Request):
 
 @asynccontextmanager
 async def lifespan(
-    *, app: fastapi.FastAPI, worker=None, init_functions=[], settings: Settings = None
+    *,
+    app: fastapi.FastAPI,
+    worker=None,
+    init_functions=None,
+    settings: Settings = None,
 ):
     """Initialize application services."""
+    if init_functions is None:
+        init_functions = []
     await db.init_mongo_db()
 
     if worker:
@@ -39,7 +45,9 @@ async def lifespan(
     logging.info("Shutdown complete")
 
 
-def setup_exception_handlers(*, app: fastapi.FastAPI, handlers: dict = None, **kwargs):
+def setup_exception_handlers(
+    *, app: fastapi.FastAPI, handlers: dict = None, **kwargs
+):
     exception_handlers = exceptions.EXCEPTION_HANDLERS
     if handlers:
         exception_handlers.update(handlers)
@@ -69,14 +77,18 @@ def get_app_kwargs(
     version="0.1.0",
     lifespan_func=None,
     worker=None,
-    init_functions: list = [],
+    init_functions: list = None,
     contact=None,
-    license_info={
-        "name": "MIT License",
-        "url": "https://github.com/mahdikiani/FastAPILaunchpad/blob/main/LICENSE",
-    },
+    license_info=None,
     **kwargs,
 ):
+    if license_info is None:
+        license_info = {
+            "name": "MIT License",
+            "url": "https://github.com/mahdikiani/FastAPILaunchpad/blob/main/LICENSE",
+        }
+    if init_functions is None:
+        init_functions = []
     settings.config_logger()
 
     """Create a FastAPI app with shared configurations."""
@@ -92,9 +104,14 @@ def get_app_kwargs(
     base_path: str = settings.base_path
 
     if lifespan_func is None:
-        lifespan_func = lambda app: lifespan(
-            app=app, worker=worker, init_functions=init_functions, settings=settings
-        )
+
+        def lifespan_func(app):
+            return lifespan(
+                app=app,
+                worker=worker,
+                init_functions=init_functions,
+                settings=settings,
+            )
 
     docs_url = f"{base_path}/docs"
     openapi_url = f"{base_path}/openapi.json"
@@ -122,18 +139,22 @@ def create_app(
     origins: list = None,
     lifespan_func=None,
     worker=None,
-    init_functions: list = [],
+    init_functions: list = None,
     contact=None,
-    license_info={
-        "name": "MIT License",
-        "url": "https://github.com/mahdikiani/FastAPILaunchpad/blob/main/LICENSE",
-    },
+    license_info=None,
     exception_handlers: dict = None,
     log_route: bool = False,
     health_route: bool = True,
     index_route: bool = True,
     **kwargs,
 ) -> fastapi.FastAPI:
+    if license_info is None:
+        license_info = {
+            "name": "MIT License",
+            "url": "https://github.com/mahdikiani/FastAPILaunchpad/blob/main/LICENSE",
+        }
+    if init_functions is None:
+        init_functions = []
     data = get_app_kwargs(
         settings=settings,
         title=title,
@@ -197,7 +218,7 @@ def configure_app(
     if log_route:
         app.get(f"{base_path}/logs", include_in_schema=False)(logs)
     if index_route:
-        app.get(f"/", include_in_schema=False)(index)
+        app.get("/", include_in_schema=False)(index)
 
     if serve_coverage:
         app.mount(

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base/core/config.py

@@ -36,7 +36,7 @@ class Settings(metaclass=Singleton):
         log_config = {
             "formatters": {
                 "standard": {
-                    "format": "[{levelname} : {filename}:{lineno} : {asctime} -> {funcName:10}] {message}",
+                    "format": "[{levelname} : {filename}:{lineno} : {asctime} -> {funcName:10}] {message}",  # noqa: E501
                     "style": "{",
                 }
             },

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base/core/db.py

@@ -34,10 +34,10 @@ def init_redis():
         from redis import Redis as RedisSync
         from redis.asyncio.client import Redis
 
-        if getattr(Settings, "redis_uri"):
+        if Settings.redis_uri:
             redis_sync: RedisSync = RedisSync.from_url(Settings.redis_uri)
             redis: Redis = Redis.from_url(Settings.redis_uri)
-    except ImportError or AttributeError or Exception as e:
+    except (ImportError, AttributeError, Exception) as e:
         logging.error(f"Error initializing Redis: {e}")
         redis_sync = None
         redis = None

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base/core/enums.py

@@ -1,7 +1,7 @@
-from enum import Enum
+from enum import StrEnum
 
 
-class Language(str, Enum):
+class Language(StrEnum):
     English = "English"
     Persian = "Persian"
     Arabic = "Arabic"

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base/core/exceptions.py

@@ -36,7 +36,9 @@ class BaseHTTPException(HTTPException):
         super().__init__(status_code, detail=detail)
 
 
-async def base_http_exception_handler(request: Request, exc: BaseHTTPException):
+async def base_http_exception_handler(
+    request: Request, exc: BaseHTTPException
+):
     return JSONResponse(
         status_code=exc.status_code,
         content={"message": exc.message, "error": exc.error},
@@ -58,7 +60,8 @@ async def request_validation_exception_handler(
     request: Request, exc: RequestValidationError
 ):
     logging.error(
-        f"request_validation_exception: {request.url} {exc}\n{(await request.body())[:100]}"
+        f"request_validation_exception: {request.url} {exc}\n"
+        f"{(await request.body())[:100]}"
     )
     from fastapi.exception_handlers import (
         request_validation_exception_handler as default_handler,

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base/models.py

@@ -1,6 +1,14 @@
 from datetime import datetime
 
-from beanie import Document, Insert, Replace, Save, SaveChanges, Update, before_event
+from beanie import (
+    Document,
+    Insert,
+    Replace,
+    Save,
+    SaveChanges,
+    Update,
+    before_event,
+)
 from beanie.odm.queries.find import FindMany
 from pydantic import ConfigDict
 from pymongo import ASCENDING, IndexModel
@@ -29,8 +37,11 @@ class BaseEntity(BaseEntitySchema, Document):
 
         @classmethod
         def is_abstract(cls):
-            # Use `__dict__` to check if `__abstract__` is defined in the class itself
-            return "__abstract__" in cls.__dict__ and cls.__dict__["__abstract__"]
+            # Use `__dict__` to check if `__abstract__` is defined
+            # in the class itself
+            return (
+                "__abstract__" in cls.__dict__ and cls.__dict__["__abstract__"]
+            )
 
     @before_event([Insert, Replace, Save, SaveChanges, Update])
     async def pre_save(self):
@@ -39,13 +50,13 @@ class BaseEntity(BaseEntitySchema, Document):
     @classmethod
     def get_queryset(
         cls,
+        *,
         user_id: str | None = None,
         tenant_id: str | None = None,
         is_deleted: bool = False,
         uid: str | None = None,
-        *args,
         **kwargs,
-    ) -> list[dict]:
+    ) -> dict:
         """Build a MongoDB query filter based on provided parameters.
 
         Args:
@@ -53,25 +64,26 @@ class BaseEntity(BaseEntitySchema, Document):
             tenant_id: Filter by tenant ID if the model has tenant_id field
             is_deleted: Filter by deletion status
             uid: Filter by unique identifier
-            **kwargs: Additional filters that can include range queries with _from/_to suffixes
+            **kwargs: Additional filters that can include range queries
+                      with _from/_to suffixes
 
         Returns:
             List of MongoDB query conditions
         """
         # Start with basic filters
-        base_query = []
+        base_query = {}
 
         # Add standard filters if applicable
-        base_query.append({"is_deleted": is_deleted})
-
-        if hasattr(cls, "user_id") and user_id:
-            base_query.append({"user_id": user_id})
+        base_query.update({"is_deleted": is_deleted})
 
         if hasattr(cls, "tenant_id"):
-            base_query.append({"tenant_id": tenant_id})
+            base_query.update({"tenant_id": tenant_id})
+
+        if hasattr(cls, "user_id") and user_id:
+            base_query.update({"user_id": user_id})
 
         if uid:
-            base_query.append({"uid": uid})
+            base_query.update({"uid": uid})
 
         # Process additional filters from kwargs
         for key, value in kwargs.items():
@@ -82,9 +94,15 @@ class BaseEntity(BaseEntitySchema, Document):
             base_field = basic.get_base_field_name(key)
 
             # Validate field is allowed for searching
-            if cls.search_field_set() and base_field not in cls.search_field_set():
+            if (
+                cls.search_field_set()
+                and base_field not in cls.search_field_set()
+            ):
                 continue
-            if cls.search_exclude_set() and base_field in cls.search_exclude_set():
+            if (
+                cls.search_exclude_set()
+                and base_field in cls.search_exclude_set()
+            ):
                 continue
             if not hasattr(cls, base_field):
                 continue
@@ -92,29 +110,27 @@ class BaseEntity(BaseEntitySchema, Document):
             # Handle range queries and array operators
             if key.endswith("_from") or key.endswith("_to"):
                 if basic.is_valid_range_value(value):
-                    if key.endswith("_from"):
-                        base_query.append({base_field: {"$gte": value}})
-                    elif key.endswith("_to"):
-                        base_query.append({base_field: {"$lte": value}})
+                    op = "$gte" if key.endswith("_from") else "$lte"
+                    base_query.setdefault(base_field, {}).update({op: value})
             elif key.endswith("_in") or key.endswith("_nin"):
                 value_list = basic.parse_array_parameter(value)
                 operator = "$in" if key.endswith("_in") else "$nin"
-                base_query.append({base_field: {operator: value_list}})
+                base_query.update({base_field: {operator: value_list}})
             else:
-                base_query.append({key: value})
+                base_query.update({key: value})
 
         return base_query
 
     @classmethod
     def get_query(
         cls,
+        *,
         user_id: str | None = None,
         tenant_id: str | None = None,
         is_deleted: bool = False,
         uid: str | None = None,
         created_at_from: datetime = None,
         created_at_to: datetime = None,
-        *args,
         **kwargs,
     ) -> FindMany:
         base_query = cls.get_queryset(
@@ -124,7 +140,6 @@ class BaseEntity(BaseEntitySchema, Document):
             uid=uid,
             created_at_from=created_at_from,
             created_at_to=created_at_to,
-            *args,
             **kwargs,
         )
         query = cls.find({"$and": base_query})
@@ -145,7 +160,7 @@ class BaseEntity(BaseEntitySchema, Document):
             tenant_id=tenant_id,
             is_deleted=is_deleted,
             uid=uid,
-            *args,
+            *args,  # noqa: B026
             **kwargs,
         )
         items = await query.to_list()
@@ -185,7 +200,6 @@ class BaseEntity(BaseEntitySchema, Document):
             user_id=user_id,
             tenant_id=tenant_id,
             is_deleted=is_deleted,
-            *args,
             **kwargs,
         )
 
@@ -206,7 +220,7 @@ class BaseEntity(BaseEntitySchema, Document):
             user_id=user_id,
             tenant_id=tenant_id,
             is_deleted=is_deleted,
-            *args,
+            *args,  # noqa: B026
             **kwargs,
         )
         return await query.count()
@@ -285,55 +299,86 @@ class BaseEntity(BaseEntitySchema, Document):
 
 
 class UserOwnedEntity(UserOwnedEntitySchema, BaseEntity):
-
     class Settings(BaseEntity.Settings):
         __abstract__ = True
 
-        indexes = BaseEntity.Settings.indexes + [IndexModel([("user_id", ASCENDING)])]
+        indexes = BaseEntity.Settings.indexes + [
+            IndexModel([("user_id", ASCENDING), ("uid", ASCENDING)]),
+        ]
 
     @classmethod
-    async def get_item(cls, uid, user_id, *args, **kwargs) -> "UserOwnedEntity":
-        if user_id == None and kwargs.get("ignore_user_id") != True:
+    async def get_item(
+        cls,
+        uid,
+        user_id,
+        *args,
+        **kwargs,
+    ) -> "UserOwnedEntity":
+        if user_id is None and not kwargs.get("ignore_user_id"):
             raise ValueError("user_id is required")
-        return await super().get_item(uid, user_id=user_id, *args, **kwargs)
+        return await super().get_item(
+            uid,
+            user_id=user_id,
+            *args,  # noqa: B026
+            **kwargs,
+        )
 
 
 class TenantScopedEntity(TenantScopedEntitySchema, BaseEntity):
-
     class Settings(BaseEntity.Settings):
         __abstract__ = True
 
-        indexes = BaseEntity.Settings.indexes + [IndexModel([("tenant_id", ASCENDING)])]
+        indexes = BaseEntity.Settings.indexes + [
+            IndexModel([("tenant_id", ASCENDING), ("uid", ASCENDING)]),
+        ]
 
     @classmethod
-    async def get_item(cls, uid, tenant_id, *args, **kwargs) -> "TenantScopedEntity":
-        if tenant_id == None:
+    async def get_item(
+        cls,
+        uid,
+        tenant_id,
+        *args,
+        **kwargs,
+    ) -> "TenantScopedEntity":
+        if tenant_id is None:
             raise ValueError("tenant_id is required")
-        return await super().get_item(uid, tenant_id=tenant_id, *args, **kwargs)
+        return await super().get_item(
+            uid,
+            tenant_id=tenant_id,
+            *args,  # noqa: B026
+            **kwargs,
+        )
 
     async def get_tenant(self):
         raise NotImplementedError
 
 
 class TenantUserEntity(TenantUserEntitySchema, BaseEntity):
-
     class Settings(TenantScopedEntity.Settings):
         __abstract__ = True
 
-        indexes = TenantScopedEntity.Settings.indexes + [
-            IndexModel([("user_id", ASCENDING)])
+        indexes = UserOwnedEntity.Settings.indexes + [
+            IndexModel([
+                ("tenant_id", ASCENDING),
+                ("user_id", ASCENDING),
+                ("uid", ASCENDING),
+            ]),
         ]
 
     @classmethod
     async def get_item(
         cls, uid, tenant_id, user_id, *args, **kwargs
     ) -> "TenantUserEntity":
-        if tenant_id == None:
+        if tenant_id is None:
             raise ValueError("tenant_id is required")
         # if user_id == None:
         #     raise ValueError("user_id is required")
         return await super().get_item(
-            uid, tenant_id=tenant_id, user_id=user_id, *args, **kwargs
+            uid,
+            tenant_id=tenant_id,
+            user_id=user_id,
+            *args,  # noqa: B026
+            **kwargs,
         )
 
 

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base/routes.py

@@ -1,6 +1,6 @@
 import asyncio
 from datetime import datetime
-from typing import Any, Type, TypeVar
+from typing import Any, TypeVar
 
 import singleton
 from fastapi import APIRouter, BackgroundTasks, Query, Request
@@ -21,15 +21,14 @@ TS = TypeVar("TS", bound=BaseEntitySchema)
 
 
 class AbstractBaseRouter(metaclass=singleton.Singleton):
-
     def __init__(
         self,
-        model: Type[T],
+        model: type[T],
         *args,
         user_dependency=None,
         prefix: str = None,
         tags: list[str] = None,
-        schema: Type[TS] = None,
+        schema: type[TS] = None,
         **kwargs,
     ):
         self.model = model
@@ -52,13 +51,25 @@ class AbstractBaseRouter(metaclass=singleton.Singleton):
         self.list_response_schema = kwargs.get(
             "list_response_schema", PaginatedResponse[self.list_item_schema]
         )
-        self.retrieve_response_schema = kwargs.get("retrieve_response_schema", schema)
-        self.create_response_schema = kwargs.get("create_response_schema", schema)
-        self.update_response_schema = kwargs.get("update_response_schema", schema)
-        self.delete_response_schema = kwargs.get("delete_response_schema", schema)
+        self.retrieve_response_schema = kwargs.get(
+            "retrieve_response_schema", schema
+        )
+        self.create_response_schema = kwargs.get(
+            "create_response_schema", schema
+        )
+        self.update_response_schema = kwargs.get(
+            "update_response_schema", schema
+        )
+        self.delete_response_schema = kwargs.get(
+            "delete_response_schema", schema
+        )
 
-        self.create_request_schema = kwargs.get("create_request_schema", schema)
-        self.update_request_schema = kwargs.get("update_request_schema", schema)
+        self.create_request_schema = kwargs.get(
+            "create_request_schema", schema
+        )
+        self.update_request_schema = kwargs.get(
+            "update_request_schema", schema
+        )
 
     def config_routes(self, **kwargs):
         prefix: str = kwargs.get("prefix", "")
@@ -174,7 +185,9 @@ class AbstractBaseRouter(metaclass=singleton.Singleton):
             limit=limit,
             **kwargs,
         )
-        items_in_schema = [self.list_item_schema(**item.model_dump()) for item in items]
+        items_in_schema = [
+            self.list_item_schema(**item.model_dump()) for item in items
+        ]
 
         return PaginatedResponse(
             items=items_in_schema,
@@ -244,7 +257,7 @@ class AbstractBaseRouter(metaclass=singleton.Singleton):
 class AbstractTaskRouter(AbstractBaseRouter):
     def __init__(
         self,
-        model: Type[T],
+        model: type[T],
         user_dependency: Any,
         schema: TS,
         draftable: bool = True,
@@ -252,7 +265,13 @@ class AbstractTaskRouter(AbstractBaseRouter):
         **kwargs,
     ):
         self.draftable = draftable
-        super().__init__(model, user_dependency, schema=schema, *args, **kwargs)
+        super().__init__(
+            model,
+            user_dependency,
+            schema=schema,
+            *args,  # noqa: B026
+            **kwargs,
+        )
 
     def config_routes(self, **kwargs):
         super().config_routes(**kwargs)

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base/schemas.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Generic, TypeVar
+from typing import TypeVar
 
 import uuid6
 from pydantic import BaseModel, Field
@@ -71,10 +71,6 @@ class BaseEntitySchema(BaseModel):
 class UserOwnedEntitySchema(BaseEntitySchema):
     user_id: str
 
-    @classmethod
-    def create_exclude_set(cls) -> list[str]:
-        return super().create_exclude_set() + ["user_id"]
-
     @classmethod
     def update_exclude_set(cls) -> list[str]:
         return super().update_exclude_set() + ["user_id"]
@@ -83,30 +79,23 @@ class UserOwnedEntitySchema(BaseEntitySchema):
 class TenantScopedEntitySchema(BaseEntitySchema):
     tenant_id: str
 
-    @classmethod
-    def create_exclude_set(cls) -> list[str]:
-        return super().create_exclude_set() + ["tenant_id"]
-
     @classmethod
     def update_exclude_set(cls) -> list[str]:
         return super().update_exclude_set() + ["tenant_id"]
 
 
 class TenantUserEntitySchema(TenantScopedEntitySchema, UserOwnedEntitySchema):
-
-    @classmethod
-    def create_exclude_set(cls) -> list[str]:
-        return list(set(super().create_exclude_set() + ["tenant_id", "user_id"]))
-
     @classmethod
     def update_exclude_set(cls) -> list[str]:
-        return list(set(super().update_exclude_set() + ["tenant_id", "user_id"]))
+        return list(
+            set(super().update_exclude_set() + ["tenant_id", "user_id"])
+        )
 
 
 T = TypeVar("T", bound=BaseEntitySchema)
 
 
-class PaginatedResponse(BaseModel, Generic[T]):
+class PaginatedResponse[T: BaseEntitySchema](BaseModel):
     items: list[T]
     total: int
     offset: int

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base/sql.py

@@ -68,10 +68,13 @@ class BaseEntity:
         return (datetime.now(timezone.tz) - self.updated_at).days > days
 
     def dump(
-        self, include_fields: list[str] = None, exclude_fields: list[str] = None
+        self,
+        include_fields: list[str] = None,
+        exclude_fields: list[str] = None,
     ) -> dict:
         """
-        Dump the object into a dictionary. It includes all the fields of the object.
+        Dump the object into a dictionary.
+        It includes all the fields of the object.
         """
         result = {}
         for key, value in (include_fields or self.__dict__).items():
@@ -112,7 +115,8 @@ class BaseEntity:
             tenant_id: Filter by tenant ID if the model has tenant_id field
             is_deleted: Filter by deletion status
             uid: Filter by unique identifier
-            **kwargs: Additional filters that can include range queries with _from/_to suffixes
+            **kwargs: Additional filters that can include range queries
+                      with _from/_to suffixes
 
         Returns:
             List of SQLAlchemy query conditions
@@ -141,9 +145,15 @@ class BaseEntity:
             base_field = basic.get_base_field_name(key)
 
             # Validate field is allowed for searching
-            if cls.search_field_set() and base_field not in cls.search_field_set():
+            if (
+                cls.search_field_set()
+                and base_field not in cls.search_field_set()
+            ):
                 continue
-            if cls.search_exclude_set() and base_field in cls.search_exclude_set():
+            if (
+                cls.search_exclude_set()
+                and base_field in cls.search_exclude_set()
+            ):
                 continue
             if not hasattr(cls, base_field):
                 continue
@@ -177,7 +187,6 @@ class BaseEntity:
         uid: str | None = None,
         created_at_from: datetime | None = None,
         created_at_to: datetime | None = None,
-        *args,
         **kwargs,
     ):
         base_query = cls.get_queryset(
@@ -187,7 +196,6 @@ class BaseEntity:
             uid=uid,
             created_at_from=created_at_from,
             created_at_to=created_at_to,
-            *args,
             **kwargs,
         )
         return base_query
@@ -225,7 +233,6 @@ class BaseEntity:
         limit: int = 10,
         **kwargs,
     ):
-
         base_query = cls.get_query(
             user_id=user_id,
             tenant_id=tenant_id,
@@ -254,7 +261,6 @@ class BaseEntity:
         is_deleted: bool = False,
         **kwargs,
     ):
-
         base_query = cls.get_query(
             user_id=user_id,
             tenant_id=tenant_id,
@@ -263,7 +269,9 @@ class BaseEntity:
         )
 
         # Query for getting the total count of items
-        total_count_query = select(func.count()).filter(*base_query)  # .subquery()
+        total_count_query = select(func.count()).filter(
+            *base_query
+        )  # .subquery()
 
         async with async_session() as session:
             total_result = await session.execute(total_count_query)
@@ -299,7 +307,6 @@ class BaseEntity:
 
     @classmethod
     async def get_by_uid(cls, uid: str):
-
         async with async_session() as session:
             query = select(cls).filter(cls.uid == uid)
             result = await session.execute(query)
@@ -308,7 +315,6 @@ class BaseEntity:
 
     @classmethod
     async def create_item(cls, data: dict):
-
         item = cls(**data)
         async with async_session() as session:
             session.add(item)
@@ -318,7 +324,6 @@ class BaseEntity:
 
     @classmethod
     async def update_item(cls, item: "BaseEntity", data: dict):
-
         for key, value in data.items():
             if cls.update_field_set() and key not in cls.update_field_set():
                 continue
@@ -335,7 +340,6 @@ class BaseEntity:
 
     @classmethod
     async def delete_item(cls, item: "BaseEntity"):
-
         item.is_deleted = True
         async with async_session() as session:
             session.add(item)
@@ -377,11 +381,15 @@ class TenantUserEntity(TenantScopedEntity, UserOwnedEntity):
 
     @classmethod
     def create_exclude_set(cls) -> list[str]:
-        return list(set(super().create_exclude_set() + ["tenant_id", "user_id"]))
+        return list(
+            set(super().create_exclude_set() + ["tenant_id", "user_id"])
+        )
 
     @classmethod
     def update_exclude_set(cls) -> list[str]:
-        return list(set(super().update_exclude_set() + ["tenant_id", "user_id"]))
+        return list(
+            set(super().update_exclude_set() + ["tenant_id", "user_id"])
+        )
 
 
 class ImmutableMixin(BaseEntity):

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base/tasks.py

@@ -1,8 +1,9 @@
 import asyncio
 import logging
+from collections.abc import Callable, Coroutine
 from datetime import datetime
-from enum import Enum
-from typing import Any, Callable, Coroutine, Literal, Union
+from enum import StrEnum
+from typing import Any, Literal, Union
 
 import json_advanced as json
 from pydantic import BaseModel, Field, field_serializer, field_validator
@@ -13,7 +14,7 @@ from .schemas import BaseEntitySchema
 from .utils import basic
 
 
-class TaskStatusEnum(str, Enum):
+class TaskStatusEnum(StrEnum):
     none = "null"
     draft = "draft"
     init = "init"
@@ -36,12 +37,16 @@ class SignalRegistry(metaclass=Singleton):
     def __init__(self):
         self.signal_map: dict[
             str,
-            list[Callable[..., None] | Callable[..., Coroutine[Any, Any, None]]],
+            list[
+                Callable[..., None] | Callable[..., Coroutine[Any, Any, None]]
+            ],
         ] = {}
 
 
 class TaskLogRecord(BaseModel):
-    reported_at: datetime = Field(default_factory=lambda: datetime.now(timezone.tz))
+    reported_at: datetime = Field(
+        default_factory=lambda: datetime.now(timezone.tz)
+    )
     message: str
     task_status: TaskStatusEnum
     duration: int = 0
@@ -60,7 +65,12 @@ class TaskLogRecord(BaseModel):
         return False
 
     def __hash__(self):
-        return hash((self.reported_at, self.message, self.task_status, self.duration))
+        return hash((
+            self.reported_at,
+            self.message,
+            self.task_status,
+            self.duration,
+        ))
 
 
 class TaskReference(BaseModel):
@@ -69,7 +79,10 @@ class TaskReference(BaseModel):
 
     def __eq__(self, other):
         if isinstance(other, TaskReference):
-            return self.task_id == other.task_id and self.task_type == other.task_type
+            return (
+                self.task_id == other.task_id
+                and self.task_type == other.task_type
+            )
         return False
 
     def __hash__(self):
@@ -90,7 +103,8 @@ class TaskReference(BaseModel):
         task_item = await task_class.find_one(task_class.uid == self.task_id)
         if not task_item:
             raise ValueError(
-                f"No task found with id {self.task_id} of type {self.task_type}."
+                f"No task found with id {self.task_id} of type "
+                f"{self.task_type}."
             )
 
         return task_item
@@ -107,7 +121,9 @@ class TaskReferenceList(BaseModel):
                 for task_item in task_items:
                     await task_item.start_processing()
             case "parallel":
-                await asyncio.gather(*[task.start_processing() for task in task_items])
+                await asyncio.gather(*[
+                    task.start_processing() for task in task_items
+                ])
 
 
 class TaskMixin(BaseModel):
@@ -165,8 +181,9 @@ class TaskMixin(BaseModel):
         cls.signals().append(signal)
 
     @classmethod
-    async def emit_signals(cls, task_instance: "TaskMixin", *, sync=False, **kwargs):
-
+    async def emit_signals(
+        cls, task_instance: "TaskMixin", *, sync=False, **kwargs
+    ):
         async def webhook_call(*args, **kwargs):
             import httpx
 
@@ -183,16 +200,18 @@ class TaskMixin(BaseModel):
                 )
                 await task_instance.save()
                 logging.error(
-                    "\n".join(
-                        ["An error occurred in webhook_call:", traceback_str, str(e)]
-                    )
+                    "\n".join([
+                        "An error occurred in webhook_call:",
+                        traceback_str,
+                        str(e),
+                    ])
                 )
 
         def webhook_task(webhook_url: str):
             return
 
         signals = []
-        meta_data = getattr(task_instance, "meta_data") or {}
+        meta_data = task_instance.meta_data or {}
         task_dict = task_instance.model_dump()
         task_dict.update({"task_type": task_instance.__class__.__name__})
         task_dict.update(kwargs)
@@ -269,7 +288,9 @@ class TaskMixin(BaseModel):
             **kwargs,
         )
 
-    async def add_log(self, log_record: TaskLogRecord, *, emit: bool = True, **kwargs):
+    async def add_log(
+        self, log_record: TaskLogRecord, *, emit: bool = True, **kwargs
+    ):
         self.task_logs.append(log_record)
         if emit:
             # await self.emit_signals(self)
@@ -277,7 +298,9 @@ class TaskMixin(BaseModel):
 
     async def start_processing(self, **kwargs):
         if self.task_references is None:
-            raise NotImplementedError("Subclasses should implement this method")
+            raise NotImplementedError(
+                "Subclasses should implement this method"
+            )
 
         await self.task_references.list_processing()
 
@@ -297,7 +320,9 @@ class TaskMixin(BaseModel):
             await self.save()
             await self.emit_signals(self, **kwargs)
         else:
-            await asyncio.gather(self.save(), self.emit_signals(self, **kwargs))
+            await asyncio.gather(
+                self.save(), self.emit_signals(self, **kwargs)
+            )
 
     async def update_and_emit(self, **kwargs):
         if kwargs.get("task_status") in [

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base/utils/basic.py

@@ -81,7 +81,8 @@ def try_except_wrapper(func, sync_to_thread=False):
                     func_name = f"{class_name}.{func_name}"
         traceback_str = "".join(traceback.format_tb(e.__traceback__))
         logging.error(
-            f"An error occurred in {func_name} ({args=}, {kwargs=}):\n{traceback_str}\n{type(e)}: {e}"
+            f"An error occurred in {func_name} ({args=}, {kwargs=}):\n"
+            f"{traceback_str}\n{type(e)}: {e}"
         )
         return None
 
@@ -140,12 +141,15 @@ def retry_execution(attempts, delay=0, sync_to_thread=False):
                 except Exception as e:
                     last_exception = e
                     logging.warning(
-                        f"Attempt {attempt + 1} failed for {func.__name__}: {e}"
+                        f"Attempt {attempt + 1} failed for {func.__name__}: "
+                        f"{e}"
                     )
                     if delay > 0 and attempt < attempts - 1:
                         await asyncio.sleep(delay)
             # If the loop finishes and the function didn't return successfully
-            logging.error(f"All {attempts} attempts failed for {func.__name__}")
+            logging.error(
+                f"All {attempts} attempts failed for {func.__name__}"
+            )
             raise last_exception
 
         @functools.wraps(func)
@@ -157,12 +161,15 @@ def retry_execution(attempts, delay=0, sync_to_thread=False):
                 except Exception as e:
                     last_exception = e
                     logging.warning(
-                        f"Attempt {attempt + 1} failed for {func.__name__}: {e}"
+                        f"Attempt {attempt + 1} failed for {func.__name__}: "
+                        f"{e}"
                     )
                     if delay > 0 and attempt < attempts - 1:
                         time.sleep(delay)
             # If the loop finishes and the function didn't return successfully
-            logging.error(f"All {attempts} attempts failed for {func.__name__}")
+            logging.error(
+                f"All {attempts} attempts failed for {func.__name__}"
+            )
             raise last_exception
 
         if sync_to_thread or asyncio.iscoroutinefunction(func):

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base/utils/bsontools.py

@@ -6,7 +6,7 @@ from bson.decimal128 import Decimal128
 
 
 def decimal_amount(value):
-    if type(value) == Decimal128:
+    if isinstance(value, Decimal128):
         return Decimal(value.to_decimal())
     return value
 

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4/src/fastapi_mongo_base.egg-info}/PKG-INFO

@@ -1,29 +1,10 @@
 Metadata-Version: 2.4
 Name: fastapi-mongo-base
-Version: 0.12.2
+Version: 0.12.4
 Summary: A simple boilerplate application, including models and schemas and abstract router, for FastAPI with MongoDB
 Author-email: Mahdi Kiani <mahdikiany@gmail.com>
 Maintainer-email: Mahdi Kiani <mahdikiany@gmail.com>
-License: Copyright (c) 2016 The Python Packaging Authority (PyPA)
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy of
-        this software and associated documentation files (the "Software"), to deal in
-        the Software without restriction, including without limitation the rights to
-        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-        of the Software, and to permit persons to whom the Software is furnished to do
-        so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/mahdikiani/fastapi-mongo-base-app
 Project-URL: Bug Reports, https://github.com/mahdikiani/fastapi-mongo-base-app/issues
 Project-URL: Funding, https://github.com/mahdikiani/fastapi-mongo-base-app
@@ -33,7 +14,6 @@ Keywords: fastapi,mongodb,beanie
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Build Tools
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -53,6 +33,8 @@ Requires-Dist: uvicorn[standard]>=0.13.0
 Provides-Extra: image
 Requires-Dist: Pillow>=9.0.0; extra == "image"
 Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: mongomock_motor; extra == "test"
 Requires-Dist: coverage; extra == "test"
 Dynamic: license-file
 

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 LICENSE.txt
+MANIFEST.in
 README.md
 pyproject.toml
 src/fastapi_mongo_base/__init__.py

{fastapi_mongo_base-0.12.2 → fastapi_mongo_base-0.12.4}/src/fastapi_mongo_base.egg-info/requires.txt

@@ -11,4 +11,6 @@ uvicorn[standard]>=0.13.0
 Pillow>=9.0.0
 
 [test]
+pytest
+mongomock_motor
 coverage