MongoDB/PyMongo: Naming things

Use `PyMongoCrateDBAdapter`, with capitalized "DB".
crate · Jul 6, 2024 · f808598 · f808598
1 parent 44aba7a
commit f808598
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 15 deletions.
diff --git a/cratedb_toolkit/adapter/pymongo/README.md b/cratedb_toolkit/adapter/pymongo/README.md
@@ -16,11 +16,12 @@ docker run --rm -it --name=cratedb \
 
 
 ## Synopsis
+
 ```python
 import pymongo
-from cratedb_toolkit.adapter.pymongo import PyMongoCrateDbAdapter
+from cratedb_toolkit.adapter.pymongo import PyMongoCrateDBAdapter
 
-with PyMongoCrateDbAdapter(dburi="crate://crate@localhost:4200"):
+with PyMongoCrateDBAdapter(dburi="crate://crate@localhost:4200"):
     client = pymongo.MongoClient("localhost", 27017)
     collection = client.foo.bar
 

diff --git a/cratedb_toolkit/adapter/pymongo/__init__.py b/cratedb_toolkit/adapter/pymongo/__init__.py
@@ -1 +1 @@
-from .api import PyMongoCrateDbAdapter  # noqa: F401
+from .api import PyMongoCrateDBAdapter  # noqa: F401
diff --git a/cratedb_toolkit/adapter/pymongo/api.py b/cratedb_toolkit/adapter/pymongo/api.py
@@ -10,7 +10,7 @@
 patch_types_map()
 
 
-class PyMongoCrateDbAdapter:
+class PyMongoCrateDBAdapter:
     """
     Patch PyMongo to talk to CrateDB.
     """

diff --git a/examples/pymongo_adapter.py b/examples/pymongo_adapter.py
@@ -31,7 +31,7 @@
 import pymongo
 from pymongo.database import Database
 
-from cratedb_toolkit.adapter.pymongo import PyMongoCrateDbAdapter
+from cratedb_toolkit.adapter.pymongo import PyMongoCrateDBAdapter
 from cratedb_toolkit.util.common import setup_logging
 
 logger = logging.getLogger(__name__)
@@ -109,7 +109,7 @@ def main(dburi: str = None):
     setup_logging(level=logging.INFO, width=20)
 
     # Context manager use.
-    with PyMongoCrateDbAdapter(dburi=dburi):
+    with PyMongoCrateDBAdapter(dburi=dburi):
         mongodb_workload()
 
 

diff --git a/tests/adapter/test_pymongo.py b/tests/adapter/test_pymongo.py
@@ -12,7 +12,7 @@
 
 check_sqlalchemy1(allow_module_level=True)
 
-from cratedb_toolkit.adapter.pymongo import PyMongoCrateDbAdapter
+from cratedb_toolkit.adapter.pymongo import PyMongoCrateDBAdapter
 from cratedb_toolkit.adapter.pymongo.util import AmendedObjectId
 from cratedb_toolkit.util.date import truncate_milliseconds
 from tests.conftest import TESTDRIVE_DATA_SCHEMA
@@ -25,7 +25,7 @@ def pymongo_cratedb(cratedb):
     """
     Enable the PyMongo -> CrateDB adapter.
     """
-    with PyMongoCrateDbAdapter(dburi=cratedb.database.dburi) as adapter:
+    with PyMongoCrateDBAdapter(dburi=cratedb.database.dburi) as adapter:
         yield adapter
 
 
@@ -53,7 +53,7 @@ def refresh():
     return refresh
 
 
-def test_pymongo_metadata(pymongo_cratedb: PyMongoCrateDbAdapter, pymongo_client: pymongo.MongoClient):
+def test_pymongo_metadata(pymongo_cratedb: PyMongoCrateDBAdapter, pymongo_client: pymongo.MongoClient):
     """
     Verify attribute access to the database and collection handles works well.
     """
@@ -69,7 +69,7 @@ def test_pymongo_metadata(pymongo_cratedb: PyMongoCrateDbAdapter, pymongo_client
 
 
 def test_pymongo_insert_one_single(
-    pymongo_cratedb: PyMongoCrateDbAdapter,
+    pymongo_cratedb: PyMongoCrateDBAdapter,
     pymongo_client: pymongo.MongoClient,
     cratedb: CrateDBTestAdapter,
     sync_writes,
@@ -95,7 +95,7 @@ def test_pymongo_insert_one_single(
 
 
 def test_pymongo_insert_one_multiple(
-    pymongo_cratedb: PyMongoCrateDbAdapter,
+    pymongo_cratedb: PyMongoCrateDBAdapter,
     pymongo_client: pymongo.MongoClient,
     cratedb: CrateDBTestAdapter,
     sync_writes,
@@ -125,7 +125,7 @@ def test_pymongo_insert_one_multiple(
 
 
 def test_pymongo_insert_many(
-    pymongo_cratedb: PyMongoCrateDbAdapter,
+    pymongo_cratedb: PyMongoCrateDBAdapter,
     pymongo_client: pymongo.MongoClient,
     cratedb: CrateDBTestAdapter,
     sync_writes,
@@ -154,7 +154,7 @@ def test_pymongo_insert_many(
 
 
 def test_pymongo_count_documents(
-    pymongo_cratedb: PyMongoCrateDbAdapter,
+    pymongo_cratedb: PyMongoCrateDBAdapter,
     pymongo_client: pymongo.MongoClient,
     cratedb: CrateDBTestAdapter,
     sync_writes,
@@ -180,7 +180,7 @@ def test_pymongo_count_documents(
 
 
 def test_pymongo_roundtrip_document(
-    pymongo_cratedb: PyMongoCrateDbAdapter,
+    pymongo_cratedb: PyMongoCrateDBAdapter,
     pymongo_client: pymongo.MongoClient,
     cratedb: CrateDBTestAdapter,
     sync_writes,
@@ -240,7 +240,7 @@ def test_example_program(cratedb: CrateDBTestAdapter):
 
 
 def test_pymongo_tutorial(
-    pymongo_cratedb: PyMongoCrateDbAdapter,
+    pymongo_cratedb: PyMongoCrateDBAdapter,
     pymongo_client: pymongo.MongoClient,
     cratedb: CrateDBTestAdapter,
     sync_writes,