python-ppa 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

ppa/mongo/__init__.py

@@ -1,3 +1,4 @@
 from ppa.mongo.interface import IRepository
 from ppa.mongo.interface import query
-from ppa.mongo.interface import document
+from ppa.mongo.interface import document
+from ppa.mongo.interface import DocumentModel

ppa/mongo/interface.py

@@ -1,27 +1,64 @@
 import inspect
 import re
-from typing import Any, Callable, ClassVar, Generic, TypeVar, cast, get_args, get_origin, get_type_hints, List
-from unittest import result
+from typing import Any, Callable, ClassVar, Generic, Optional, TypeVar, cast, get_args, get_origin, get_type_hints, List
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, Field
 from bson import ObjectId, errors
 
 from ppa.config import get_collection, get_framework_logger
 
-T = TypeVar("T", bound=BaseModel)
+T = TypeVar("T", bound='DocumentModel')
 F = TypeVar("F", bound=Callable[..., Any])
 framework_logger = get_framework_logger("repository")
 
-DEFAULT_DOCUMENT_CONFIG = dict[str, Any] = {
-    "populate_by_name": True,
-    "arbitrary_types_allowed": True,
-    "json_encoders": {ObjectId: str}
-}
-
 
 class DocumentModel(BaseModel):
+    """
+    Base class for all MongoDB models.
+    Inherits default configurations and the standard MongoDB _id mapping.
+    """
     __collection_name__: ClassVar[str]
 
+    # Automatically inherited and merged by child models
+    model_config = ConfigDict(
+        populate_by_name=True,
+        arbitrary_types_allowed=True,
+        json_encoders={ObjectId: str}
+    )
+
+    # Universal MongoDB _id mapping
+    id: Optional[ObjectId] = Field(default=None, alias="_id")
+
+    def model_dump(self, **kwargs: Any) -> dict[str, Any]:
+        """
+        Overrides default Pydantic dump to ensure MongoDB compatibility.
+        Defaults to excluding None values and using aliases (id -> _id).
+        """
+        kwargs.setdefault("exclude_none", True)
+        kwargs.setdefault("by_alias", True)
+        return super().model_dump(**kwargs)
+
+
+# Inherit from list[T] so we can use DocumentList[User], DocumentList[Booking], etc.
+class DocumentList(list[T]):
+    """
+    List of documents that can be used to perform bulk operations.
+    Inherits default configurations
+    """
+
+    def model_dump(self, **kwargs: Any) -> list[dict[str, Any]]:
+        return [doc.model_dump(**kwargs) for doc in self]
+
+    @classmethod
+    def model_validate(cls, obj: list[Any], entity_cls: type[T]) -> 'DocumentList[T]':
+        """
+        Validates a list of raw dictionaries and returns a populated DocumentList.
+        We pass `entity_cls` because generic type T is erased at runtime.
+        """
+        if not isinstance(obj, list) and not hasattr(obj, "__iter__"):
+            raise ValueError("Data provided to DocumentList.model_validate must be iterable.")
+
+        return cls([entity_cls.model_validate(item) for item in obj])
 
 def query(definition: dict[str, Any]) -> Callable[[F], F]:
     """Annotation to specify a custom MongoDB query template."""
@@ -38,20 +75,6 @@ def document(name: str) -> Callable[[type[DocumentModel]], type[DocumentModel]]:
 
     def decorator(cls):
         cls.__collection_name__ = name
-        current_cfs = dict(getattr(cls, "model_config", {}) or {})
-        current_encoders = dict(current_cfs.get("json_encoders", {}) or {})
-        merged_encoders = {
-            **DEFAULT_DOCUMENT_CONFIG["json_encoders"],
-            **current_encoders
-        }
-        merged_cfs = {
-            **DEFAULT_DOCUMENT_CONFIG["model_config"],
-            **current_cfs,
-            "json_encoders": merged_encoders,
-        }
-        cls.model_config = ConfigDict(**merged_cfs)
-        if hasattr(cls, "model_rebuild"):
-            cls.model_rebuild(force=True)
         return cls
 
     return decorator
@@ -86,8 +109,8 @@ class RepositoryMeta(type):
                 is_convention = re.match(r"(find_by|find_all_by|exists_by|count_by)_(.*)", attr_name)
 
                 if not is_convention:
-                    framework_logger.info("Convention does not exists, relying on user implementation")
-                    return cls
+                    framework_logger.info("Convention does not exist, relying on user implementation")
+                    continue
 
                 if query_template or is_convention is not None:
                     hints = get_type_hints(attr_value)
@@ -139,12 +162,11 @@ class RepositoryMeta(type):
                 if p_name in bound.arguments:
                     ordered_args.append(bound.arguments[p_name])
 
-            # Pure dictionary walk for placeholder substitution (no internal casting strings to dates)
             def substitute_placeholders(node: Any) -> Any:
                 if isinstance(node, str) and node.startswith("?"):
                     try:
                         idx = int(node[1:])
-                        return ordered_args[idx]  # Inject whatever object type the user passed
+                        return ordered_args[idx]
                     except (ValueError, IndexError):
                         return node
                 elif isinstance(node, dict):
@@ -193,6 +215,13 @@ class RepositoryMeta(type):
             bound.apply_defaults()
             actual_value = bound.arguments.get(param_names[0]) if param_names else None
 
+            # Convert string IDs to ObjectId if querying against _id
+            if mongo_field == "_id" and isinstance(actual_value, str):
+                try:
+                    actual_value = ObjectId(actual_value)
+                except errors.InvalidId:
+                    pass
+
             query_dict: dict[str, Any] = {mongo_field: actual_value}
 
             framework_logger.debug(
@@ -235,7 +264,6 @@ def execute_dynamic_query(
         return_type: Any,
         entity_cls: type[DocumentModel],
 ) -> Any:
-    # Only cast fields checking against the database's internal _id field
     processed_query = cast_primary_keys(query_dict)
 
     framework_logger.debug(
@@ -253,18 +281,15 @@ def execute_dynamic_query(
     if strategy == "exists_by" or origin_type is bool:
         return collection.count_documents(processed_query, limit=1) > 0
 
-    def sanitize_output(doc: Any) -> Any:
-        if doc and "_id" in doc:
-            doc = dict(doc)
-            doc["_id"] = str(doc["_id"])
-        return doc
-
-    if origin_type is list:
+    # UPDATE: Support both standard lists and our new DocumentList
+    if origin_type in (list, DocumentList):
         cursor = collection.find(processed_query)
-        return [entity_cls.model_validate(sanitize_output(doc)) for doc in cursor]
+        results = [entity_cls.model_validate(doc) for doc in cursor]
+        # Return the specific list type requested
+        return DocumentList(results) if origin_type is DocumentList else results
 
     doc = collection.find_one(processed_query)
-    return entity_cls.model_validate(sanitize_output(doc)) if doc else None
+    return entity_cls.model_validate(doc) if doc else None
 
 
 class IRepository(Generic[T], metaclass=RepositoryMeta):
@@ -284,43 +309,31 @@ class IRepository(Generic[T], metaclass=RepositoryMeta):
         )
 
     def save(self, pyd_model: T) -> str:
-        data = pyd_model.model_dump(exclude_none=True)
+        # Base model override handles exclude_none and by_alias automatically
+        data = pyd_model.model_dump()
         inserted_data = self.collection.insert_one(data)
-        return inserted_data.inserted_id
+        return str(inserted_data.inserted_id)
 
     def save_all(self, pyd_models: List[T]) -> List[str]:
-        data = [pyd_model for pyd_model in pyd_models]
+        data = [pyd_model.model_dump() for pyd_model in pyd_models]
         inserted_data = self.collection.insert_many(data)
-        return inserted_data.inserted_ids
+        return [str(obj_id) for obj_id in inserted_data.inserted_ids]
 
-    def find_all(self) -> list[T]:
-        """
-        Fetches all documents matching a query and maps them safely to
-        the repository's bound Pydantic model.
-        """
-        # 1. Fetch raw cursor streams from MongoDB
+    def find_all(self) -> DocumentList[T]:
         cursor = self.collection.find()
-
-        # 2. Local serialization helper to clean BSON primary keys
-        # def sanitize(doc):
-        #     if doc and "_id" in doc:
-        #         doc = dict(doc)
-        #         doc["_id"] = str(doc["_id"])
-        #     return doc
-
-        # 3. Instantiate using self._entity_cls (which holds the real model at runtime)
-        return [self._entity_cls(**dict(data_dict)) for data_dict in cursor]
+        # UPDATE: Wrap the list comprehension in DocumentList
+        return DocumentList([self._entity_cls.model_validate(doc) for doc in cursor])
 
     def find(self, query_dict: dict) -> T:
-        data = self.collection.find(query_dict)
+        data = self.collection.find_one(query_dict)
         if not data:
             raise ValueError("No data found")
-        return dict(data)
+        return self._entity_cls.model_validate(data)
 
     def delete(self, resource_id: str) -> bool:
         query_result = self.collection.delete_one({"_id": ObjectId(resource_id)})
         return query_result.deleted_count > 0
 
-    def update(self, resource_id: str, data:dict):
+    def update(self, resource_id: str, data: dict) -> bool:
         query_result = self.collection.update_one({"_id": ObjectId(resource_id)}, {"$set": data})
         return query_result.modified_count > 0

{python_ppa-0.1.3.dist-info → python_ppa-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-ppa
-Version: 0.1.3
+Version: 0.1.5
 Summary: JPA-like ORM for Python
 Author: Pratyush Kumar
 License-Expression: MIT

python_ppa-0.1.5.dist-info/RECORD

@@ -0,0 +1,9 @@
+ppa/__init__.py,sha256=hPJEX6p9ISqFn9oCk29_HIZYIFVUF_XLEk02dg5fl9c,44
+ppa/config.py,sha256=BpnjdXIYjKe7P8HGKFwZkkTbHf94734dhuT1ki4x0UM,8430
+ppa/mongo/__init__.py,sha256=tioeX330txLUWpEyAuj8rCO6C8DISjRkNFVDs8wGe54,168
+ppa/mongo/interface.py,sha256=lKDtd1KOXIjl9gKPGP_WVoKsE54_esJadNqKIHTadcw,12684
+python_ppa-0.1.5.dist-info/licenses/LICENSE,sha256=J2MOuVHjIUNmdrDLa3O35gQz6E_wAJh9Ke3dod_ZDWc,1071
+python_ppa-0.1.5.dist-info/METADATA,sha256=SGw0-dKyDKSE5A2gFEPiJ6JMHDpJZA9Bpi78jtrBUSY,4903
+python_ppa-0.1.5.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_ppa-0.1.5.dist-info/top_level.txt,sha256=43G6at2pfqB1LsMChCc2_K8WwSSt-LoYBAYN6Sf-krk,4
+python_ppa-0.1.5.dist-info/RECORD,,

python_ppa-0.1.3.dist-info/RECORD

@@ -1,9 +0,0 @@
-ppa/__init__.py,sha256=hPJEX6p9ISqFn9oCk29_HIZYIFVUF_XLEk02dg5fl9c,44
-ppa/config.py,sha256=BpnjdXIYjKe7P8HGKFwZkkTbHf94734dhuT1ki4x0UM,8430
-ppa/mongo/__init__.py,sha256=eOEbRiNLeS8zU6vhyNTIZqOCS6Pg_W_aAfe1JFbq5qk,122
-ppa/mongo/interface.py,sha256=pp8SE35l6sNxBhXjnfaR1jQf6t5ac7VFumSA3cTdW2U,11949
-python_ppa-0.1.3.dist-info/licenses/LICENSE,sha256=J2MOuVHjIUNmdrDLa3O35gQz6E_wAJh9Ke3dod_ZDWc,1071
-python_ppa-0.1.3.dist-info/METADATA,sha256=lLN8XxLOfCrpRjlrkcDgbHexnY1gL924XWVjtBjP2fU,4903
-python_ppa-0.1.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_ppa-0.1.3.dist-info/top_level.txt,sha256=43G6at2pfqB1LsMChCc2_K8WwSSt-LoYBAYN6Sf-krk,4
-python_ppa-0.1.3.dist-info/RECORD,,