lightodm 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

lightodm/__init__.py

@@ -23,7 +23,7 @@ Example:
     await user.asave()
 """
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"
 
 from lightodm.connection import (
     MongoConnection,
@@ -35,12 +35,13 @@ from lightodm.connection import (
     get_database,
     get_mongo_connection,
 )
-from lightodm.model import MongoBaseModel, generate_id
+from lightodm.model import MongoBaseModel, generate_composite_id, generate_id
 
 __all__ = [
     # Model
     "MongoBaseModel",
     "generate_id",
+    "generate_composite_id",
     # Connection
     "MongoConnection",
     "connect",

lightodm/connection.py

@@ -298,6 +298,7 @@ def connect(
     Initialize MongoDB connection with optional explicit parameters.
 
     If parameters are not provided, they will be read from environment variables:
+
     - MONGO_URL
     - MONGO_USER
     - MONGO_PASSWORD
@@ -312,7 +313,8 @@ def connect(
     Returns:
         PyMongo Database instance
 
-    Example:
+    Example::
+
         # Connect with explicit parameters
         db = connect(
             url="mongodb://localhost:27017",

lightodm/model.py

@@ -4,11 +4,12 @@ MongoDB Base Model for Pydantic
 Provides ODM functionality for MongoDB with both sync and async support.
 """
 
+import hashlib
 from typing import AsyncIterator, Iterator, List, Optional, Type, TypeVar
 
 from bson import ObjectId
 from motor.motor_asyncio import AsyncIOMotorCollection
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, model_validator
 from pymongo.collection import Collection as PyMongoCollection
 
 from lightodm.connection import get_async_database, get_collection
@@ -27,6 +28,20 @@ def generate_id() -> str:
     return str(ObjectId())
 
 
+def generate_composite_id(values: list) -> str:
+    """
+    Generate MD5 hash from list of values for composite key.
+
+    Args:
+        values: List of values to concatenate and hash
+
+    Returns:
+        32-character hexadecimal MD5 hash string
+    """
+    concatenated = "".join(str(v) for v in values)
+    return hashlib.md5(concatenated.encode("utf-8")).hexdigest()
+
+
 class MongoBaseModel(BaseModel):
     """
     Base class for MongoDB document models with ODM functionality.
@@ -66,6 +81,7 @@ class MongoBaseModel(BaseModel):
     # Settings inner class - must be overridden in subclasses
     class Settings:
         name: Optional[str] = None  # MongoDB collection name
+        composite_key: Optional[List[str]] = None  # Fields for composite key ID
 
     @classmethod
     def _uses_mongo_id_alias(cls) -> bool:
@@ -77,6 +93,34 @@ class MongoBaseModel(BaseModel):
             alias = getattr(field, "validation_alias", None)
         return alias == "_id"
 
+    @model_validator(mode="after")
+    def _compute_composite_key(self):
+        """Compute composite key ID if defined in Settings."""
+        composite_key = getattr(self.Settings, "composite_key", None)
+
+        if composite_key is None:
+            return self
+
+        if not isinstance(composite_key, (list, tuple)) or len(composite_key) == 0:
+            raise ValueError("composite_key must be a non-empty list")
+
+        values = []
+        for field_name in composite_key:
+            # Access model_fields from the class, not the instance (Pydantic v2.11+)
+            if field_name not in self.__class__.model_fields and not hasattr(self, field_name):
+                raise ValueError(f"Composite key field '{field_name}' not found in model")
+
+            value = getattr(self, field_name, None)
+            if value is None:
+                raise ValueError(
+                    f"Composite key field '{field_name}' is None. All fields must have values."
+                )
+
+            values.append(value)
+
+        self.id = generate_composite_id(values)
+        return self
+
     def __init_subclass__(cls, **kwargs):
         """
         Validate Settings class is properly defined in subclass.

{lightodm-0.1.0.dist-info → lightodm-0.2.0.dist-info}/METADATA

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: lightodm
-Version: 0.1.0
+Version: 0.2.0
 Summary: Lightweight MongoDB ODM - Simple async/sync Object-Document Mapper for MongoDB
 Project-URL: Homepage, https://github.com/Aprova-GmbH/lightodm
 Project-URL: Repository, https://github.com/Aprova-GmbH/lightodm
-Project-URL: Documentation, https://github.com/Aprova-GmbH/lightodm#readme
+Project-URL: Documentation, https://lightodm.readthedocs.io
 Project-URL: Issues, https://github.com/Aprova-GmbH/lightodm/issues
+Project-URL: Changelog, https://github.com/Aprova-GmbH/lightodm/blob/main/CHANGELOG.md
 Author-email: Andrey Vykhodtsev <vya@aprova.ch>
 License: Apache-2.0
 License-File: LICENSE
@@ -179,6 +180,37 @@ product = Product(name="Widget", sku="WDG-001")
 print(product.id)  # Generated ObjectId string
 ```
 
+### Composite Keys
+
+For multi-tenant applications or when you need deterministic IDs based on multiple fields, use composite keys:
+
+```python
+from lightodm import MongoBaseModel
+
+class TenantUser(MongoBaseModel):
+    class Settings:
+        name = "tenant_users"
+        composite_key = ["tenant_id", "user_id"]  # Order matters
+
+    tenant_id: str
+    user_id: str
+    data: str
+
+# ID is computed as MD5 hash of concatenated field values
+user = TenantUser(tenant_id="tenant1", user_id="user1", data="test")
+print(user.id)  # e.g., "a1b2c3..." - always the same for same tenant_id + user_id
+
+# Same values always produce the same ID (idempotent)
+user2 = TenantUser(tenant_id="tenant1", user_id="user1", data="different")
+assert user.id == user2.id  # True - composite key only uses specified fields
+```
+
+Composite key behavior:
+- Field order in `composite_key` list determines concatenation order
+- All composite key fields must have non-None values
+- Composite key takes precedence over explicitly provided IDs
+- Produces a 32-character hexadecimal MD5 hash
+
 ### Custom Connection
 
 Override `get_collection()` or `get_async_collection()` for custom connection logic:

lightodm-0.2.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+lightodm/__init__.py,sha256=Md1CP92RVTVxtMpT37gMp8UfgO7b7V5q6ogiJUSnbVI,1134
+lightodm/connection.py,sha256=r-MJUXDDyybRnsUTQJpi5HwA2NmHdhW7nk9KZ_oGI2Q,9891
+lightodm/model.py,sha256=uOviHHudJ4cnw0ULLmfkpEb7nC9NAPSKeDAw3XFiHkE,20678
+lightodm/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+lightodm-0.2.0.dist-info/METADATA,sha256=w7Vzmf9e3CGbeziIvycHIA2_16AECk7MFGbyFTBSClI,11053
+lightodm-0.2.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+lightodm-0.2.0.dist-info/licenses/LICENSE,sha256=fL7HOAbNeitdXBSp3bN-4VK6kH26E8ScX3vv5qSsAQI,11345
+lightodm-0.2.0.dist-info/RECORD,,

lightodm-0.1.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-lightodm/__init__.py,sha256=HWLNWbrsx_hzn2Vx8qi3gaQWLK6mRn0GaQ_SLc5KdtI,1082
-lightodm/connection.py,sha256=6iNaSVO9BVA6Y8XoOoULBw7i__h4L3WBjnJKGLjpR9s,9888
-lightodm/model.py,sha256=po98-T2OQQTIwVxVi7PsG4j8FOGzqwzMisKLDW1OmJA,19103
-lightodm/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-lightodm-0.1.0.dist-info/METADATA,sha256=4snZ6jkissXHIFJElPJxG_TCIN9yF7RvDoRE-Wx8BNc,9921
-lightodm-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-lightodm-0.1.0.dist-info/licenses/LICENSE,sha256=fL7HOAbNeitdXBSp3bN-4VK6kH26E8ScX3vv5qSsAQI,11345
-lightodm-0.1.0.dist-info/RECORD,,