hexkit 7.2.1__tar.gz → 8.0.0__tar.gz

{hexkit-7.2.1/src/hexkit.egg-info → hexkit-8.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hexkit
-Version: 7.2.1
+Version: 8.0.0
 Summary: A Toolkit for Building Microservices using the Hexagonal Architecture
 Author-email: "German Human Genome Phenome Archive (GHGA)" <contact@ghga.de>
 License: Apache 2.0
@@ -18,39 +18,45 @@ Classifier: Intended Audience :: Developers
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: opentelemetry-api<2,>=1.37
-Requires-Dist: pydantic<3,>=2.11
-Requires-Dist: pydantic_settings<3,>=2.10
+Requires-Dist: opentelemetry-api<2,>=1.39
+Requires-Dist: pydantic<3,>=2.12
+Requires-Dist: pydantic_settings<3,>=2.12
 Requires-Dist: PyYAML<7,>=6
 Provides-Extra: akafka
-Requires-Dist: aiokafka[lz4,snappy,zstd]~=0.12.0; extra == "akafka"
+Requires-Dist: aiokafka[lz4,snappy,zstd]~=0.13.0; extra == "akafka"
 Requires-Dist: jsonschema<5,>=4.25; extra == "akafka"
 Provides-Extra: s3
-Requires-Dist: boto3<2,>=1.40; extra == "s3"
-Requires-Dist: botocore<2,>=1.40; extra == "s3"
+Requires-Dist: boto3<2,>=1.42; extra == "s3"
+Requires-Dist: botocore<2,>=1.42; extra == "s3"
 Provides-Extra: mongodb
 Requires-Dist: pymongo<5,>=4.15; extra == "mongodb"
+Provides-Extra: redis
+Requires-Dist: redis<8,>=7.1; extra == "redis"
 Provides-Extra: opentelemetry-base
-Requires-Dist: opentelemetry-sdk<2,>=1.37.0; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-exporter-otlp<2,>=1.37.0; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-instrumentation>=0.58b0; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-instrumentation-httpx>=0.58b0; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-distro>=0.58b0; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-sdk<2,>=1.39.1; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-exporter-otlp<2,>=1.39.1; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-instrumentation>=0.60b1; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-instrumentation-httpx>=0.60b1; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-distro>=0.60b1; extra == "opentelemetry-base"
 Provides-Extra: opentelemetry-akafka
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-akafka"
 Requires-Dist: hexkit[akafka]; extra == "opentelemetry-akafka"
-Requires-Dist: opentelemetry-instrumentation-aiokafka>=0.58b0; extra == "opentelemetry-akafka"
+Requires-Dist: opentelemetry-instrumentation-aiokafka>=0.60b1; extra == "opentelemetry-akafka"
 Provides-Extra: opentelemetry-mongodb
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-mongodb"
 Requires-Dist: hexkit[mongodb]; extra == "opentelemetry-mongodb"
-Requires-Dist: opentelemetry-instrumentation-pymongo>=0.58b0; extra == "opentelemetry-mongodb"
+Requires-Dist: opentelemetry-instrumentation-pymongo>=0.60b1; extra == "opentelemetry-mongodb"
 Provides-Extra: opentelemetry-fastapi
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-fastapi"
-Requires-Dist: opentelemetry-instrumentation-fastapi>=0.58b0; extra == "opentelemetry-fastapi"
+Requires-Dist: opentelemetry-instrumentation-fastapi>=0.60b1; extra == "opentelemetry-fastapi"
 Provides-Extra: opentelemetry-s3
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-s3"
 Requires-Dist: hexkit[s3]; extra == "opentelemetry-s3"
-Requires-Dist: opentelemetry-instrumentation-botocore>=0.58b0; extra == "opentelemetry-s3"
+Requires-Dist: opentelemetry-instrumentation-botocore>=0.60b1; extra == "opentelemetry-s3"
+Provides-Extra: opentelemetry-redis
+Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-redis"
+Requires-Dist: hexkit[redis]; extra == "opentelemetry-redis"
+Requires-Dist: opentelemetry-instrumentation-redis>=0.60b1; extra == "opentelemetry-redis"
 Provides-Extra: opentelemetry
 Requires-Dist: hexkit[opentelemetry-akafka]; extra == "opentelemetry"
 Requires-Dist: hexkit[opentelemetry-mongodb]; extra == "opentelemetry"
@@ -65,6 +71,9 @@ Requires-Dist: testcontainers<5,>=4.13; extra == "test-s3"
 Provides-Extra: test-mongodb
 Requires-Dist: hexkit[mongodb]; extra == "test-mongodb"
 Requires-Dist: testcontainers[mongo]<5,>=4.13; extra == "test-mongodb"
+Provides-Extra: test-redis
+Requires-Dist: hexkit[redis]; extra == "test-redis"
+Requires-Dist: testcontainers[redis]<5,>=4.13; extra == "test-redis"
 Provides-Extra: test
 Requires-Dist: hexkit[test-akafka,test-mongodb,test-s3]; extra == "test"
 Provides-Extra: all

{hexkit-7.2.1 → hexkit-8.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 requires = [
-    "setuptools>=80.9",
+    "setuptools>=80.10",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -23,12 +23,12 @@ classifiers = [
     "Intended Audience :: Developers",
 ]
 name = "hexkit"
-version = "7.2.1"
+version = "8.0.0"
 description = "A Toolkit for Building Microservices using the Hexagonal Architecture"
 dependencies = [
-    "opentelemetry-api >=1.37, <2",
-    "pydantic >=2.11, <3",
-    "pydantic_settings >=2.10, <3",
+    "opentelemetry-api >=1.39, <2",
+    "pydantic >=2.12, <3",
+    "pydantic_settings >=2.12, <3",
     "PyYAML >=6, <7",
 ]
 
@@ -37,41 +37,49 @@ text = "Apache 2.0"
 
 [project.optional-dependencies]
 akafka = [
-    "aiokafka[zstd,lz4,snappy]~=0.12.0",
+    "aiokafka[zstd,lz4,snappy]~=0.13.0",
     "jsonschema >=4.25, <5",
 ]
 s3 = [
-    "boto3 >=1.40, <2",
-    "botocore >=1.40, <2",
+    "boto3 >=1.42, <2",
+    "botocore >=1.42, <2",
 ]
 mongodb = [
     "pymongo >=4.15, <5",
 ]
+redis = [
+    "redis >=7.1, <8",
+]
 opentelemetry-base = [
-    "opentelemetry-sdk >=1.37.0, <2",
-    "opentelemetry-exporter-otlp >=1.37.0, <2",
-    "opentelemetry-instrumentation >=0.58b0",
-    "opentelemetry-instrumentation-httpx >=0.58b0",
-    "opentelemetry-distro >=0.58b0",
+    "opentelemetry-sdk >=1.39.1, <2",
+    "opentelemetry-exporter-otlp >=1.39.1, <2",
+    "opentelemetry-instrumentation >=0.60b1",
+    "opentelemetry-instrumentation-httpx >=0.60b1",
+    "opentelemetry-distro >=0.60b1",
 ]
 opentelemetry-akafka = [
     "hexkit[opentelemetry-base]",
     "hexkit[akafka]",
-    "opentelemetry-instrumentation-aiokafka >=0.58b0",
+    "opentelemetry-instrumentation-aiokafka >=0.60b1",
 ]
 opentelemetry-mongodb = [
     "hexkit[opentelemetry-base]",
     "hexkit[mongodb]",
-    "opentelemetry-instrumentation-pymongo >=0.58b0",
+    "opentelemetry-instrumentation-pymongo >=0.60b1",
 ]
 opentelemetry-fastapi = [
     "hexkit[opentelemetry-base]",
-    "opentelemetry-instrumentation-fastapi >=0.58b0",
+    "opentelemetry-instrumentation-fastapi >=0.60b1",
 ]
 opentelemetry-s3 = [
     "hexkit[opentelemetry-base]",
     "hexkit[s3]",
-    "opentelemetry-instrumentation-botocore >=0.58b0",
+    "opentelemetry-instrumentation-botocore >=0.60b1",
+]
+opentelemetry-redis = [
+    "hexkit[opentelemetry-base]",
+    "hexkit[redis]",
+    "opentelemetry-instrumentation-redis >=0.60b1",
 ]
 opentelemetry = [
     "hexkit[opentelemetry-akafka]",
@@ -91,6 +99,10 @@ test-mongodb = [
     "hexkit[mongodb]",
     "testcontainers[mongo] >=4.13, <5",
 ]
+test-redis = [
+    "hexkit[redis]",
+    "testcontainers[redis] >=4.13, <5",
+]
 test = [
     "hexkit[test-akafka,test-s3,test-mongodb]",
 ]
@@ -209,7 +221,7 @@ check_untyped_defs = true
 no_site_packages = false
 
 [tool.pytest.ini_options]
-minversion = "8.4"
+minversion = "9.0"
 asyncio_mode = "strict"
 asyncio_default_fixture_loop_scope = "function"
 

{hexkit-7.2.1 → hexkit-8.0.0}/src/hexkit/protocols/dao.py

@@ -23,7 +23,7 @@ from abc import ABC, abstractmethod
 from collections.abc import AsyncIterator, Collection, Mapping
 from contextlib import AbstractAsyncContextManager
 from functools import partial
-from typing import Any, TypeVar
+from typing import Any, Generic, TypeVar
 from uuid import uuid4
 
 from pydantic import BaseModel, Field
@@ -39,10 +39,22 @@ __all__ = [
     "ResourceAlreadyExistsError",
     "ResourceNotFoundError",
     "UUID4Field",
+    "UniqueConstraintViolationError",
 ]
 
+
+class IndexBase(ABC):
+    """Base from which all DAO index classes must inherit"""
+
+    @abstractmethod
+    def list_field_names(self) -> list[str]:
+        """Returns a list of all fields specified by this index"""
+        ...
+
+
 # Type variable for handling Data Transfer Objects:
 Dto = TypeVar("Dto", bound=BaseModel)
+Index = TypeVar("Index", bound=IndexBase)
 
 
 class DaoError(RuntimeError):
@@ -65,6 +77,20 @@ class ResourceAlreadyExistsError(DaoError):
         super().__init__(message)
 
 
+class UniqueConstraintViolationError(DaoError):
+    """Raised when attempting to insert a resource violated a uniqueness constraint.
+
+    This does not apply to the default unique index automatically applied to
+    the ID field.
+    """
+
+    def __init__(self, *, unique_fields: dict[str, Any]):
+        message = (
+            f"A resource with the unique field value(s) {unique_fields} already exists."
+        )
+        super().__init__(message)
+
+
 class FindError(DaoError):
     """Base for all error related to DAO find operations."""
 
@@ -268,16 +294,19 @@ class DaoFactoryBase:
         cls,
         *,
         dto_model: type[Dto],
-        fields_to_index: Collection[str] | None,
+        indexes: Collection[Index] | None,
     ) -> None:
         """Checks that all provided fields are present in the dto_model.
         Raises IndexFieldsInvalidError otherwise.
         """
-        if fields_to_index is None:
+        if not indexes:
             return
 
         try:
-            validate_fields_in_model(model=dto_model, fields=fields_to_index)
+            for index in indexes:
+                validate_fields_in_model(
+                    model=dto_model, fields=index.list_field_names()
+                )
         except FieldNotInModelError as error:
             raise cls.IndexFieldsInvalidError(
                 f"Provided index fields are invalid: {error}"
@@ -289,16 +318,14 @@ class DaoFactoryBase:
         *,
         dto_model: type[Dto],
         id_field: str,
-        fields_to_index: Collection[str] | None,
+        indexes: Collection[Index] | None,
     ) -> None:
         """Validates the input parameters of the get_dao method."""
         cls._validate_dto_model_id(dto_model=dto_model, id_field=id_field)
-        cls._validate_fields_to_index(
-            dto_model=dto_model, fields_to_index=fields_to_index
-        )
+        cls._validate_fields_to_index(dto_model=dto_model, indexes=indexes)
 
 
-class DaoFactoryProtocol(DaoFactoryBase, ABC):
+class DaoFactoryProtocol(DaoFactoryBase, ABC, Generic[Index]):
     """A protocol describing a factory to produce Data Access Objects (DAO) objects
     that are enclosed in transactional scopes.
     """
@@ -309,7 +336,7 @@ class DaoFactoryProtocol(DaoFactoryBase, ABC):
         name: str,
         dto_model: type[Dto],
         id_field: str,
-        fields_to_index: Collection[str] | None = None,
+        indexes: Collection[Index] | None = None,
     ) -> Dao[Dto]:
         """Constructs a DAO for interacting with resources in a database.
 
@@ -322,9 +349,9 @@ class DaoFactoryProtocol(DaoFactoryBase, ABC):
             id_field:
                 The name of the field of the `dto_model` that serves as resource ID.
                 (DAO implementation might use this field as primary key.)
-            fields_to_index:
-                Optionally, provide any fields that should be indexed in addition to the
-                `id_field`. Defaults to None.
+            indexes:
+                Optionally, provide any indexes that should be created in addition to
+                the provider's default index on `id_field`. Defaults to None.
         Returns:
             A DAO specific to the provided DTO model.
 
@@ -334,17 +361,13 @@ class DaoFactoryProtocol(DaoFactoryBase, ABC):
             self.IdTypeNotSupportedError:
                 Raised when the id_field of the dto_model has an unexpected type.
         """
-        self._validate(
-            dto_model=dto_model,
-            id_field=id_field,
-            fields_to_index=fields_to_index,
-        )
+        self._validate(dto_model=dto_model, id_field=id_field, indexes=indexes)
 
         return await self._get_dao(
             name=name,
             dto_model=dto_model,
             id_field=id_field,
-            fields_to_index=fields_to_index,
+            indexes=indexes,
         )
 
     @abstractmethod
@@ -354,7 +377,7 @@ class DaoFactoryProtocol(DaoFactoryBase, ABC):
         name: str,
         dto_model: type[Dto],
         id_field: str,
-        fields_to_index: Collection[str] | None,
+        indexes: Collection[Index] | None,
     ) -> Dao[Dto]:
         """*To be implemented by the provider. Input validation is done outside of this
         method.*

{hexkit-7.2.1 → hexkit-8.0.0}/src/hexkit/protocols/daopub.py

@@ -26,11 +26,7 @@ from abc import ABC, abstractmethod
 from collections.abc import Callable, Collection
 
 from hexkit.custom_types import JsonObject
-from hexkit.protocols.dao import (
-    Dao,
-    DaoFactoryBase,
-    Dto,
-)
+from hexkit.protocols.dao import Dao, DaoFactoryBase, Dto, Index
 
 
 class DaoPublisher(Dao[Dto], typing.Protocol[Dto]):
@@ -49,7 +45,7 @@ class DaoPublisher(Dao[Dto], typing.Protocol[Dto]):
         ...
 
 
-class DaoPublisherFactoryProtocol(DaoFactoryBase, ABC):
+class DaoPublisherFactoryProtocol(DaoFactoryBase, ABC, typing.Generic[Index]):
     """A protocol describing a factory to produce Data Access Objects (DAO) objects
     which automatically publish changes according to the outbox pattern.
     """
@@ -60,7 +56,7 @@ class DaoPublisherFactoryProtocol(DaoFactoryBase, ABC):
         name: str,
         dto_model: type[Dto],
         id_field: str,
-        fields_to_index: Collection[str] | None = None,
+        indexes: Collection[Index] | None = None,
         dto_to_event: Callable[[Dto], JsonObject | None],
         event_topic: str,
         autopublish: bool = True,
@@ -76,9 +72,9 @@ class DaoPublisherFactoryProtocol(DaoFactoryBase, ABC):
             id_field:
                 The name of the field of the `dto_model` that serves as resource ID.
                 (DAO implementation might use this field as primary key.)
-            fields_to_index:
-                Optionally, provide any fields that should be indexed in addition to the
-                `id_field`. Defaults to None.
+            indexes:
+                Optionally, provide any indexes that should be created in addition to
+                the provider's default index on `id_field`. Defaults to None.
             dto_to_event:
                 A function that takes a DTO and returns the payload for an event.
                 If the returned payload is None, the event will not be published.
@@ -97,17 +93,13 @@ class DaoPublisherFactoryProtocol(DaoFactoryBase, ABC):
             self.IdTypeNotSupportedError:
                 Raised when the id_field of the dto_model has an unexpected type.
         """
-        self._validate(
-            dto_model=dto_model,
-            id_field=id_field,
-            fields_to_index=fields_to_index,
-        )
+        self._validate(dto_model=dto_model, id_field=id_field, indexes=indexes)
 
         return await self._get_dao(
             name=name,
             dto_model=dto_model,
             id_field=id_field,
-            fields_to_index=fields_to_index,
+            indexes=indexes,
             dto_to_event=dto_to_event,
             event_topic=event_topic,
             autopublish=autopublish,
@@ -120,7 +112,7 @@ class DaoPublisherFactoryProtocol(DaoFactoryBase, ABC):
         name: str,
         dto_model: type[Dto],
         id_field: str,
-        fields_to_index: Collection[str] | None,
+        indexes: Collection[Index] | None,
         dto_to_event: Callable[[Dto], JsonObject | None],
         event_topic: str,
         autopublish: bool,

hexkit-8.0.0/src/hexkit/protocols/kvstore.py

@@ -0,0 +1,55 @@
+# Copyright 2021 - 2025 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# for the German Human Genome-Phenome Archive (GHGA)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+"""Protocol supporting key-value store operations."""
+
+from typing import Generic, Protocol, TypeVar
+
+V = TypeVar("V")
+
+
+class KeyValueStoreProtocol(Protocol, Generic[V]):
+    """A protocol for a key-value store."""
+
+    async def get(self, key: str, default: V | None = None) -> V | None:
+        """Retrieve the value for the given key.
+
+        Returns the specified default value if there is no such value in the store.
+        """
+        pass
+
+    async def set(self, key: str, value: V) -> None:
+        """Set the value for the given key.
+
+        Providers must reject storing a value of None if they
+        support a value domain V that can contain such values.
+        """
+        pass
+
+    async def delete(self, key: str) -> None:
+        """Delete the value for the given key.
+
+        Does nothing if there is no such value in the store.
+        """
+        pass
+
+    async def exists(self, key: str) -> bool:
+        """Check if the given key exists.
+
+        Default implementation for classes inheriting from this protocol.
+        Providers can use something more efficient.
+        """
+        return (await self.get(key)) is not None

{hexkit-7.2.1 → hexkit-8.0.0}/src/hexkit/protocols/objstorage.py

@@ -182,6 +182,31 @@ class ObjectStorageProtocol(ABC):
             anticipated_part_size=anticipated_part_size,
         )
 
+    async def list_multipart_uploads_for_object(
+        self, *, bucket_id: str, object_id: str
+    ) -> list[str]:
+        """Lists all active multipart uploads for the given object ID.
+
+        Raises a `BucketNotFoundError` if the bucket does not exist.
+        """
+        self._validate_bucket_id(bucket_id)
+        self._validate_object_id(object_id)
+        return await self._list_multipart_uploads_for_object(
+            bucket_id=bucket_id, object_id=object_id
+        )
+
+    async def get_all_multipart_uploads(self, *, bucket_id: str) -> dict[str, str]:
+        """Gets all active multipart uploads for the given bucket ID.
+
+        Returns a dict where the keys are upload IDs and values are object IDs.
+        S3 allows multiple ongoing multi-part uploads, so it's possible for some upload
+        IDs to map to the same object ID.
+
+        Raises a `BucketNotFoundError` if the bucket does not exist.
+        """
+        self._validate_bucket_id(bucket_id)
+        return await self._get_all_multipart_uploads(bucket_id=bucket_id)
+
     async def get_object_download_url(
         self, *, bucket_id: str, object_id: str, expires_after: int = 86400
     ) -> str:
@@ -404,6 +429,29 @@ class ObjectStorageProtocol(ABC):
         """
         ...
 
+    @abstractmethod
+    async def _list_multipart_uploads_for_object(
+        self, *, bucket_id: str, object_id: str
+    ) -> list[str]:
+        """Lists all active multipart uploads for the given object ID.
+
+        *To be implemented by the provider. Input validation is done outside of this
+        method.*
+        """
+        ...
+
+    @abstractmethod
+    async def _get_all_multipart_uploads(self, *, bucket_id: str) -> dict[str, str]:
+        """Gets all active multipart uploads for the given bucket ID.
+
+        Returns a dict where the keys are upload IDs and values are object IDs.
+        S3 allows multiple ongoing multi-part uploads, so it's possible for some upload
+        IDs to map to the same object ID.
+
+        *To be implemented by the provider. Input validation is done outside of this
+        method.*
+        """
+
     @abstractmethod
     async def _get_object_download_url(
         self, *, bucket_id: str, object_id: str, expires_after: int = 86400

hexkit-8.0.0/src/hexkit/providers/mongodb/__init__.py

@@ -0,0 +1,43 @@
+# Copyright 2021 - 2025 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# for the German Human Genome-Phenome Archive (GHGA)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+"""Subpackage containing MongoDB-based providers and related utilities."""
+
+from .config import MongoDbConfig
+from .provider import (
+    ConfiguredMongoClient,
+    MongoDbBytesKeyValueStore,
+    MongoDbDao,
+    MongoDbDaoFactory,
+    MongoDbDtoKeyValueStore,
+    MongoDbIndex,
+    MongoDbJsonKeyValueStore,
+    MongoDbStrKeyValueStore,
+    translate_pymongo_errors,
+)
+
+__all__ = [
+    "ConfiguredMongoClient",
+    "MongoDbBytesKeyValueStore",
+    "MongoDbConfig",
+    "MongoDbDao",
+    "MongoDbDaoFactory",
+    "MongoDbDtoKeyValueStore",
+    "MongoDbIndex",
+    "MongoDbJsonKeyValueStore",
+    "MongoDbStrKeyValueStore",
+    "translate_pymongo_errors",
+]

hexkit-8.0.0/src/hexkit/providers/mongodb/config.py

@@ -0,0 +1,55 @@
+# Copyright 2021 - 2025 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# for the German Human Genome-Phenome Archive (GHGA)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+"""MongoDB specific configuration."""
+
+from pydantic import Field, MongoDsn, PositiveInt, Secret
+from pydantic_settings import BaseSettings
+
+__all__ = ["MongoDbConfig"]
+
+
+class MongoDbConfig(BaseSettings):
+    """Configuration parameters for connecting to a MongoDB server.
+
+    Inherit your config class from this class if your application uses MongoDB.
+    """
+
+    mongo_dsn: Secret[MongoDsn] = Field(
+        ...,
+        examples=["mongodb://localhost:27017"],
+        description=(
+            "MongoDB connection string. Might include credentials."
+            + " For more information see:"
+            + " https://naiveskill.com/mongodb-connection-string/"
+        ),
+    )
+    db_name: str = Field(
+        ...,
+        examples=["my-database"],
+        description="Name of the database located on the MongoDB server.",
+    )
+    mongo_timeout: PositiveInt | None = Field(
+        default=None,
+        examples=[300, 600, None],
+        description=(
+            "Timeout in seconds for API calls to MongoDB. The timeout applies to all steps"
+            + " needed to complete the operation, including server selection, connection"
+            + " checkout, serialization, and server-side execution. When the timeout"
+            + " expires, PyMongo raises a timeout exception. If set to None, the"
+            + " operation will not time out (default MongoDB behavior)."
+        ),
+    )

{hexkit-7.2.1 → hexkit-8.0.0}/src/hexkit/providers/mongodb/migrations/_manager.py

@@ -27,7 +27,7 @@ from pymongo import AsyncMongoClient
 from pymongo.asynchronous.database import AsyncDatabase
 from pymongo.errors import DuplicateKeyError
 
-from hexkit.providers.mongodb import MongoDbConfig
+from hexkit.providers.mongodb.config import MongoDbConfig
 from hexkit.providers.mongodb.provider import ConfiguredMongoClient
 
 from ._utils import MigrationDefinition, Reversible