forked from mongodb/mongo-python-driver
/
test_mypy.py
539 lines (455 loc) · 19.6 KB
/
test_mypy.py
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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
# Copyright 2020-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 PyMongo typings."""
import os
import tempfile
import unittest
from typing import TYPE_CHECKING, Any, Dict, Iterable, Iterator, List, Union
try:
from typing_extensions import NotRequired, TypedDict
from bson import ObjectId
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 as exc:
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]
try:
from mypy import api
except ImportError:
api = None # type: ignore[assignment]
from test import IntegrationTest
from test.utils import rs_or_single_client
from bson import CodecOptions, decode, decode_all, decode_file_iter, decode_iter, encode
from bson.raw_bson import RawBSONDocument
from bson.son import SON
from pymongo import ASCENDING, MongoClient
from pymongo.collection import Collection
from pymongo.operations import DeleteOne, InsertOne, ReplaceOne
from pymongo.read_preferences import ReadPreference
TEST_PATH = os.path.join(os.path.dirname(os.path.realpath(__file__)), "mypy_fails")
def get_tests() -> Iterable[str]:
for dirpath, _, filenames in os.walk(TEST_PATH):
for filename in filenames:
yield os.path.join(dirpath, filename)
def only_type_check(func):
def inner(*args, **kwargs):
if not TYPE_CHECKING:
raise unittest.SkipTest("Used for Type Checking Only")
func(*args, **kwargs)
return inner
class TestMypyFails(unittest.TestCase):
def ensure_mypy_fails(self, filename: str) -> None:
if api is None:
raise unittest.SkipTest("Mypy is not installed")
stdout, stderr, exit_status = api.run([filename])
self.assertTrue(exit_status, msg=stdout)
def test_mypy_failures(self) -> None:
for filename in get_tests():
if filename == "typeddict_client.py" and TypedDict is None:
continue
with self.subTest(filename=filename):
self.ensure_mypy_fails(filename)
class TestPymongo(IntegrationTest):
coll: Collection
@classmethod
def setUpClass(cls):
super().setUpClass()
cls.coll = cls.client.test.test
def test_insert_find(self) -> None:
doc = {"my": "doc"}
coll2 = self.client.test.test2
result = self.coll.insert_one(doc)
self.assertEqual(result.inserted_id, doc["_id"])
retreived = self.coll.find_one({"_id": doc["_id"]})
if retreived:
# Documents returned from find are mutable.
retreived["new_field"] = 1
result2 = coll2.insert_one(retreived)
self.assertEqual(result2.inserted_id, result.inserted_id)
def test_cursor_iterable(self) -> None:
def to_list(iterable: Iterable[Dict[str, Any]]) -> List[Dict[str, Any]]:
return list(iterable)
self.coll.insert_one({})
cursor = self.coll.find()
docs = to_list(cursor)
self.assertTrue(docs)
@only_type_check
def test_bulk_write(self) -> None:
self.coll.insert_one({})
coll: Collection[Movie] = self.coll
requests: List[InsertOne[Movie]] = [InsertOne(Movie(name="American Graffiti", year=1973))]
self.assertTrue(coll.bulk_write(requests).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)
self.assertTrue(coll.bulk_write(new_requests).acknowledged)
# Because ReplaceOne is not generic, type checking is not enforced for ReplaceOne in the first example.
@only_type_check
def test_bulk_write_heterogeneous(self):
coll: Collection[Movie] = self.coll
requests: List[Union[InsertOne[Movie], ReplaceOne, DeleteOne]] = [
InsertOne(Movie(name="American Graffiti", year=1973)),
ReplaceOne({}, {"name": "American Graffiti", "year": "WRONG_TYPE"}),
DeleteOne({}),
]
self.assertTrue(coll.bulk_write(requests).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({}),
]
self.assertTrue(coll.bulk_write(requests_two).acknowledged)
def test_command(self) -> None:
result: Dict = self.client.admin.command("ping")
items = result.items()
def test_list_collections(self) -> None:
cursor = self.client.test.list_collections()
value = cursor.next()
items = value.items()
def test_list_databases(self) -> None:
cursor = self.client.list_databases()
value = cursor.next()
value.items()
def test_default_document_type(self) -> None:
client = rs_or_single_client()
self.addCleanup(client.close)
coll = client.test.test
doc = {"my": "doc"}
coll.insert_one(doc)
retreived = coll.find_one({"_id": doc["_id"]})
assert retreived is not None
retreived["a"] = 1
def test_aggregate_pipeline(self) -> None:
coll3 = self.client.test.test3
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(list(result)))
def test_with_transaction(self) -> None:
def execute_transaction(session):
pass
with self.client.start_session() as session:
return session.with_transaction(
execute_transaction, read_preference=ReadPreference.PRIMARY
)
class TestDecode(unittest.TestCase):
def test_bson_decode(self) -> None:
doc = {"_id": 1}
bsonbytes = encode(doc)
rt_document: Dict[str, Any] = decode(bsonbytes)
assert rt_document["_id"] == 1
rt_document["foo"] = "bar"
class MyDict(Dict[str, Any]):
def foo(self):
return "bar"
codec_options = CodecOptions(document_class=MyDict)
bsonbytes2 = encode(doc, codec_options=codec_options)
rt_document2 = decode(bsonbytes2, codec_options=codec_options)
assert rt_document2.foo() == "bar"
codec_options2 = CodecOptions(document_class=RawBSONDocument)
bsonbytes3 = encode(doc, codec_options=codec_options2)
rt_document3 = decode(bsonbytes2, codec_options=codec_options2)
assert rt_document3.raw
def test_bson_decode_all(self) -> None:
doc = {"_id": 1}
bsonbytes = encode(doc)
bsonbytes += encode(doc)
rt_documents: List[Dict[str, Any]] = decode_all(bsonbytes)
assert rt_documents[0]["_id"] == 1
rt_documents[0]["foo"] = "bar"
class MyDict(Dict[str, Any]):
def foo(self):
return "bar"
codec_options2 = CodecOptions(MyDict)
bsonbytes2 = encode(doc, codec_options=codec_options2)
bsonbytes2 += encode(doc, codec_options=codec_options2)
rt_documents2 = decode_all(bsonbytes2, codec_options2)
assert rt_documents2[0].foo() == "bar"
codec_options3 = CodecOptions(RawBSONDocument)
bsonbytes3 = encode(doc, codec_options=codec_options3)
bsonbytes3 += encode(doc, codec_options=codec_options3)
rt_documents3 = decode_all(bsonbytes3, codec_options3)
assert rt_documents3[0].raw
def test_bson_decode_iter(self) -> None:
doc = {"_id": 1}
bsonbytes = encode(doc)
bsonbytes += encode(doc)
rt_documents: Iterator[Dict[str, Any]] = decode_iter(bsonbytes)
assert next(rt_documents)["_id"] == 1
next(rt_documents)["foo"] = "bar"
class MyDict(Dict[str, Any]):
def foo(self):
return "bar"
codec_options2 = CodecOptions(MyDict)
bsonbytes2 = encode(doc, codec_options=codec_options2)
bsonbytes2 += encode(doc, codec_options=codec_options2)
rt_documents2 = decode_iter(bsonbytes2, codec_options2)
assert next(rt_documents2).foo() == "bar"
codec_options3 = CodecOptions(RawBSONDocument)
bsonbytes3 = encode(doc, codec_options=codec_options3)
bsonbytes3 += encode(doc, codec_options=codec_options3)
rt_documents3 = decode_iter(bsonbytes3, codec_options3)
assert next(rt_documents3).raw
def make_tempfile(self, content: bytes) -> Any:
fileobj = tempfile.TemporaryFile()
fileobj.write(content)
fileobj.seek(0)
self.addCleanup(fileobj.close)
return fileobj
def test_bson_decode_file_iter(self) -> None:
doc = {"_id": 1}
bsonbytes = encode(doc)
bsonbytes += encode(doc)
fileobj = self.make_tempfile(bsonbytes)
rt_documents: Iterator[Dict[str, Any]] = decode_file_iter(fileobj)
assert next(rt_documents)["_id"] == 1
next(rt_documents)["foo"] = "bar"
class MyDict(Dict[str, Any]):
def foo(self):
return "bar"
codec_options2 = CodecOptions(MyDict)
bsonbytes2 = encode(doc, codec_options=codec_options2)
bsonbytes2 += encode(doc, codec_options=codec_options2)
fileobj2 = self.make_tempfile(bsonbytes2)
rt_documents2 = decode_file_iter(fileobj2, codec_options2)
assert next(rt_documents2).foo() == "bar"
codec_options3 = CodecOptions(RawBSONDocument)
bsonbytes3 = encode(doc, codec_options=codec_options3)
bsonbytes3 += encode(doc, codec_options=codec_options3)
fileobj3 = self.make_tempfile(bsonbytes3)
rt_documents3 = decode_file_iter(fileobj3, codec_options3)
assert next(rt_documents3).raw
class TestDocumentType(unittest.TestCase):
@only_type_check
def test_default(self) -> None:
client: MongoClient = MongoClient()
coll = client.test.test
retreived = coll.find_one({"_id": "foo"})
assert retreived is not None
retreived["a"] = 1
@only_type_check
def test_explicit_document_type(self) -> None:
client: MongoClient[Dict[str, Any]] = MongoClient()
coll = client.test.test
retreived = coll.find_one({"_id": "foo"})
assert retreived is not None
retreived["a"] = 1
@only_type_check
def test_typeddict_document_type(self) -> None:
client: MongoClient[Movie] = MongoClient()
coll = client.test.test
retreived = coll.find_one({"_id": "foo"})
assert retreived is not None
assert retreived["year"] == 1
assert retreived["name"] == "a"
@only_type_check
def test_typeddict_document_type_insertion(self) -> None:
client: MongoClient[Movie] = MongoClient()
coll = client.test.test
mov = {"name": "THX-1138", "year": 1971}
movie = Movie(name="THX-1138", year=1971)
coll.insert_one(mov) # type: ignore[arg-type]
coll.insert_one({"name": "THX-1138", "year": 1971}) # This will work because it is in-line.
coll.insert_one(movie)
coll.insert_many([mov]) # type: ignore[list-item]
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]
coll.insert_one(bad_mov) # type:ignore[arg-type]
coll.insert_one({"name": "THX-1138", "year": "WRONG TYPE"}) # type: ignore[typeddict-item]
coll.insert_one(bad_movie)
coll.insert_many([bad_mov]) # type: ignore[list-item]
coll.insert_many(
[{"name": "THX-1138", "year": "WRONG TYPE"}] # type: ignore[typeddict-item]
)
coll.insert_many([bad_movie])
@only_type_check
def test_bulk_write_document_type_insertion(self):
client: MongoClient[MovieWithId] = MongoClient()
coll: Collection[MovieWithId] = client.test.test
coll.bulk_write(
[InsertOne(Movie({"name": "THX-1138", "year": 1971}))] # type:ignore[arg-type]
)
mov_dict = {"_id": ObjectId(), "name": "THX-1138", "year": 1971}
coll.bulk_write(
[InsertOne(mov_dict)] # type:ignore[arg-type]
)
coll.bulk_write(
[
InsertOne({"_id": ObjectId(), "name": "THX-1138", "year": 1971})
] # No error because it is in-line.
)
@only_type_check
def test_bulk_write_document_type_replacement(self):
client: MongoClient[MovieWithId] = MongoClient()
coll: Collection[MovieWithId] = client.test.test
coll.bulk_write(
[ReplaceOne({}, Movie({"name": "THX-1138", "year": 1971}))] # type:ignore[arg-type]
)
mov_dict = {"_id": ObjectId(), "name": "THX-1138", "year": 1971}
coll.bulk_write(
[ReplaceOne({}, mov_dict)] # type:ignore[arg-type]
)
coll.bulk_write(
[
ReplaceOne({}, {"_id": ObjectId(), "name": "THX-1138", "year": 1971})
] # No error because it is in-line.
)
@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 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]
assert 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]
def test_typeddict_find_notrequired(self):
if NotRequired is None or ImplicitMovie is None:
raise unittest.SkipTest("Python 3.11+ is required to use NotRequired.")
client: MongoClient[ImplicitMovie] = rs_or_single_client()
coll = client.test.test
coll.insert_one(ImplicitMovie(name="THX-1138", year=1971))
out = coll.find_one({})
assert out is not None
assert out["_id"]
@only_type_check
def test_raw_bson_document_type(self) -> None:
client = MongoClient(document_class=RawBSONDocument)
coll = client.test.test
retreived = coll.find_one({"_id": "foo"})
assert retreived is not None
assert len(retreived.raw) > 0
@only_type_check
def test_son_document_type(self) -> None:
client = MongoClient(document_class=SON[str, Any])
coll = client.test.test
retreived = coll.find_one({"_id": "foo"})
assert retreived is not None
retreived["a"] = 1
def test_son_document_type_runtime(self) -> None:
client = MongoClient(document_class=SON[str, Any], connect=False)
@only_type_check
def test_create_index(self) -> None:
client: MongoClient[Dict[str, str]] = MongoClient("test")
db = client.test
with client.start_session() as session:
index = db.test.create_index([("user_id", ASCENDING)], unique=True, session=session)
assert isinstance(index, str)
class TestCommandDocumentType(unittest.TestCase):
@only_type_check
def test_default(self) -> None:
client: MongoClient = MongoClient()
result: Dict = client.admin.command("ping")
result["a"] = 1
@only_type_check
def test_explicit_document_type(self) -> None:
client: MongoClient = MongoClient()
codec_options: CodecOptions[Dict[str, Any]] = CodecOptions()
result = client.admin.command("ping", codec_options=codec_options)
result["a"] = 1
@only_type_check
def test_typeddict_document_type(self) -> None:
client: MongoClient = MongoClient()
codec_options: CodecOptions[Movie] = CodecOptions()
result = client.admin.command("ping", codec_options=codec_options)
assert result["year"] == 1
assert result["name"] == "a"
@only_type_check
def test_raw_bson_document_type(self) -> None:
client: MongoClient = MongoClient()
codec_options = CodecOptions(RawBSONDocument)
result = client.admin.command("ping", codec_options=codec_options)
assert len(result.raw) > 0
@only_type_check
def test_son_document_type(self) -> None:
client = MongoClient(document_class=SON[str, Any])
codec_options = CodecOptions(SON[str, Any])
result = client.admin.command("ping", codec_options=codec_options)
result["a"] = 1
class TestCodecOptionsDocumentType(unittest.TestCase):
def test_default(self) -> None:
options: CodecOptions = CodecOptions()
obj = options.document_class()
obj["a"] = 1
def test_explicit_document_type(self) -> None:
options: CodecOptions[Dict[str, Any]] = CodecOptions()
obj = options.document_class()
obj["a"] = 1
def test_typeddict_document_type(self) -> None:
options: CodecOptions[Movie] = CodecOptions()
# Suppress: Cannot instantiate type "Type[Movie]".
obj = options.document_class(name="a", year=1) # type: ignore[misc]
assert obj["year"] == 1
assert obj["name"] == "a"
def test_raw_bson_document_type(self) -> None:
options = CodecOptions(RawBSONDocument)
doc_bson = b"\x10\x00\x00\x00\x11a\x00\xff\xff\xff\xff\xff\xff\xff\xff\x00"
obj = options.document_class(doc_bson)
assert len(obj.raw) > 0
def test_son_document_type(self) -> None:
options = CodecOptions(SON[str, Any])
obj = options.document_class()
obj["a"] = 1
if __name__ == "__main__":
unittest.main()