aws-python-helper 0.37.0__tar.gz → 0.38.0__tar.gz

{aws_python_helper-0.37.0/aws_python_helper.egg-info → aws_python_helper-0.38.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aws-python-helper
-Version: 0.37.0
+Version: 0.38.0
 Summary: AWS Python Helper Framework
 Author-email: Fabian Claros <neufabiae@gmail.com>
 License-Expression: MIT
@@ -1231,6 +1231,35 @@ invoker.invoke("ServiceModelQuery-dev", payload={
 
 **Note:** `pipeline` and `fields` are mutually exclusive — the framework rejects payloads that include both.
 
+#### Querying by `_id`
+
+ObjectId hex strings in `_id` filters are automatically coerced to `ObjectId` so callers can serialize queries as plain JSON:
+
+```python
+# Plain value
+invoker.invoke("ServiceModelQuery-dev", payload={
+    "session": self.session.to_dict(),
+    "collection": "orders",
+    "filter": {"_id": "65f1a2b3c4d5e6f7a8b9c0d1"},
+})
+
+# Operator with list
+invoker.invoke("ServiceModelQuery-dev", payload={
+    "session": self.session.to_dict(),
+    "collection": "orders",
+    "filter": {"_id": {"$in": ["65f1...", "65f2...", "65f3..."]}},
+})
+
+# 'id' is accepted as an alias for '_id'
+invoker.invoke("ServiceModelQuery-dev", payload={
+    "session": self.session.to_dict(),
+    "collection": "orders",
+    "filter": {"id": "65f1a2b3c4d5e6f7a8b9c0d1"},
+})
+```
+
+Supported operators on `_id`: scalar (`$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`) and list (`$in`, `$nin`). The same coercion is applied to `$match` stages inside a `pipeline`. If the string is not a valid 24-char ObjectId hex, the Lambda raises a clear validation error.
+
 ### Payload reference
 
 | Field | Type | Required | Description |
@@ -1238,7 +1267,7 @@ invoker.invoke("ServiceModelQuery-dev", payload={
 | `session` | `dict` | Yes | Session dict from `self.session.to_dict()` — drives state-scoped DB routing |
 | `collection` | `str` | Yes | Collection name (must be in `allowed_collections`) |
 | `pipeline` | `list` | One of | MongoDB aggregation pipeline |
-| `filter` | `dict` | One of | MongoDB filter document (defaults to `{}`) |
+| `filter` | `dict` | One of | MongoDB filter document (defaults to `{}`). `_id`/`id` string values are auto-coerced to `ObjectId` |
 | `fields` | `dict` | No | MongoDB projection (only valid with `filter` mode) |
 | `limit` | `int` | No | Max documents to return |
 | `skip` | `int` | No | Documents to skip (default `0`) |

aws_python_helper-0.37.0/PKG-INFO → aws_python_helper-0.38.0/README.md

@@ -1,23 +1,3 @@
-Metadata-Version: 2.4
-Name: aws-python-helper
-Version: 0.37.0
-Summary: AWS Python Helper Framework
-Author-email: Fabian Claros <neufabiae@gmail.com>
-License-Expression: MIT
-Project-URL: Homepage, https://github.com/fabiae/aws-python-framework
-Project-URL: Source Code, https://github.com/fabiae/aws-python-framework
-Project-URL: Bug Tracker, https://github.com/fabiae/aws-python-framework/issues
-Project-URL: Documentation, https://github.com/fabiae/aws-python-framework/blob/main/README.md
-Keywords: aws,python,framework,helper,mongodb,sqs,sns,fargate,lambda
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: motor==3.3.2
-Requires-Dist: pymongo==4.6.1
-Requires-Dist: pydantic>=2.0
-Requires-Dist: httpx>=0.27.0
-
 # AWS Python Framework
 
 Mini-framework to create REST APIs, SQS Consumers, SNS Publishers, Fargate Tasks, and Standalone Lambdas with Python in AWS Lambda.
@@ -1231,6 +1211,35 @@ invoker.invoke("ServiceModelQuery-dev", payload={
 
 **Note:** `pipeline` and `fields` are mutually exclusive — the framework rejects payloads that include both.
 
+#### Querying by `_id`
+
+ObjectId hex strings in `_id` filters are automatically coerced to `ObjectId` so callers can serialize queries as plain JSON:
+
+```python
+# Plain value
+invoker.invoke("ServiceModelQuery-dev", payload={
+    "session": self.session.to_dict(),
+    "collection": "orders",
+    "filter": {"_id": "65f1a2b3c4d5e6f7a8b9c0d1"},
+})
+
+# Operator with list
+invoker.invoke("ServiceModelQuery-dev", payload={
+    "session": self.session.to_dict(),
+    "collection": "orders",
+    "filter": {"_id": {"$in": ["65f1...", "65f2...", "65f3..."]}},
+})
+
+# 'id' is accepted as an alias for '_id'
+invoker.invoke("ServiceModelQuery-dev", payload={
+    "session": self.session.to_dict(),
+    "collection": "orders",
+    "filter": {"id": "65f1a2b3c4d5e6f7a8b9c0d1"},
+})
+```
+
+Supported operators on `_id`: scalar (`$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`) and list (`$in`, `$nin`). The same coercion is applied to `$match` stages inside a `pipeline`. If the string is not a valid 24-char ObjectId hex, the Lambda raises a clear validation error.
+
 ### Payload reference
 
 | Field | Type | Required | Description |
@@ -1238,7 +1247,7 @@ invoker.invoke("ServiceModelQuery-dev", payload={
 | `session` | `dict` | Yes | Session dict from `self.session.to_dict()` — drives state-scoped DB routing |
 | `collection` | `str` | Yes | Collection name (must be in `allowed_collections`) |
 | `pipeline` | `list` | One of | MongoDB aggregation pipeline |
-| `filter` | `dict` | One of | MongoDB filter document (defaults to `{}`) |
+| `filter` | `dict` | One of | MongoDB filter document (defaults to `{}`). `_id`/`id` string values are auto-coerced to `ObjectId` |
 | `fields` | `dict` | No | MongoDB projection (only valid with `filter` mode) |
 | `limit` | `int` | No | Max documents to return |
 | `skip` | `int` | No | Documents to skip (default `0`) |

{aws_python_helper-0.37.0 → aws_python_helper-0.38.0}/aws_python_helper/model_query/base.py

@@ -25,18 +25,67 @@ Caller payload:
         "skip":     0                             # optional, default 0
     }
 
+ObjectId coercion:
+    String values for '_id' (or 'id' as alias) inside `filter` and pipeline
+    `$match` stages are automatically converted to bson.ObjectId. Supports
+    scalar operators ($eq, $ne, $gt, $gte, $lt, $lte) and list operators
+    ($in, $nin). A clear ValueError is raised when the string is not a valid
+    24-char ObjectId hex.
+
+    {"filter": {"_id": "65f1a2b3c4d5e6f7a8b9c0d1"}}
+    {"filter": {"_id": {"$in": ["65f1...", "65f2..."]}}}
+    {"filter": {"id":  "65f1a2b3c4d5e6f7a8b9c0d1"}}  # 'id' is aliased to '_id'
+
 Response (via Lambda base run()):
     {"success": True, "data": [...]}
 """
 
 from typing import Any, List, Optional
+from bson import ObjectId
 from pydantic import BaseModel, ConfigDict, model_validator
 
 from ..lambda_standalone.base import Lambda
 
 
+_OBJECT_ID_SCALAR_OPERATORS = {"$eq", "$ne", "$gt", "$gte", "$lt", "$lte"}
+_OBJECT_ID_LIST_OPERATORS = {"$in", "$nin"}
+
+
+def _coerce_object_id(value: Any) -> Any:
+    """Convert a string (or operator dict) to ObjectId where applicable for an '_id' field."""
+    if isinstance(value, ObjectId):
+        return value
+    if isinstance(value, str):
+        if not ObjectId.is_valid(value):
+            raise ValueError(f"'_id' value '{value}' is not a valid ObjectId")
+        return ObjectId(value)
+    if isinstance(value, dict):
+        coerced = {}
+        for op, op_value in value.items():
+            if op in _OBJECT_ID_LIST_OPERATORS:
+                if not isinstance(op_value, list):
+                    raise ValueError(f"'{op}' value for '_id' must be a list")
+                coerced[op] = [_coerce_object_id(v) for v in op_value]
+            elif op in _OBJECT_ID_SCALAR_OPERATORS:
+                coerced[op] = _coerce_object_id(op_value)
+            else:
+                coerced[op] = op_value
+        return coerced
+    raise ValueError(
+        f"Unsupported type for '_id' filter: {type(value).__name__}"
+    )
+
+
+def _normalize_id_key(d: dict) -> None:
+    """Rename 'id' → '_id' (if no _id present) and coerce its value to ObjectId in-place."""
+    if "id" in d and "_id" not in d:
+        d["_id"] = d.pop("id")
+    if "_id" in d:
+        d["_id"] = _coerce_object_id(d["_id"])
+
+
 class _ModelQuerySchema(BaseModel):
-    model_config = ConfigDict(extra="ignore")
+    model_config = ConfigDict(extra="ignore", arbitrary_types_allowed=True)
 
     collection: str
     filter: Optional[dict] = None
@@ -51,6 +100,16 @@ class _ModelQuerySchema(BaseModel):
             raise ValueError("'fields' cannot be used together with 'pipeline'")
         return self
 
+    @model_validator(mode="after")
+    def _normalize_object_ids(self):
+        if self.filter is not None:
+            _normalize_id_key(self.filter)
+        if self.pipeline is not None:
+            for stage in self.pipeline:
+                if isinstance(stage, dict) and isinstance(stage.get("$match"), dict):
+                    _normalize_id_key(stage["$match"])
+        return self
+
 
 class ModelQueryLambda(Lambda):
     """

aws_python_helper-0.37.0/README.md → aws_python_helper-0.38.0/aws_python_helper.egg-info/PKG-INFO

@@ -1,3 +1,23 @@
+Metadata-Version: 2.4
+Name: aws-python-helper
+Version: 0.38.0
+Summary: AWS Python Helper Framework
+Author-email: Fabian Claros <neufabiae@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/fabiae/aws-python-framework
+Project-URL: Source Code, https://github.com/fabiae/aws-python-framework
+Project-URL: Bug Tracker, https://github.com/fabiae/aws-python-framework/issues
+Project-URL: Documentation, https://github.com/fabiae/aws-python-framework/blob/main/README.md
+Keywords: aws,python,framework,helper,mongodb,sqs,sns,fargate,lambda
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: motor==3.3.2
+Requires-Dist: pymongo==4.6.1
+Requires-Dist: pydantic>=2.0
+Requires-Dist: httpx>=0.27.0
+
 # AWS Python Framework
 
 Mini-framework to create REST APIs, SQS Consumers, SNS Publishers, Fargate Tasks, and Standalone Lambdas with Python in AWS Lambda.
@@ -1211,6 +1231,35 @@ invoker.invoke("ServiceModelQuery-dev", payload={
 
 **Note:** `pipeline` and `fields` are mutually exclusive — the framework rejects payloads that include both.
 
+#### Querying by `_id`
+
+ObjectId hex strings in `_id` filters are automatically coerced to `ObjectId` so callers can serialize queries as plain JSON:
+
+```python
+# Plain value
+invoker.invoke("ServiceModelQuery-dev", payload={
+    "session": self.session.to_dict(),
+    "collection": "orders",
+    "filter": {"_id": "65f1a2b3c4d5e6f7a8b9c0d1"},
+})
+
+# Operator with list
+invoker.invoke("ServiceModelQuery-dev", payload={
+    "session": self.session.to_dict(),
+    "collection": "orders",
+    "filter": {"_id": {"$in": ["65f1...", "65f2...", "65f3..."]}},
+})
+
+# 'id' is accepted as an alias for '_id'
+invoker.invoke("ServiceModelQuery-dev", payload={
+    "session": self.session.to_dict(),
+    "collection": "orders",
+    "filter": {"id": "65f1a2b3c4d5e6f7a8b9c0d1"},
+})
+```
+
+Supported operators on `_id`: scalar (`$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`) and list (`$in`, `$nin`). The same coercion is applied to `$match` stages inside a `pipeline`. If the string is not a valid 24-char ObjectId hex, the Lambda raises a clear validation error.
+
 ### Payload reference
 
 | Field | Type | Required | Description |
@@ -1218,7 +1267,7 @@ invoker.invoke("ServiceModelQuery-dev", payload={
 | `session` | `dict` | Yes | Session dict from `self.session.to_dict()` — drives state-scoped DB routing |
 | `collection` | `str` | Yes | Collection name (must be in `allowed_collections`) |
 | `pipeline` | `list` | One of | MongoDB aggregation pipeline |
-| `filter` | `dict` | One of | MongoDB filter document (defaults to `{}`) |
+| `filter` | `dict` | One of | MongoDB filter document (defaults to `{}`). `_id`/`id` string values are auto-coerced to `ObjectId` |
 | `fields` | `dict` | No | MongoDB projection (only valid with `filter` mode) |
 | `limit` | `int` | No | Max documents to return |
 | `skip` | `int` | No | Documents to skip (default `0`) |

{aws_python_helper-0.37.0 → aws_python_helper-0.38.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "aws-python-helper"
-version = "0.37.0"
+version = "0.38.0"
 description = "AWS Python Helper Framework"
 readme = "README.md"
 requires-python = ">=3.9"