fix: align push helpers to matched_count for success-contract consistency (v0.1.3)
mongo-1: document_push_array and document_push_and_set still returned modified_count>0 while the v0.1.2 wave moved the sibling single-doc update helpers to matched_count>0. $push always mutates so the two agree in practice (no reachable behavioral change), but the helpers now match the documented 'True when a document matched' contract uniformly. sibling-grep: zero consumers of either push helper. Signed-off-by: disqualifier <dev@disqualifier.me>
This commit is contained in:
parent
816c71a3f5
commit
9ad3458cf9
@ -8,18 +8,18 @@ helpers for the common paths, with a raw escape hatch for everything else.
|
||||
`requirements.txt`:
|
||||
|
||||
```
|
||||
mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v0.1.2
|
||||
mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v0.1.3
|
||||
```
|
||||
|
||||
Direct:
|
||||
|
||||
```bash
|
||||
pip install "mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v0.1.2"
|
||||
pip install "mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v0.1.3"
|
||||
```
|
||||
|
||||
Requires `motor` and `pymongo` (pulled transitively).
|
||||
|
||||
Drop the `@v0.1.2` suffix from the line above to install the latest unpinned.
|
||||
Drop the `@v0.1.3` suffix from the line above to install the latest unpinned.
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "mongo"
|
||||
version = "0.1.2"
|
||||
version = "0.1.3"
|
||||
description = "async mongodb wrapper over motor with a raw escape hatch"
|
||||
requires-python = ">=3.10"
|
||||
dependencies = [
|
||||
|
||||
@ -361,10 +361,15 @@ class Mongo:
|
||||
async def document_push_array(
|
||||
self, collection: str, target: dict, array: str, value: Any
|
||||
) -> bool:
|
||||
"""$push a value onto an array field"""
|
||||
"""$push a value onto an array field
|
||||
|
||||
returns True when a document matched (consistent with the other single-doc
|
||||
update helpers); $push always mutates, so matched_count and modified_count
|
||||
agree here in practice.
|
||||
"""
|
||||
try:
|
||||
response = await self._db[collection].update_one(target, {"$push": {array: value}})
|
||||
return response.modified_count > 0
|
||||
return response.matched_count > 0
|
||||
except Exception:
|
||||
log.exception(f"db.document_push_array() on {collection}")
|
||||
return False
|
||||
@ -373,13 +378,17 @@ class Mongo:
|
||||
self, collection: str, target: dict, array: str, value: Any,
|
||||
field_to_set: str, set_value: Any,
|
||||
) -> bool:
|
||||
"""$push to an array and $set a field in one update"""
|
||||
"""$push to an array and $set a field in one update
|
||||
|
||||
returns True when a document matched (consistent with the other single-doc
|
||||
update helpers).
|
||||
"""
|
||||
try:
|
||||
response = await self._db[collection].update_one(
|
||||
target,
|
||||
{"$push": {array: value}, "$set": {field_to_set: set_value}},
|
||||
)
|
||||
return response.modified_count > 0
|
||||
return response.matched_count > 0
|
||||
except Exception:
|
||||
log.exception(f"db.document_push_and_set() on {collection}")
|
||||
return False
|
||||
|
||||
Loading…
Reference in New Issue
Block a user