18 Commits
Author SHA1 Message Date
dsql 0421fc734d chore: bump to 1.1.0 (logging-discipline audit)
Signed-off-by: disqualifier <dev@disqualifier.me>
2026-08-10 23:00:50 -04:00
dsql c6dd2669e4 fix: use lazy %-style interpolation in log calls
38 log calls eagerly interpolated the collection name into an f-string
(log.exception(f"db.method() on {collection}")) - the string was built even when the
log record was filtered out. switch to the lazy form (log.exception("db.method() on %s",
collection)) so interpolation happens only if the record is emitted. no level or handling
change - the swallow-and-default contract and the ERROR+traceback on the swallow path are
unchanged (that level is the D2 ruling: leave as-is).

Signed-off-by: disqualifier <dev@disqualifier.me>
2026-08-09 02:11:25 -04:00
dsql 59c0258aff release: 1.0.0
first stable release. pre-1.0.0 verification complete: all surviving MED regressions and
gaps resolved and independently re-fired, tree audited clean across the suite.

Signed-off-by: disqualifier <dev@disqualifier.me>
2026-07-09 18:53:15 -04:00
dsql d89a91e2d9 refactor: derive __version__ from package metadata (single source)
Signed-off-by: disqualifier <dev@disqualifier.me>
2026-07-03 17:00:03 -04:00
dsql fbd94d6c81 docs: add missing trailing newline to README
Signed-off-by: disqualifier <dev@disqualifier.me>
2026-07-03 16:23:37 -04:00
dsql aedc8f3b84 docs: compress prose/module docstrings, em-dash->hyphen (de-bloat wave 1)
Signed-off-by: disqualifier <dev@disqualifier.me>
2026-07-03 00:14:55 -04:00
dsql 0a68b65937 fix: close the motor client if an invalid db name raises in __init__ (mongo-9)
self._client[database] can raise InvalidName after the client is already
built, leaking it via any exception traceback the caller holds. close it
before re-raising, matching the __aenter__ leak fix. also compresses essay
docstrings/comments across the module with no behavior change, keeping the
swallow-and-default contract note and the matched_count/nInserted footguns.

Signed-off-by: disqualifier <dev@disqualifier.me>
2026-07-02 23:28:04 -04:00
dsql 30f0e44097 fix: correct wrong success predicates in upsert_document_field and create_documents
upsert_document_field returned False for an idempotent no-op upsert on an
existing document (modified_count=0, upserted_id=None) even though the doc
matched the requested state; switch to matched_count like its update_document_field
and update_document_operator siblings.

create_documents returned 0 on a partial insert_many failure, discarding the
BulkWriteError's nInserted count and inviting callers to retry the whole batch
on a wrongly-reported failure, duplicating documents that had already landed.
Catch BulkWriteError specifically and return e.details['nInserted'].

Bump to v0.1.7.

Signed-off-by: disqualifier <dev@disqualifier.me>
2026-07-02 17:22:31 -04:00
dsql 9da851629d fix: rename create_collection indexes->index + doc notes (mongo-3/4/5)
- mongo-3: create_collection param renamed indexes -> index (it seeds ONE index; a key-spec
  builds one compound index, not two). update keyword call sites indexes= -> index=.
- mongo-4: docstring notes an instance is single-use after close() (pymongo 4.x close is
  irreversible; connect() only pings).
- mongo-5: docstring notes construction may raise InvalidURI for a malformed URI.
- README: create_collection index note. bump v0.1.5 -> v0.1.6

Signed-off-by: disqualifier <dev@disqualifier.me>
2026-07-01 00:28:36 -04:00
dsql ebd808f326 fix: async with closes the motor client when connect()/ping fails (mongo-1)
__aenter__ delegated to connect(); when the ping raised on a bad server, __aexit__ was not
called so the eagerly-constructed motor client (with its background topology monitor + pool)
leaked. a retry loop against a flapping DB accumulated live clients. now close-on-failure.
verified: 5 failed async-with blocks leave 0 open clients (was 5). bump v0.1.4 -> v0.1.5

Signed-off-by: disqualifier <dev@disqualifier.me>
2026-06-30 21:04:51 -04:00
dsql e20368287d feat: MongoDB class (Mongo kept as alias) + connect()/async with + exists/delete aliases
additive only — every existing name preserved, swallow contract unchanged. brings mongo
in line with the redis/psql/mysql datastore trio's naming/lifecycle. bump v0.1.3 -> v0.1.4

Signed-off-by: disqualifier <dev@disqualifier.me>
2026-06-29 23:11:11 -04:00
dsql 1d55efbcdd chore: ignore .claude/ dir (CLAUDE.md now lives under .claude/)
Signed-off-by: disqualifier <dev@disqualifier.me>
2026-06-29 21:55:13 -04:00
dsql fe8f2da480 fix: annotate database property return type (AsyncIOMotorDatabase)
Signed-off-by: disqualifier <dev@disqualifier.me>
2026-06-29 21:35:22 -04:00
dsql 9ad3458cf9 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>
2026-06-29 20:48:08 -04:00
dsql 816c71a3f5 docs: pin install line to release, note unpinned-latest option
Signed-off-by: disqualifier <dev@disqualifier.me>
2026-06-29 18:13:56 -04:00
dsql 6103d63b9f docs: show unpinned install line; note tag-pinning for reproducibility
Signed-off-by: disqualifier <dev@disqualifier.me>
2026-06-29 18:07:41 -04:00
dsql 51592567e1 fix: matched_count for idempotent updates; document drop-on-missing-key (v0.1.2)
- update_document_field/update_document_operator/document_pop_array return
  matched_count > 0, so an idempotent write that matched a doc but changed nothing
  ( to the same value,  of an absent value) reports success instead of False
  (L19)
- document the bare-proxy escape hatch is mongo.collection(name) not mongo[name], and
  that get_document_hashmap/get_document_fields skip docs missing the key (nits).

Signed-off-by: disqualifier <dev@disqualifier.me>
2026-06-29 17:58:26 -04:00
dsql 3ceef9c4a8 fix: add check_document_exists; rename do_upsert -> upsert
added check_document_exists(collection, target) -> bool (count_documents(target, limit=1) > 0) — it existed only in the talos origin and was not carried over, but the talos caller relies on it. renamed the do_upsert param to upsert on update_document/find_one_and_update/find_one_and_replace, standardizing on motor's name (the talos caller already passes upsert=). param rename is breaking; patch is fine under the no-consumer policy. bump to v0.1.1.

Signed-off-by: disqualifier <dev@disqualifier.me>
2026-06-29 03:25:17 -04:00
5 changed files with 230 additions and 116 deletions
+1 -1
View File
@@ -1,5 +1,5 @@
# claude
CLAUDE.md
.claude/
# python
__pycache__/
+35 -6
View File
@@ -8,29 +8,39 @@ 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.0
mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v1.0.0
```
Direct:
```bash
pip install "mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v0.1.0"
pip install "mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v1.0.0"
```
Requires `motor` and `pymongo` (pulled transitively).
Drop the `@v1.0.0` suffix from the line above to install the latest unpinned.
## Usage
**Object (preferred)** — one client per process:
```python
from mongo import Mongo
from mongo import MongoDB
db = Mongo(conn_string, database) # attach as bot.db / app.db
db = MongoDB(conn_string, database) # attach as bot.db / app.db
await db.connect() # optional: ping to fail-early on a bad URI
users = await db.get_documents("users", {"active": True})
db.close() # on shutdown (sync)
# or with guaranteed cleanup:
async with MongoDB(conn_string, database) as db:
await db.get_documents("users", {"active": True})
```
The class is `MongoDB`; **`Mongo` remains a back-compat alias** (`Mongo = MongoDB`), so
existing `Mongo(...)` call sites keep working unchanged.
**Module proxy (back-compat)** — arm once, then call bare:
```python
@@ -42,10 +52,26 @@ users = await mongo.get_documents("users", {"active": True})
Both styles share one client. The proxy exists so legacy call sites keep working
after a one-line `init()`; new code should use the object.
## Naming consistency with the datastore trio
mongo predates the `redis`/`psql`/`mysql` trio; this version makes it surface-consistent
**without breaking anything** (all additive, every old name preserved):
- class is **`MongoDB`** (with `Mongo` kept as an alias)
- **`connect()`** + **`async with`** like the trio (motor connects lazily, so `connect()`
just pings to validate early)
- **`exists()`** aliases `check_document_exists()`; **`delete()`** aliases
`delete_document()` — old names still work, the trio-consistent names are now available
The one deliberate difference that remains: **mongo swallows** (see below) where the trio
is **fail-loud**. That's intentional — flipping it would break existing consumers' branch-
on-result control flow.
## Error contract
- **Wrapped methods** log-and-swallow exceptions and return a safe default
(`False` / `[]` / `{}` / `0` / `None`). Branch on the result.
(`False` / `[]` / `{}` / `0` / `None`). Branch on the result. (`connect()` is the
exception — it raises on a bad connection so you can fail-early.)
- **`db.collection(name)`** (or `db[name]`) returns the raw motor collection:
full driver surface, no swallowing, **raises**. Use it for anything not wrapped
(`find_one_and_*` beyond what's exposed, change streams, complex bulk ops).
@@ -61,6 +87,9 @@ are included.
- `from mongo import func` won't see the proxy (resolved at import, before `init`).
Use `import mongo` then `mongo.func(...)`.
- `create_collection(collection, index=...)` seeds **one** index (the param is `index`,
renamed from `indexes` in v0.1.6). A key-spec like `[("a",1),("b",1)]` builds one
compound index, not two — call `create_index` per index for multiples.
- `find_one_and_update` returns the **after** image by default (`return_after=True`).
- `bulk_write` takes pymongo ops the caller builds:
```python
@@ -71,4 +100,4 @@ are included.
## Versioning
Tagged `vX.Y.Z`. Pin the tag in `requirements.txt`; bump deliberately.
Releases are tagged `vX.Y.Z`. The install line above pins a release; drop the `@vX.Y.Z` suffix to install the latest unpinned. Pin deliberately for reproducible installs.
+1 -1
View File
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
[project]
name = "mongo"
version = "0.1.0"
version = "1.1.0"
description = "async mongodb wrapper over motor with a raw escape hatch"
requires-python = ">=3.10"
dependencies = [
+12 -8
View File
@@ -1,14 +1,18 @@
from .mongo import Mongo, init, instance
from importlib.metadata import PackageNotFoundError, version
__all__ = ["Mongo", "init", "instance"]
from .mongo import MongoDB, Mongo, init, instance
__all__ = ["MongoDB", "Mongo", "init", "instance"]
try:
__version__ = version("mongo")
except PackageNotFoundError:
__version__ = "0.0.0+unknown"
def __getattr__(name: str):
"""proxy bare package attribute access to the default instance (PEP 562)
lets `import mongo; await mongo.get_documents(...)` work after init().
`from mongo import func` still won't see this (resolved before init)
"""
if not name.startswith("_") and hasattr(Mongo, name):
"""proxy bare attribute access to the default instance (PEP 562); needs
`import mongo`, not `from mongo import func` (resolved before init)"""
if not name.startswith("_") and hasattr(MongoDB, name):
return getattr(instance(), name)
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+180 -99
View File
@@ -1,43 +1,62 @@
"""
async mongodb wrapper over motor
async mongodb wrapper over motor, with a raw escape hatch for anything not wrapped
object (preferred), one client per process:
from mongo import Mongo
bot.db = Mongo(conn_string, database)
await bot.db.get_documents("users", {"active": True})
bot.db.close() # on shutdown (sync)
from mongo import MongoDB
db = MongoDB(conn_string, database)
await db.get_documents("users", {"active": True})
module proxy (back-compat), arm once then call bare:
import mongo # not `from mongo import ...`
mongo.init(conn_string, database)
await mongo.get_documents("users", {"active": True})
`Mongo` is a back-compat alias of `MongoDB`. A module-proxy path also exists
(`mongo.init(...)` then bare `mongo.func(...)`) - see README for both usage patterns.
errors:
wrapped methods log and swallow, returning a safe default
(False / [] / {} / 0 / None). .collection(name) / db[name] return
the raw motor collection: full driver surface, raises, nothing swallowed.
notes:
- the proxy needs `import mongo`; `from mongo import func` resolves before init
- find_one_and_update returns the after-image by default
- bulk_write takes caller-built pymongo ops (UpdateOne/DeleteOne/...)
errors: wrapped methods log and swallow, returning a safe default (False / [] / {} / 0 /
None). .collection(name) / db[name] return the raw motor collection: full driver surface,
raises, nothing swallowed. mongo SWALLOWS by design, unlike the fail-loud redis/psql/mysql
trio - kept so existing consumers' branch-on-result control flow doesn't break.
"""
import logging
from typing import Any, List, Optional
from pymongo import ReturnDocument
from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorCollection
from pymongo.errors import BulkWriteError
from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorCollection, AsyncIOMotorDatabase
log = logging.getLogger(__name__)
class Mongo:
class MongoDB:
"""async mongodb wrapper; one client per process, attach to bot as bot.db"""
def __init__(self, connection_string: str, database: str):
self._client = AsyncIOMotorClient(connection_string)
try:
self._db = self._client[database]
except BaseException:
self._client.close()
raise
async def connect(self) -> "MongoDB":
"""validate the connection with a ping and return self; raises, unlike the
swallowing wrapped methods
an instance is single-use: pymongo 4.x `close()` is irreversible and
connect() doesn't rebuild the client. construct a fresh MongoDB instead of
reusing one after close()/`async with` exit.
"""
await self._client.admin.command("ping")
return self
async def __aenter__(self) -> "MongoDB":
try:
return await self.connect()
except BaseException:
# __aexit__ isn't called when __aenter__ raises; close here so the
# client built in __init__ doesn't leak
self.close()
raise
async def __aexit__(self, exc_type, exc, tb) -> None:
self.close()
def __getitem__(self, collection: str) -> AsyncIOMotorCollection:
"""raw collection access via subscript: bot.db['users'].aggregate(...)"""
@@ -48,7 +67,7 @@ class Mongo:
return self._db[name]
@property
def database(self):
def database(self) -> AsyncIOMotorDatabase:
"""raw motor database handle"""
return self._db
@@ -62,32 +81,36 @@ class Mongo:
return False
def close(self) -> None:
"""close the client pool on shutdown (sync motor's close() is synchronous)"""
"""close the client pool on shutdown (sync - motor's close() is synchronous)"""
self._client.close()
# -------------------------------------------------------------------------
# collection / index management
async def create_collection(self, collection: str, indexes=None) -> bool:
"""create a collection, optionally seeding an index"""
async def create_collection(self, collection: str, index=None) -> bool:
"""create a collection, optionally seeding ONE index
`index` is a single key-spec (e.g. `[("a", 1), ("b", 1)]` builds one compound
index, not two) - call create_index per index for multiples
"""
try:
await self._db.create_collection(collection)
if indexes:
await self._db[collection].create_index(indexes)
log.info(f"created indexes for {collection}")
if index:
await self._db[collection].create_index(index)
log.info("created index for %s", collection)
return True
except Exception:
log.exception(f"db.create_collection() for {collection}")
log.exception("db.create_collection() for %s", collection)
return False
async def create_index(self, collection: str, index, **kwargs) -> bool:
"""create an index; kwargs pass through (unique=True, name=..., etc)"""
try:
await self._db[collection].create_index(index, **kwargs)
log.info(f"created index for {collection}")
log.info("created index for %s", collection)
return True
except Exception:
log.exception(f"db.create_index() for {collection}")
log.exception("db.create_index() for %s", collection)
return False
async def drop_collection(self, collection: str) -> bool:
@@ -96,7 +119,7 @@ class Mongo:
await self._db.drop_collection(collection)
return True
except Exception:
log.exception(f"db.drop_collection() for {collection}")
log.exception("db.drop_collection() for %s", collection)
return False
async def check_collection_exists(self, collection: str) -> bool:
@@ -104,7 +127,7 @@ class Mongo:
try:
return collection in await self._db.list_collection_names()
except Exception:
log.exception(f"db.check_collection_exists() for {collection}")
log.exception("db.check_collection_exists() for %s", collection)
return False
async def list_collections(self) -> List[str]:
@@ -124,18 +147,27 @@ class Mongo:
await self._db[collection].insert_one(document)
return True
except Exception:
log.exception(f"db.create_document() on {collection}")
log.exception("db.create_document() on %s", collection)
return False
async def create_documents(
self, collection: str, documents: List[dict], ordered: bool = True
) -> int:
"""insert many documents, returning the inserted count"""
"""insert many documents, returning the inserted count
on a partial failure (e.g. ordered=False with one duplicate key) the driver
raises BulkWriteError AFTER inserting the rest; count comes from
`e.details['nInserted']` so a caller retrying on a wrongly-reported 0 doesn't
re-insert documents that already landed.
"""
try:
result = await self._db[collection].insert_many(documents, ordered=ordered)
return len(result.inserted_ids)
except BulkWriteError as e:
log.exception("db.create_documents() on %s", collection)
return e.details.get("nInserted", 0)
except Exception:
log.exception(f"db.create_documents() on {collection}")
log.exception("db.create_documents() on %s", collection)
return 0
# -------------------------------------------------------------------------
@@ -148,7 +180,7 @@ class Mongo:
try:
return await self._db[collection].find_one(target, fields)
except Exception:
log.exception(f"db.get_document() on {collection}")
log.exception("db.get_document() on %s", collection)
return None
async def get_documents(
@@ -159,7 +191,7 @@ class Mongo:
cursor = self._db[collection].find(target, fields)
return [doc async for doc in cursor]
except Exception:
log.exception(f"db.get_documents() on {collection}")
log.exception("db.get_documents() on %s", collection)
return []
async def get_documents_sorted(
@@ -177,27 +209,35 @@ class Mongo:
)
return [doc async for doc in cursor]
except Exception:
log.exception(f"db.get_documents_sorted() on {collection}")
log.exception("db.get_documents_sorted() on %s", collection)
return []
async def get_document_hashmap(self, collection: str, target: dict, key: str) -> dict:
"""return matching documents keyed into a dict by the given field"""
"""return matching documents keyed into a dict by the given field
documents missing `key` are skipped (not in the result); a later document
with a duplicate key value overwrites an earlier one.
"""
try:
cursor = self._db[collection].find(target)
return {doc[key]: doc async for doc in cursor if key in doc}
except Exception:
log.exception(f"db.get_document_hashmap() on {collection}")
log.exception("db.get_document_hashmap() on %s", collection)
return {}
async def get_document_fields(
self, collection: str, target: dict, key: str, fields: Optional[dict] = None
) -> List:
"""return a flat list of one field's value across matching documents"""
"""return a flat list of one field's value across matching documents
documents missing `key` are skipped, so the list length may be smaller than
the match count.
"""
try:
cursor = self._db[collection].find(target, fields)
return [doc[key] async for doc in cursor if key in doc]
except Exception:
log.exception(f"db.get_document_fields() on {collection}")
log.exception("db.get_document_fields() on %s", collection)
return []
async def count_documents(self, collection: str, target: dict) -> int:
@@ -205,15 +245,27 @@ class Mongo:
try:
return await self._db[collection].count_documents(target)
except Exception:
log.exception(f"db.count_documents() on {collection}")
log.exception("db.count_documents() on %s", collection)
return 0
async def check_document_exists(self, collection: str, target: dict) -> bool:
"""return whether at least one document in collection matches target"""
try:
return await self._db[collection].count_documents(target, limit=1) > 0
except Exception:
log.exception("db.check_document_exists() on %s", collection)
return False
async def exists(self, collection: str, target: dict) -> bool:
"""trio-consistent alias of check_document_exists"""
return await self.check_document_exists(collection, target)
async def count_value_in_array(self, collection: str, array_field: str, value: str) -> int:
"""count documents whose array field contains value"""
try:
return await self._db[collection].count_documents({array_field: value})
except Exception:
log.exception(f"db.count_value_in_array() on {collection}")
log.exception("db.count_value_in_array() on %s", collection)
return 0
async def exists_in_array(self, collection: str, array_field: str, value: str) -> bool:
@@ -222,7 +274,7 @@ class Mongo:
doc = await self._db[collection].find_one({array_field: value}, {"_id": 1})
return doc is not None
except Exception:
log.exception(f"db.exists_in_array() on {collection}")
log.exception("db.exists_in_array() on %s", collection)
return False
async def distinct(self, collection: str, field: str, target: Optional[dict] = None) -> List:
@@ -230,7 +282,7 @@ class Mongo:
try:
return await self._db[collection].distinct(field, target or {})
except Exception:
log.exception(f"db.distinct() on {collection}")
log.exception("db.distinct() on %s", collection)
return []
async def run_aggregation(
@@ -241,7 +293,7 @@ class Mongo:
stages = [{"$match": match_filter}, *pipeline] if match_filter else pipeline
return await self._db[collection].aggregate(stages).to_list(length=None)
except Exception:
log.exception(f"db.run_aggregation() on {collection}")
log.exception("db.run_aggregation() on %s", collection)
return []
async def search_documents(
@@ -252,7 +304,7 @@ class Mongo:
cursor = self._db[collection].find(search_query).sort(sort_key, sort_order)
return [doc async for doc in cursor]
except Exception:
log.exception(f"db.search_documents() on {collection}")
log.exception("db.search_documents() on %s", collection)
return []
async def search_indexes(self, collection: str, search_term: str) -> List[dict]:
@@ -264,21 +316,21 @@ class Mongo:
).sort([("score", {"$meta": "textScore"})])
return [doc async for doc in cursor]
except Exception:
log.exception(f"db.search_indexes() on {collection}")
log.exception("db.search_indexes() on %s", collection)
return []
# -------------------------------------------------------------------------
# update
async def update_document(
self, collection: str, target: dict, document: dict, do_upsert: bool = False
self, collection: str, target: dict, document: dict, upsert: bool = False
) -> bool:
"""replace a whole document, optionally upserting"""
try:
response = await self._db[collection].replace_one(target, document, upsert=do_upsert)
response = await self._db[collection].replace_one(target, document, upsert=upsert)
return bool(response.matched_count or response.upserted_id)
except Exception:
log.exception(f"db.update_document() on {collection}")
log.exception("db.update_document() on %s", collection)
return False
async def update_documents(self, collection: str, target: dict, values: dict) -> int:
@@ -287,38 +339,52 @@ class Mongo:
response = await self._db[collection].update_many(target, values)
return response.modified_count
except Exception:
log.exception(f"db.update_documents() on {collection}")
log.exception("db.update_documents() on %s", collection)
return 0
async def update_document_field(self, collection: str, target: dict, updates: dict) -> bool:
"""$set one or more fields on a single document"""
"""$set one or more fields on a single document
returns True when a document matched, even if `$set` to an identical value
leaves `modified_count=0` - uses `matched_count` so an idempotent no-op isn't
misread as a failure.
"""
try:
response = await self._db[collection].update_one(target, {"$set": updates})
return response.modified_count > 0
return response.matched_count > 0
except Exception:
log.exception(f"db.update_document_field() on {collection}")
log.exception("db.update_document_field() on %s", collection)
return False
async def update_document_operator(
self, collection: str, target: dict, update_query: dict
) -> bool:
"""apply raw update operators ($set/$inc/$unset/...) to a single document"""
"""apply raw update operators ($set/$inc/$unset/...) to a single document
returns True when a document matched, even if the operators changed nothing -
uses `matched_count` so an idempotent write isn't misread as a failure.
"""
try:
response = await self._db[collection].update_one(target, update_query)
return response.modified_count > 0
return response.matched_count > 0
except Exception:
log.exception(f"db.update_document_operator() on {collection}")
log.exception("db.update_document_operator() on %s", collection)
return False
async def upsert_document_field(self, collection: str, target: dict, updates: dict) -> bool:
"""$set fields on a single document, creating it if absent"""
"""$set fields on a single document, creating it if absent
returns True when a document matched or was upserted, even if `$set` to an
identical value leaves `modified_count=0` - mirrors update_document_field's
matched_count-over-modified_count contract.
"""
try:
response = await self._db[collection].update_one(
target, {"$set": updates}, upsert=True
)
return bool(response.modified_count or response.upserted_id)
return bool(response.matched_count or response.upserted_id)
except Exception:
log.exception(f"db.upsert_document_field() on {collection}")
log.exception("db.upsert_document_field() on %s", collection)
return False
async def update_documents_pipeline(
@@ -329,76 +395,87 @@ class Mongo:
response = await self._db[collection].update_many(target, pipeline)
return response.modified_count
except Exception:
log.exception(f"db.update_documents_pipeline() on {collection}")
log.exception("db.update_documents_pipeline() on %s", collection)
return 0
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; $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}")
log.exception("db.document_push_array() on %s", collection)
return False
async def document_push_and_set(
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 (matched_count, not modified_count).
"""
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}")
log.exception("db.document_push_and_set() on %s", collection)
return False
async def document_pop_array(
self, collection: str, target: dict, array: str, value: Any
) -> bool:
"""$pull a value from an array field"""
"""$pull a value from an array field
returns True when a document matched, even if the value was absent and
nothing was pulled - uses `matched_count`, not `modified_count`.
"""
try:
response = await self._db[collection].update_one(target, {"$pull": {array: value}})
return response.modified_count > 0
return response.matched_count > 0
except Exception:
log.exception(f"db.document_pop_array() on {collection}")
log.exception("db.document_pop_array() on %s", collection)
return False
async def find_one_and_update(
self, collection: str, target: dict, update: dict,
return_after: bool = True, do_upsert: bool = False, fields: Optional[dict] = None,
return_after: bool = True, upsert: bool = False, fields: Optional[dict] = None,
) -> Optional[dict]:
"""atomically update one doc and return it (after-image by default)"""
try:
return await self._db[collection].find_one_and_update(
target, update,
projection=fields,
upsert=do_upsert,
upsert=upsert,
return_document=ReturnDocument.AFTER if return_after else ReturnDocument.BEFORE,
)
except Exception:
log.exception(f"db.find_one_and_update() on {collection}")
log.exception("db.find_one_and_update() on %s", collection)
return None
async def find_one_and_replace(
self, collection: str, target: dict, document: dict,
return_after: bool = True, do_upsert: bool = False, fields: Optional[dict] = None,
return_after: bool = True, upsert: bool = False, fields: Optional[dict] = None,
) -> Optional[dict]:
"""atomically replace one doc and return it (after-image by default)"""
try:
return await self._db[collection].find_one_and_replace(
target, document,
projection=fields,
upsert=do_upsert,
upsert=upsert,
return_document=ReturnDocument.AFTER if return_after else ReturnDocument.BEFORE,
)
except Exception:
log.exception(f"db.find_one_and_replace() on {collection}")
log.exception("db.find_one_and_replace() on %s", collection)
return None
async def find_one_and_delete(
@@ -408,7 +485,7 @@ class Mongo:
try:
return await self._db[collection].find_one_and_delete(target, projection=fields)
except Exception:
log.exception(f"db.find_one_and_delete() on {collection}")
log.exception("db.find_one_and_delete() on %s", collection)
return None
# -------------------------------------------------------------------------
@@ -420,26 +497,29 @@ class Mongo:
response = await self._db[collection].delete_one(target)
return response.deleted_count
except Exception:
log.exception(f"db.delete_document() on {collection}")
log.exception("db.delete_document() on %s", collection)
return 0
async def delete(self, collection: str, target: dict) -> int:
"""trio-consistent alias of delete_document (single-document delete)"""
return await self.delete_document(collection, target)
async def delete_documents(self, collection: str, target: dict) -> int:
"""delete all matching documents, returning deleted count"""
try:
response = await self._db[collection].delete_many(target)
return response.deleted_count
except Exception:
log.exception(f"db.delete_documents() on {collection}")
log.exception("db.delete_documents() on %s", collection)
return 0
# -------------------------------------------------------------------------
# bulk / checks
async def bulk_write(self, collection: str, operations: list, ordered: bool = True) -> dict:
"""
run a batch of pymongo write ops (InsertOne/UpdateOne/DeleteOne/...)
"""run a batch of pymongo write ops (InsertOne/UpdateOne/DeleteOne/...)
caller builds the ops from pymongo, e.g.:
caller builds the ops, e.g.:
from pymongo import UpdateOne
ops = [UpdateOne({'_id': i}, {'$set': {...}}, upsert=True) for i in ids]
returns a summary dict of counts, or an empty dict on failure
@@ -454,14 +534,13 @@ class Mongo:
"upserted": result.upserted_count,
}
except Exception:
log.exception(f"db.bulk_write() on {collection}")
log.exception("db.bulk_write() on %s", collection)
return {}
async def document_check_multi(
self, collection: str, target: dict, checks: List[str], value: str
) -> bool:
"""
return whether a doc matching target has value in any of the given arrays
"""return whether a doc matching target has value in any of the given arrays
target is a normal filter dict (merged into the query), not a bare _id
"""
@@ -472,29 +551,31 @@ class Mongo:
}
return await self._db[collection].find_one(query) is not None
except Exception:
log.exception(f"db.document_check_multi() on {collection}")
log.exception("db.document_check_multi() on %s", collection)
return False
# back-compat alias: the class was historically `Mongo`; existing `Mongo(...)` call
# sites keep working unchanged
Mongo = MongoDB
# -----------------------------------------------------------------------------
# backwards-compat module proxy
# - lets legacy call sites keep using `await mongo.get_documents(...)`
# without an object, after a one-time `mongo.init(conn, db)`
# - works with `import mongo; mongo.func(...)` (resolved at call time)
# - does NOT work with `from mongo import func` (resolved at import,
# before init runs) — switch those sites to `import mongo`
# backwards-compat module proxy: `import mongo; mongo.init(conn, db)` then
# bare `await mongo.func(...)`. needs `import mongo` - `from mongo import func`
# resolves at import time, before init() runs.
_default: Optional[Mongo] = None
_default: Optional[MongoDB] = None
def init(connection_string: str, database: str) -> Mongo:
def init(connection_string: str, database: str) -> MongoDB:
"""arm the module-level default instance and return it"""
global _default
_default = Mongo(connection_string, database)
_default = MongoDB(connection_string, database)
return _default
def instance() -> Mongo:
def instance() -> MongoDB:
"""return the default instance, raising if init() has not run"""
if _default is None:
raise RuntimeError("mongo not initialized; call mongo.init(conn, db) first")