Compare commits

...

4 Commits
v0.1.2 ... main

Author SHA1 Message Date
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
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
fe8f2da480 fix: annotate database property return type (AsyncIOMotorDatabase)
Signed-off-by: disqualifier <dev@disqualifier.me>
2026-06-29 21:35:22 -04:00
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
5 changed files with 103 additions and 24 deletions

2
.gitignore vendored
View File

@ -1,5 +1,5 @@
# claude # claude
CLAUDE.md .claude/
# python # python
__pycache__/ __pycache__/

View File

@ -8,31 +8,39 @@ helpers for the common paths, with a raw escape hatch for everything else.
`requirements.txt`: `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.4
``` ```
Direct: Direct:
```bash ```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.4"
``` ```
Requires `motor` and `pymongo` (pulled transitively). 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.4` suffix from the line above to install the latest unpinned.
## Usage ## Usage
**Object (preferred)** — one client per process: **Object (preferred)** — one client per process:
```python ```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}) users = await db.get_documents("users", {"active": True})
db.close() # on shutdown (sync) 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: **Module proxy (back-compat)** — arm once, then call bare:
```python ```python
@ -44,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 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. 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 ## Error contract
- **Wrapped methods** log-and-swallow exceptions and return a safe default - **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: - **`db.collection(name)`** (or `db[name]`) returns the raw motor collection:
full driver surface, no swallowing, **raises**. Use it for anything not wrapped full driver surface, no swallowing, **raises**. Use it for anything not wrapped
(`find_one_and_*` beyond what's exposed, change streams, complex bulk ops). (`find_one_and_*` beyond what's exposed, change streams, complex bulk ops).

View File

@ -4,7 +4,7 @@ build-backend = "hatchling.build"
[project] [project]
name = "mongo" name = "mongo"
version = "0.1.2" version = "0.1.4"
description = "async mongodb wrapper over motor with a raw escape hatch" description = "async mongodb wrapper over motor with a raw escape hatch"
requires-python = ">=3.10" requires-python = ">=3.10"
dependencies = [ dependencies = [

View File

@ -1,6 +1,6 @@
from .mongo import Mongo, init, instance from .mongo import MongoDB, Mongo, init, instance
__all__ = ["Mongo", "init", "instance"] __all__ = ["MongoDB", "Mongo", "init", "instance"]
def __getattr__(name: str): def __getattr__(name: str):
@ -13,6 +13,6 @@ def __getattr__(name: str):
can only forward named attributes. on a Mongo instance both `db[name]` and can only forward named attributes. on a Mongo instance both `db[name]` and
`db.collection(name)` work. `db.collection(name)` work.
""" """
if not name.startswith("_") and hasattr(Mongo, name): if not name.startswith("_") and hasattr(MongoDB, name):
return getattr(instance(), name) return getattr(instance(), name)
raise AttributeError(f"module {__name__!r} has no attribute {name!r}") raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

View File

@ -2,11 +2,19 @@
async mongodb wrapper over motor async mongodb wrapper over motor
object (preferred), one client per process: object (preferred), one client per process:
from mongo import Mongo from mongo import MongoDB
bot.db = Mongo(conn_string, database) bot.db = MongoDB(conn_string, database)
await bot.db.connect() # optional: ping to fail-early
await bot.db.get_documents("users", {"active": True}) await bot.db.get_documents("users", {"active": True})
bot.db.close() # on shutdown (sync) bot.db.close() # on shutdown (sync)
# async with (guaranteed cleanup):
async with MongoDB(conn_string, database) as db:
await db.get_documents("users", {})
`Mongo` remains a back-compat alias of `MongoDB` existing `Mongo(...)` call sites keep
working unchanged.
module proxy (back-compat), arm once then call bare: module proxy (back-compat), arm once then call bare:
import mongo # not `from mongo import ...` import mongo # not `from mongo import ...`
mongo.init(conn_string, database) mongo.init(conn_string, database)
@ -16,6 +24,15 @@ errors:
wrapped methods log and swallow, returning a safe default wrapped methods log and swallow, returning a safe default
(False / [] / {} / 0 / None). .collection(name) / db[name] return (False / [] / {} / 0 / None). .collection(name) / db[name] return
the raw motor collection: full driver surface, raises, nothing swallowed. the raw motor collection: full driver surface, raises, nothing swallowed.
NOTE: mongo SWALLOWS by design this is the one deliberate difference from the
newer datastore trio (redis/psql/mysql), which is fail-loud. mongo's contract is
kept as-is so existing consumers' branch-on-result control flow doesn't break.
naming consistency with the trio (all additive old names still work):
- class is `MongoDB` (was `Mongo`, kept as 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()`
notes: notes:
- the proxy needs `import mongo`; `from mongo import func` resolves before init - the proxy needs `import mongo`; `from mongo import func` resolves before init
@ -27,18 +44,34 @@ import logging
from typing import Any, List, Optional from typing import Any, List, Optional
from pymongo import ReturnDocument from pymongo import ReturnDocument
from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorCollection from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorCollection, AsyncIOMotorDatabase
log = logging.getLogger(__name__) log = logging.getLogger(__name__)
class Mongo: class MongoDB:
"""async mongodb wrapper; one client per process, attach to bot as bot.db""" """async mongodb wrapper; one client per process, attach to bot as bot.db"""
def __init__(self, connection_string: str, database: str): def __init__(self, connection_string: str, database: str):
self._client = AsyncIOMotorClient(connection_string) self._client = AsyncIOMotorClient(connection_string)
self._db = self._client[database] self._db = self._client[database]
async def connect(self) -> "MongoDB":
"""validate the connection with a ping and return self
motor connects lazily, so this is optional call it to fail early on a bad
URI/credentials rather than on the first real op (parallel to the trio's
connect()). raises on a bad connection, unlike the swallowing wrapped methods.
"""
await self._client.admin.command("ping")
return self
async def __aenter__(self) -> "MongoDB":
return await self.connect()
async def __aexit__(self, exc_type, exc, tb) -> None:
self.close()
def __getitem__(self, collection: str) -> AsyncIOMotorCollection: def __getitem__(self, collection: str) -> AsyncIOMotorCollection:
"""raw collection access via subscript: bot.db['users'].aggregate(...)""" """raw collection access via subscript: bot.db['users'].aggregate(...)"""
return self._db[collection] return self._db[collection]
@ -48,7 +81,7 @@ class Mongo:
return self._db[name] return self._db[name]
@property @property
def database(self): def database(self) -> AsyncIOMotorDatabase:
"""raw motor database handle""" """raw motor database handle"""
return self._db return self._db
@ -224,6 +257,10 @@ class Mongo:
log.exception(f"db.check_document_exists() on {collection}") log.exception(f"db.check_document_exists() on {collection}")
return False 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: async def count_value_in_array(self, collection: str, array_field: str, value: str) -> int:
"""count documents whose array field contains value""" """count documents whose array field contains value"""
try: try:
@ -361,10 +398,15 @@ class Mongo:
async def document_push_array( async def document_push_array(
self, collection: str, target: dict, array: str, value: Any self, collection: str, target: dict, array: str, value: Any
) -> bool: ) -> 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: try:
response = await self._db[collection].update_one(target, {"$push": {array: value}}) response = await self._db[collection].update_one(target, {"$push": {array: value}})
return response.modified_count > 0 return response.matched_count > 0
except Exception: except Exception:
log.exception(f"db.document_push_array() on {collection}") log.exception(f"db.document_push_array() on {collection}")
return False return False
@ -373,13 +415,17 @@ class Mongo:
self, collection: str, target: dict, array: str, value: Any, self, collection: str, target: dict, array: str, value: Any,
field_to_set: str, set_value: Any, field_to_set: str, set_value: Any,
) -> bool: ) -> 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: try:
response = await self._db[collection].update_one( response = await self._db[collection].update_one(
target, target,
{"$push": {array: value}, "$set": {field_to_set: set_value}}, {"$push": {array: value}, "$set": {field_to_set: set_value}},
) )
return response.modified_count > 0 return response.matched_count > 0
except Exception: except Exception:
log.exception(f"db.document_push_and_set() on {collection}") log.exception(f"db.document_push_and_set() on {collection}")
return False return False
@ -454,6 +500,10 @@ class Mongo:
log.exception(f"db.delete_document() on {collection}") log.exception(f"db.delete_document() on {collection}")
return 0 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: async def delete_documents(self, collection: str, target: dict) -> int:
"""delete all matching documents, returning deleted count""" """delete all matching documents, returning deleted count"""
try: try:
@ -507,6 +557,11 @@ class Mongo:
return False return False
# back-compat alias: the class was historically `Mongo`; existing `Mongo(...)` call
# sites keep working unchanged
Mongo = MongoDB
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
# backwards-compat module proxy # backwards-compat module proxy
# - lets legacy call sites keep using `await mongo.get_documents(...)` # - lets legacy call sites keep using `await mongo.get_documents(...)`
@ -515,17 +570,17 @@ class Mongo:
# - does NOT work with `from mongo import func` (resolved at import, # - does NOT work with `from mongo import func` (resolved at import,
# before init runs) — switch those sites to `import mongo` # before init runs) — switch those sites to `import mongo`
_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""" """arm the module-level default instance and return it"""
global _default global _default
_default = Mongo(connection_string, database) _default = MongoDB(connection_string, database)
return _default return _default
def instance() -> Mongo: def instance() -> MongoDB:
"""return the default instance, raising if init() has not run""" """return the default instance, raising if init() has not run"""
if _default is None: if _default is None:
raise RuntimeError("mongo not initialized; call mongo.init(conn, db) first") raise RuntimeError("mongo not initialized; call mongo.init(conn, db) first")