1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
|
# Copyright 2023-present MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Test that each file in mypy_fails/ actually fails mypy, and test some
sample client code that uses Motor typings.
"""
import unittest
from test.asyncio_tests import AsyncIOTestCase, asyncio_test
from typing import TYPE_CHECKING, Any, Callable, Dict, List, Mapping, TypeVar, Union, cast
from bson import CodecOptions
from bson.raw_bson import RawBSONDocument
from bson.son import SON
from pymongo import ASCENDING
from pymongo.operations import DeleteOne, InsertOne, ReplaceOne
from pymongo.read_preferences import ReadPreference
from motor.motor_asyncio import AsyncIOMotorClient
try:
from bson import ObjectId
from typing_extensions import NotRequired, TypedDict
class Movie(TypedDict):
name: str
year: int
class MovieWithId(TypedDict):
_id: ObjectId
name: str
year: int
class ImplicitMovie(TypedDict):
_id: NotRequired[ObjectId]
name: str
year: int
except ImportError:
Movie = dict # type:ignore[misc,assignment]
ImplicitMovie = dict # type: ignore[assignment,misc]
MovieWithId = dict # type: ignore[assignment,misc]
TypedDict = None
NotRequired = None # type: ignore[assignment]
FuncT = TypeVar("FuncT", bound=Callable[..., Any])
def only_type_check(func: FuncT) -> FuncT:
def inner(*args: Any, **kwargs: Any) -> Any:
if not TYPE_CHECKING:
raise unittest.SkipTest("Used for Type Checking Only")
func(*args, **kwargs)
return cast(FuncT, inner)
class TestMotor(AsyncIOTestCase):
cx: AsyncIOMotorClient
@asyncio_test # type:ignore[misc]
async def test_insert_find(self) -> None:
doc = {"my": "doc"}
coll = self.collection
coll2 = self.cx.test.test2
result = await coll.insert_one(doc)
self.assertEqual(result.inserted_id, doc["_id"])
retrieved = await coll.find_one({"_id": doc["_id"]})
if retrieved:
# Documents returned from find are mutable.
retrieved["new_field"] = 1
result2 = await coll2.insert_one(retrieved)
self.assertEqual(result2.inserted_id, result.inserted_id)
@asyncio_test # type:ignore[misc]
async def test_cursor_to_list(self) -> None:
await self.collection.insert_one({})
cursor = self.collection.find()
docs = await cursor.to_list(None)
self.assertTrue(docs)
@asyncio_test # type:ignore[misc]
async def test_get_collection(self) -> None:
coll = self.db.get_collection("test_collection")
self.assertEqual(coll.name, "test_collection")
@asyncio_test # type:ignore[misc]
async def test_get_database(self) -> None:
db1 = self.cx.get_database("test_database")
db2 = self.cx["test_database"]
self.assertEqual(db1.client, db2.client)
@asyncio_test # type:ignore[misc]
async def test_find_one(self) -> None:
c: AsyncIOMotorClient[Movie] = self.asyncio_client()
coll = c[self.db.name]["movies"]
await coll.insert_one(Movie(name="American Graffiti", year=1973))
result = await coll.find_one({})
assert result is not None
self.assertEqual(result["year"], 1973)
@only_type_check
@asyncio_test # type:ignore[misc]
async def test_bulk_write(self) -> None:
await self.collection.insert_one({})
coll = self.collection
requests: List[InsertOne[Movie]] = [InsertOne(Movie(name="American Graffiti", year=1973))]
result_one = await coll.bulk_write(requests)
self.assertTrue(result_one.acknowledged)
new_requests: List[Union[InsertOne[Movie], ReplaceOne[Movie]]] = []
input_list: List[Union[InsertOne[Movie], ReplaceOne[Movie]]] = [
InsertOne(Movie(name="American Graffiti", year=1973)),
ReplaceOne({}, Movie(name="American Graffiti", year=1973)),
]
for i in input_list:
new_requests.append(i)
result_two = await coll.bulk_write(new_requests)
self.assertTrue(result_two.acknowledged)
# Because ReplaceOne is not generic, type checking is not enforced for ReplaceOne in the first example.
@only_type_check
@asyncio_test # type:ignore[misc]
async def test_bulk_write_heterogeneous(self) -> None:
coll = self.collection
requests: List[Union[InsertOne[Movie], ReplaceOne, DeleteOne]] = [
InsertOne(Movie(name="American Graffiti", year=1973)),
ReplaceOne({}, {"name": "American Graffiti", "year": "WRONG_TYPE"}),
DeleteOne({}),
]
result_one = await coll.bulk_write(requests)
self.assertTrue(result_one.acknowledged)
requests_two: List[Union[InsertOne[Movie], ReplaceOne[Movie], DeleteOne]] = [
InsertOne(Movie(name="American Graffiti", year=1973)),
ReplaceOne(
{},
{"name": "American Graffiti", "year": "WRONG_TYPE"}, # type:ignore[typeddict-item]
),
DeleteOne({}),
]
result_two = await coll.bulk_write(requests_two)
self.assertTrue(result_two.acknowledged)
@asyncio_test # type:ignore[misc]
async def test_command(self) -> None:
result: Dict = await self.cx.admin.command("ping")
result.items()
@asyncio_test # type:ignore[misc]
async def test_list_collections(self) -> None:
cursor = await self.cx.test.list_collections()
value: Mapping[str, Any] = await cursor.next()
value.items()
@asyncio_test # type:ignore[misc]
async def test_list_databases(self) -> None:
cursor = await self.cx.list_databases()
value: Mapping[str, Any] = await cursor.next()
value.items()
@asyncio_test # type:ignore[misc]
async def test_default_document_type(self) -> None:
client = self.asyncio_client()
self.addCleanup(client.close)
coll = client.test.test
doc = {"my": "doc"}
await coll.insert_one(doc)
retrieved = await coll.find_one({"_id": doc["_id"]})
assert retrieved is not None
retrieved["a"] = 1
@asyncio_test # type:ignore[misc]
async def test_aggregate_pipeline(self) -> None:
coll3 = self.cx.test.test3
await coll3.insert_many(
[
{"x": 1, "tags": ["dog", "cat"]},
{"x": 2, "tags": ["cat"]},
{"x": 2, "tags": ["mouse", "cat", "dog"]},
{"x": 3, "tags": []},
]
)
class mydict(Dict[str, Any]):
pass
result = coll3.aggregate(
[
mydict({"$unwind": "$tags"}),
{"$group": {"_id": "$tags", "count": {"$sum": 1}}},
{"$sort": SON([("count", -1), ("_id", -1)])},
]
)
self.assertTrue(len([doc async for doc in result]))
@asyncio_test # type:ignore[misc]
async def test_with_transaction(self) -> None:
async def execute_transaction(session: Any) -> None:
pass
async with await self.cx.start_session() as session:
await session.with_transaction(
execute_transaction, read_preference=ReadPreference.PRIMARY
)
class TestDocumentType(AsyncIOTestCase):
@only_type_check
async def test_default(self) -> None:
client: AsyncIOMotorClient = AsyncIOMotorClient()
coll = client.test.test
retrieved = await coll.find_one({"_id": "foo"})
assert retrieved is not None
retrieved["a"] = 1
@only_type_check
async def test_explicit_document_type(self) -> None:
client: AsyncIOMotorClient[Dict[str, Any]] = AsyncIOMotorClient()
coll = client.test.test
retrieved = await coll.find_one({"_id": "foo"})
assert retrieved is not None
retrieved["a"] = 1
@only_type_check
async def test_typeddict_document_type(self) -> None:
client: AsyncIOMotorClient[Movie] = AsyncIOMotorClient()
coll = client.test.test
retrieved = await coll.find_one({"_id": "foo"})
assert retrieved is not None
assert retrieved["year"] == 1
assert retrieved["name"] == "a"
@only_type_check
async def test_typeddict_document_type_insertion(self) -> None:
client: AsyncIOMotorClient[Movie] = AsyncIOMotorClient()
coll = client.test.test
mov = {"name": "THX-1138", "year": 1971}
movie = Movie(name="THX-1138", year=1971)
await coll.insert_one(mov) # type: ignore[arg-type]
await coll.insert_one(
{"name": "THX-1138", "year": 1971}
) # This will work because it is in-line.
await coll.insert_one(movie)
await coll.insert_many([mov]) # type: ignore[list-item]
await coll.insert_many([movie])
bad_mov = {"name": "THX-1138", "year": "WRONG TYPE"}
bad_movie = Movie(name="THX-1138", year="WRONG TYPE") # type: ignore[typeddict-item]
await coll.insert_one(bad_mov) # type:ignore[arg-type]
await coll.insert_one({"name": "THX-1138", "year": "WRONG TYPE"}) # type: ignore[typeddict-item]
await coll.insert_one(bad_movie)
await coll.insert_many([bad_mov]) # type: ignore[list-item]
await coll.insert_many(
[{"name": "THX-1138", "year": "WRONG TYPE"}] # type: ignore[typeddict-item]
)
await coll.insert_many([bad_movie])
@only_type_check
async def test_bulk_write_document_type_insertion(self) -> None:
client: AsyncIOMotorClient[MovieWithId] = AsyncIOMotorClient()
coll = client.test.test
await coll.bulk_write(
[InsertOne(Movie({"name": "THX-1138", "year": 1971}))] # type:ignore[arg-type]
)
mov_dict = {"_id": ObjectId(), "name": "THX-1138", "year": 1971}
await coll.bulk_write(
[InsertOne(mov_dict)] # type:ignore[arg-type]
)
await coll.bulk_write(
[
InsertOne({"_id": ObjectId(), "name": "THX-1138", "year": 1971})
] # No error because it is in-line.
)
@only_type_check
async def test_bulk_write_document_type_replacement(self) -> None:
client: AsyncIOMotorClient[MovieWithId] = AsyncIOMotorClient()
coll = client.test.test
await coll.bulk_write(
[ReplaceOne({}, Movie({"name": "THX-1138", "year": 1971}))] # type:ignore[arg-type]
)
mov_dict = {"_id": ObjectId(), "name": "THX-1138", "year": 1971}
await coll.bulk_write(
[ReplaceOne({}, mov_dict)] # type:ignore[arg-type]
)
await coll.bulk_write(
[
ReplaceOne({}, {"_id": ObjectId(), "name": "THX-1138", "year": 1971})
] # No error because it is in-line.
)
@only_type_check
async def test_raw_bson_document_type(self) -> None:
client = AsyncIOMotorClient(document_class=RawBSONDocument)
coll = client.test.test
retrieved = await coll.find_one({"_id": "foo"})
assert retrieved is not None
assert len(retrieved.raw) > 0
@only_type_check
async def test_son_document_type(self) -> None:
client = AsyncIOMotorClient(document_class=SON[str, Any])
coll = client.test.test
retrieved = await coll.find_one({"_id": "foo"})
assert retrieved is not None
retrieved["a"] = 1
def test_son_document_type_runtime(self) -> None:
AsyncIOMotorClient(document_class=SON[str, Any], connect=False)
@only_type_check
async def test_create_index(self) -> None:
client: AsyncIOMotorClient[Dict[str, str]] = AsyncIOMotorClient("test")
db = client.test
async with await client.start_session() as session:
index = await db.test.create_index(
[("user_id", ASCENDING)], unique=True, session=session
)
assert isinstance(index, str)
@only_type_check
def test_typeddict_explicit_document_type(self) -> None:
out = MovieWithId(_id=ObjectId(), name="THX-1138", year=1971)
assert out is not None
# This should fail because the output is a Movie.
assert out["foo"] # type:ignore[typeddict-item]
assert bool(out["_id"])
# This should work the same as the test above, but this time using NotRequired to allow
# automatic insertion of the _id field by insert_one.
@only_type_check
def test_typeddict_not_required_document_type(self) -> None:
out = ImplicitMovie(name="THX-1138", year=1971)
assert out is not None
# This should fail because the output is a Movie.
assert out["foo"] # type:ignore[typeddict-item]
# pyright gives reportTypedDictNotRequiredAccess for the following:
assert bool(out["_id"])
@only_type_check
def test_typeddict_empty_document_type(self) -> None:
out = Movie(name="THX-1138", year=1971)
assert out is not None
# This should fail because the output is a Movie.
assert out["foo"] # type:ignore[typeddict-item]
# This should fail because _id is not included in our TypedDict definition.
assert out["_id"] # type:ignore[typeddict-item]
class TestCommandDocumentType(AsyncIOTestCase):
@only_type_check
async def test_default(self) -> None:
client: AsyncIOMotorClient = AsyncIOMotorClient()
result: Dict = await client.admin.command("ping")
result["a"] = 1
@only_type_check
async def test_explicit_document_type(self) -> None:
client: AsyncIOMotorClient = AsyncIOMotorClient()
codec_options: CodecOptions[Dict[str, Any]] = CodecOptions()
result = await client.admin.command("ping", codec_options=codec_options)
result["a"] = 1
@only_type_check
async def test_typeddict_document_type(self) -> None:
client: AsyncIOMotorClient = AsyncIOMotorClient()
codec_options: CodecOptions[Movie] = CodecOptions()
result = await client.admin.command("ping", codec_options=codec_options)
assert result["year"] == 1
assert result["name"] == "a"
@only_type_check
async def test_raw_bson_document_type(self) -> None:
client: AsyncIOMotorClient = AsyncIOMotorClient()
codec_options = CodecOptions(RawBSONDocument)
result = await client.admin.command(
"ping", codec_options=codec_options
) # Fix once @overload for command works
assert len(result.raw) > 0
@only_type_check
async def test_son_document_type(self) -> None:
client: AsyncIOMotorClient[SON[str, Any]] = AsyncIOMotorClient(document_class=SON[str, Any])
codec_options = CodecOptions(SON[str, Any])
result = await client.admin.command("ping", codec_options=codec_options)
result["a"] = 1
if __name__ == "__main__":
unittest.main()
|