diff --git a/README.md b/README.md index 7aa9e94..63a75e4 100644 --- a/README.md +++ b/README.md @@ -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.8 +mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v0.1.9 ``` Direct: ```bash -pip install "mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v0.1.8" +pip install "mongo @ git+ssh://git@git.rethinkstudios.io/rethink-public/mongo.git@v0.1.9" ``` Requires `motor` and `pymongo` (pulled transitively). -Drop the `@v0.1.8` suffix from the line above to install the latest unpinned. +Drop the `@v0.1.9` suffix from the line above to install the latest unpinned. ## Usage diff --git a/pyproject.toml b/pyproject.toml index 88be7d7..4587cb2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "hatchling.build" [project] name = "mongo" -version = "0.1.8" +version = "0.1.9" description = "async mongodb wrapper over motor with a raw escape hatch" requires-python = ">=3.10" dependencies = [ diff --git a/src/mongo/__init__.py b/src/mongo/__init__.py index 0e32d92..53c3100 100644 --- a/src/mongo/__init__.py +++ b/src/mongo/__init__.py @@ -4,14 +4,8 @@ __all__ = ["MongoDB", "Mongo", "init", "instance"] 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). the - bare-proxy raw escape hatch is `mongo.collection(name)`, not `mongo[name]` — - module-level subscripting isn't a thing in python, so the proxy only forwards - named attributes (an instance's `db[name]` still works fine). - """ + """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}") diff --git a/src/mongo/mongo.py b/src/mongo/mongo.py index c303f44..0bd1dbc 100644 --- a/src/mongo/mongo.py +++ b/src/mongo/mongo.py @@ -1,41 +1,17 @@ """ -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 MongoDB - bot.db = MongoDB(conn_string, database) - await bot.db.connect() # optional: ping to fail-early - await bot.db.get_documents("users", {"active": True}) - bot.db.close() # on shutdown (sync) + db = MongoDB(conn_string, database) + await db.get_documents("users", {"active": True}) - # async with (guaranteed cleanup): - async with MongoDB(conn_string, database) as db: - await db.get_documents("users", {}) +`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. -`Mongo` is a back-compat alias of `MongoDB`; old `Mongo(...)` call sites still work. - -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}) - -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 — the one deliberate - difference from the fail-loud redis/psql/mysql trio, kept 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: - - 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 @@ -52,9 +28,6 @@ class MongoDB: """async mongodb wrapper; one client per process, attach to bot as bot.db""" def __init__(self, connection_string: str, database: str): - # motor builds the client eagerly (no I/O yet); a bad URI raises InvalidURI - # here with nothing built. an invalid db name raises below, after the client - # exists — close it before propagating so it doesn't outlive the raise. self._client = AsyncIOMotorClient(connection_string) try: self._db = self._client[database] @@ -63,11 +36,8 @@ class MongoDB: raise async def connect(self) -> "MongoDB": - """validate the connection with a ping and return self - - optional — motor connects lazily, so this just fails early on a bad - URI/credentials (parallel to the trio's connect()). raises, unlike the - swallowing wrapped methods. + """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 @@ -80,9 +50,8 @@ class MongoDB: try: return await self.connect() except BaseException: - # __aexit__ is not called when __aenter__ raises, so a failed ping here - # would otherwise leak the motor client built in __init__. close it - # before propagating. + # __aexit__ isn't called when __aenter__ raises; close here so the + # client built in __init__ doesn't leak self.close() raise @@ -112,7 +81,7 @@ class MongoDB: 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() # ------------------------------------------------------------------------- @@ -121,8 +90,8 @@ class MongoDB: async def create_collection(self, collection: str, index=None) -> bool: """create a collection, optionally seeding ONE index - `index` is a single index key-spec (e.g. `[("a", 1), ("b", 1)]` builds one - compound index, NOT two); call `create_index` per index for multiples. + `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) @@ -377,7 +346,7 @@ class MongoDB: """$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 + leaves `modified_count=0` - uses `matched_count` so an idempotent no-op isn't misread as a failure. """ try: @@ -392,7 +361,7 @@ class MongoDB: ) -> bool: """apply raw update operators ($set/$inc/$unset/...) to a single document - returns True when a document matched, even if the operators changed nothing — + 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: @@ -406,7 +375,7 @@ class MongoDB: """$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 + identical value leaves `modified_count=0` - mirrors update_document_field's matched_count-over-modified_count contract. """ try: @@ -468,7 +437,7 @@ class MongoDB: """$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`. + nothing was pulled - uses `matched_count`, not `modified_count`. """ try: response = await self._db[collection].update_one(target, {"$pull": {array: value}}) @@ -593,7 +562,7 @@ Mongo = MongoDB # ----------------------------------------------------------------------------- # backwards-compat module proxy: `import mongo; mongo.init(conn, db)` then -# bare `await mongo.func(...)`. needs `import mongo` — `from mongo import func` +# bare `await mongo.func(...)`. needs `import mongo` - `from mongo import func` # resolves at import time, before init() runs. _default: Optional[MongoDB] = None