fastapi-mongo-base 1.2.0__tar.gz → 1.3.0__tar.gz

{fastapi_mongo_base-1.2.0/src/fastapi_mongo_base.egg-info → fastapi_mongo_base-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-mongo-base
-Version: 1.2.0
+Version: 1.3.0
 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>
@@ -15,20 +15,20 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.10
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: beanie>=1.30.0
-Requires-Dist: fastapi>=0.129.0
-Requires-Dist: httpx>=0.28.1
-Requires-Dist: json-advanced>=0.12.11
 Requires-Dist: pydantic>=2.13.4
-Requires-Dist: pytz>=2026.2
+Requires-Dist: httpx>=0.28.1
 Requires-Dist: singleton_package>=0.8.2
+Requires-Dist: json-advanced>=0.13.0
+Requires-Dist: pytz>=2026.2
+Requires-Dist: beanie>=1.30.0
+Requires-Dist: fastapi>=0.129.0
 Requires-Dist: uvicorn[standard]>=0.41.0
 Requires-Dist: uuid6>=2025.0.1
 Provides-Extra: usso

{fastapi_mongo_base-1.2.0 → fastapi_mongo_base-1.3.0}/pyproject.toml

@@ -4,10 +4,10 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fastapi-mongo-base"
-version = "1.2.0"
+version = "1.3.0"
 description = "A simple boilerplate application, including models and schemas and abstract router, for FastAPI with MongoDB"
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.12"
 license = "MIT"
 license-files = ["LICENSE.txt"]
 keywords = ["fastapi", "mongodb", "beanie"]
@@ -18,19 +18,19 @@ classifiers = [
   "Intended Audience :: Developers",
   "Topic :: Software Development :: Build Tools",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.10",
-  "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "Programming Language :: Python :: 3 :: Only",
 ]
 dependencies = [
-  "beanie>=1.30.0",
-  "fastapi>=0.129.0",
-  "httpx>=0.28.1",
-  "json-advanced>=0.12.11",
   "pydantic>=2.13.4",
-  "pytz>=2026.2",
+  "httpx>=0.28.1",
   "singleton_package>=0.8.2",
+  "json-advanced>=0.13.0",
+  "pytz>=2026.2",
+  "beanie>=1.30.0",
+  "fastapi>=0.129.0",
   "uvicorn[standard]>=0.41.0",
   "uuid6>=2025.0.1",
 ]

{fastapi_mongo_base-1.2.0 → fastapi_mongo_base-1.3.0}/src/fastapi_mongo_base/core/config.py

@@ -54,9 +54,6 @@ class Settings(metaclass=Singleton):
     mongo_connect_timeout_ms: int = int(
         os.getenv("MONGO_CONNECT_TIMEOUT_MS", default="5000")
     )
-    exit_on_init_failure: bool = os.getenv(
-        "EXIT_ON_INIT_FAILURE", default="true"
-    ).lower() in ("true", "on", "1")
 
     @classmethod
     def get_coverage_dir(cls) -> str:

{fastapi_mongo_base-1.2.0 → fastapi_mongo_base-1.3.0}/src/fastapi_mongo_base/core/db.py

@@ -4,7 +4,6 @@ import logging
 
 from beanie import init_beanie
 
-from fastapi_mongo_base.core.errors.db_errors import from_pymongo_error
 from fastapi_mongo_base.models import BaseEntity
 from fastapi_mongo_base.utils import basic
 
@@ -26,17 +25,12 @@ async def init_mongo_db(settings: Settings | None = None) -> object:
 
     Raises:
         ImportError: If MongoDB client libraries are not installed.
-        SystemExit: If connection fails and ``exit_on_init_failure`` is
-            enabled (default; use in Docker so the container restarts
-            until Mongo is up).
-        MongoDBConnectionError: If MongoDB connection or initialization fails
-            and ``exit_on_init_failure`` is disabled.
-        MongoDBConnectionTimeoutError: If MongoDB connection times out and
-            ``exit_on_init_failure`` is disabled.
+        MongoDBConnectionError: If MongoDB connection or initialization fails.
 
     """
     try:
         from pymongo import AsyncMongoClient
+        from pymongo.errors import PyMongoError, ServerSelectionTimeoutError
     except ImportError:
         try:
             from motor.motor_asyncio import AsyncIOMotorClient
@@ -48,14 +42,12 @@ async def init_mongo_db(settings: Settings | None = None) -> object:
     if settings is None:
         settings = Settings()
 
+    client = AsyncMongoClient(
+        settings.mongo_uri,
+        serverSelectionTimeoutMS=settings.mongo_server_selection_timeout_ms,
+        connectTimeoutMS=settings.mongo_connect_timeout_ms,
+    )
     try:
-        client = AsyncMongoClient(
-            settings.mongo_uri,
-            serverSelectionTimeoutMS=(
-                settings.mongo_server_selection_timeout_ms
-            ),
-            connectTimeoutMS=settings.mongo_connect_timeout_ms,
-        )
         await client.server_info()
         db = client.get_database(settings.project_name)
         await init_beanie(
@@ -69,11 +61,19 @@ async def init_mongo_db(settings: Settings | None = None) -> object:
                 )
             ],
         )
-    except Exception as e:
+    except ServerSelectionTimeoutError as e:
         logging.exception(
-            "MongoDB initialization failed at %s", settings.mongo_uri
+            "MongoDB connection timeout at %s", settings.mongo_uri
         )
-        raise from_pymongo_error(e, settings=settings) from e
+        raise SystemExit(1) from e
+
+    except PyMongoError as e:
+        logging.exception("MongoDB error at %s", settings.mongo_uri)
+        raise SystemExit(1) from e
+
+    except Exception as e:
+        logging.exception("Unexpected failure initializing MongoDB")
+        raise SystemExit(1) from e
 
     return db
 
@@ -90,14 +90,14 @@ def init_redis(settings: Settings | None = None) -> tuple:
         Returns (None, None) if Redis is not configured or unavailable.
 
     """
-    if settings is None:
-        settings = Settings()
-
     try:
         from redis import Redis as RedisSync
         from redis.asyncio.client import Redis
         from redis.exceptions import RedisError
 
+        if settings is None:
+            settings = Settings()
+
         redis_uri = getattr(settings, "redis_uri", None)
         if redis_uri:
             redis_sync: RedisSync = RedisSync.from_url(
@@ -115,8 +115,7 @@ def init_redis(settings: Settings | None = None) -> tuple:
             return redis_sync, redis
     except RedisError as e:
         logging.exception("Redis connection error")
-        if settings.exit_on_init_failure:
-            raise SystemExit(1) from e
+        raise SystemExit(1) from e
     except (ImportError, AttributeError, Exception):
         logging.exception("Error initializing Redis")
 

fastapi_mongo_base-1.3.0/src/fastapi_mongo_base/core/errors/mongodb_errors.py

@@ -0,0 +1,186 @@
+"""MongoDB error types and PyMongo-to-HTTP exception conversion."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from fastapi_mongo_base.core.errors.resource_errors import (
+    ResourceAlreadyExistsError,
+    ResourceNotFoundError,
+)
+from fastapi_mongo_base.core.exceptions import BaseHTTPException
+
+if TYPE_CHECKING:
+    from pymongo.errors import PyMongoError
+
+
+class MongoDBError(BaseHTTPException):
+    """Base exception for all MongoDB errors."""
+
+    status_code: int = 500
+    error_code: str = "db_error"
+    message_en: str = "A database error occurred"
+    message_fa: str | None = "یک خطای پایگاه داده رخ داده است"
+
+    def __init__(
+        self,
+        detail: str | None = None,
+        message: dict | None = None,
+        **kwargs: object,
+    ) -> None:
+        """Initialize MongoDBError with optional detail, message, and data."""
+        super().__init__(
+            status_code=self.status_code,
+            error_code=self.error_code,
+            detail=detail or self.message_en,
+            message=message,
+            **kwargs,
+        )
+
+
+class MongoDBConnectionError(MongoDBError):
+    """Raised when a MongoDB connection error occurs."""
+
+    status_code = 503
+    error_code = "mongodb_connection_error"
+    message_en = "A MongoDB connection error occurred"
+    message_fa = (
+        "در حال حاضر امکان اتصال به پایگاه داده وجود ندارد. "
+        "لطفاً چند لحظه دیگر دوباره تلاش کنید."
+    )
+
+
+class MongoDBTimeoutError(MongoDBError):
+    """Raised when a MongoDB network timeout error occurs."""
+
+    status_code = 504
+    error_code = "mongodb_timeout_error"
+    message_en = "A MongoDB timeout error occurred"
+    message_fa = "یک خطای timeout پایگاه داده رخ داده است"
+
+
+class MongodbOperationTimeoutError(MongoDBError):
+    """Raised when a MongoDB operation timeout error occurs."""
+
+    status_code = 504
+    error_code = "mongodb_operation_timeout_error"
+    message_en = "A MongoDB operation timeout error occurred"
+    message_fa = "یک خطای timeout عملیات پایگاه داده رخ داده است"
+
+
+class DocumentNotFoundError(MongoDBError, ResourceNotFoundError):
+    """Raised when a document is not found."""
+
+    status_code = 404
+    error_code = "document_not_found"
+    message_en = "Document not found"
+    message_fa = "سند یافت نشد"
+
+
+class DocumentAlreadyExistsError(MongoDBError, ResourceAlreadyExistsError):
+    """Raised when a document already exists."""
+
+    status_code = 409
+    error_code = "document_already_exists"
+    message_en = "Document already exists"
+    message_fa = "سند قبلاً وجود دارد"
+
+
+class DocumentDuplicateKeyError(MongoDBError):
+    """Raised when a duplicate key constraint is violated."""
+
+    status_code = 409
+    error_code = "document_duplicate_key"
+    message_en = "Document with this key already exists"
+    message_fa = "سند با این کلید قبلاً وجود دارد"
+
+
+class MultipleDocumentsFoundError(MongoDBError):
+    """Raised when a query expected one document but found several."""
+
+    status_code = 409
+    error_code = "multiple_documents_found"
+    message_en = "Multiple documents found"
+    message_fa = "چندین سند یافت شد"
+
+
+def find_pymongo_error(exc: BaseException) -> PyMongoError | None:
+    """
+    Walk the exception chain and return the first PyMongoError.
+
+    Checks ``__cause__`` first, then ``__context__`` (unless suppressed).
+    """
+    try:
+        from pymongo.errors import PyMongoError
+    except ImportError:
+        return None
+
+    seen: set[int] = set()
+    current: BaseException | None = exc
+
+    while current is not None and id(current) not in seen:
+        seen.add(id(current))
+        if isinstance(current, PyMongoError):
+            return current
+
+        if current.__cause__ is not None:
+            current = current.__cause__
+            continue
+
+        if (
+            current.__context__ is not None
+            and not current.__suppress_context__
+        ):
+            current = current.__context__
+            continue
+
+        break
+
+    return None
+
+
+def convert_pymongo_error(exc: PyMongoError) -> MongoDBError:
+    """Map a PyMongoError to the appropriate MongoDB HTTP exception."""
+    from pymongo.errors import (
+        AutoReconnect,
+        ConnectionFailure,
+        DuplicateKeyError,
+        ExecutionTimeout,
+        NetworkTimeout,
+        NotPrimaryError,
+        OperationFailure,
+        ServerSelectionTimeoutError,
+        WaitQueueTimeoutError,
+        WTimeoutError,
+    )
+
+    detail = str(exc)
+
+    if isinstance(exc, DuplicateKeyError):
+        return DocumentDuplicateKeyError(detail=detail)
+
+    if (
+        isinstance(exc, OperationFailure)
+        and getattr(exc, "code", None) == 11000
+    ):
+        return DocumentDuplicateKeyError(detail=detail)
+
+    if isinstance(exc, NetworkTimeout):
+        return MongoDBTimeoutError(detail=detail)
+
+    if isinstance(exc, (ExecutionTimeout, WTimeoutError)):
+        return MongodbOperationTimeoutError(detail=detail)
+
+    if isinstance(
+        exc,
+        (
+            ServerSelectionTimeoutError,
+            ConnectionFailure,
+            AutoReconnect,
+            NotPrimaryError,
+            WaitQueueTimeoutError,
+        ),
+    ):
+        return MongoDBConnectionError(detail=detail)
+
+    return MongoDBError(detail=detail)

fastapi_mongo_base-1.3.0/src/fastapi_mongo_base/core/errors/resource_errors.py

@@ -0,0 +1,90 @@
+"""Resource error exceptions for HTTP responses."""
+
+from fastapi_mongo_base.core.exceptions import BaseHTTPException
+
+
+class ResourceError(BaseHTTPException):
+    """Base exception for all resource errors."""
+
+    status_code: int = 500
+    error_code: str = "resource_error"
+    message_en: str = "A resource error occurred"
+    message_fa: str | None = "مشکلی در منبع پیش آمد. لطفاً دوباره تلاش کنید."
+
+    def __init__(
+        self,
+        detail: str | None = None,
+        message: dict | None = None,
+        **kwargs: object,
+    ) -> None:
+        """Initialize ResourceError with optional detail, message, and data."""
+        super().__init__(
+            status_code=self.status_code,
+            error_code=self.error_code,
+            detail=detail or self.message_en,
+            message=message,
+            **kwargs,
+        )
+
+
+class ResourceNotFoundError(ResourceError):
+    """Raised when a resource is not found."""
+
+    status_code = 404
+    error_code = "resource_not_found"
+    message_en = "Resource not found"
+    message_fa = "یافت نشد"
+
+
+class ResourceAlreadyExistsError(ResourceError):
+    """Raised when a resource already exists."""
+
+    status_code = 409
+    error_code = "resource_already_exists"
+    message_en = "Resource already exists"
+    message_fa = "نمونه‌ی مشابه وجود دارد"
+
+
+class ResourceConflictError(ResourceError):
+    """Raised when a resource conflict occurs."""
+
+    status_code = 409
+    error_code = "resource_conflict"
+    message_en = "Resource conflict"
+    message_fa = "اطلاعات ارسال شده تداخل دارد"
+
+
+class ResourcePaymentRequiredError(ResourceError):
+    """Raised when a resource payment is required."""
+
+    status_code = 402
+    error_code = "resource_payment_required"
+    message_en = "Resource payment required"
+    message_fa = "برای دسترسی، پرداخت لازم است"
+
+
+class ResourceForbiddenError(ResourceError):
+    """Raised when a resource is forbidden."""
+
+    status_code = 403
+    error_code = "permission_denied"
+    message_en = "Permission denied"
+    message_fa = "دسترسی غیر مجاز"
+
+
+class ResourceGoneError(ResourceError):
+    """Raised when a resource is gone."""
+
+    status_code = 410
+    error_code = "resource_gone"
+    message_en = "Resource gone"
+    message_fa = "در دسترس نیست"
+
+
+class ResourceLockedError(ResourceError):
+    """Raised when a resource is locked."""
+
+    status_code = 423
+    error_code = "resource_locked"
+    message_en = "Resource locked"
+    message_fa = "قفل شده است"