def test_deepcopy_cursor_littered_with_regexes(self):

cursor = self.db.coll.find(

{

"x": re.compile("^hmmm.*"),

"y": [re.compile("^hmm.*")],

"z": {"a": [re.compile("^hm.*")]},

re.compile("^key.*"): {"a": [re.compile("^hm.*")]},

}

)

cursor2 = copy.deepcopy(cursor)

self.assertEqual(cursor._spec, cursor2._spec)

def test_add_remove_option(self):

cursor = self.db.coll.find()

self.assertEqual(0, cursor._query_flags)

cursor.add_option(2)

cursor2 = self.db.coll.find(cursor_type=CursorType.TAILABLE)

self.assertEqual(2, cursor2._query_flags)

self.assertEqual(cursor._query_flags, cursor2._query_flags)

cursor.add_option(32)

cursor2 = self.db.coll.find(cursor_type=CursorType.TAILABLE_AWAIT)

self.assertEqual(34, cursor2._query_flags)

self.assertEqual(cursor._query_flags, cursor2._query_flags)

cursor.add_option(128)

cursor2 = self.db.coll.find(cursor_type=CursorType.TAILABLE_AWAIT).add_option(128)

self.assertEqual(162, cursor2._query_flags)

self.assertEqual(cursor._query_flags, cursor2._query_flags)

self.assertEqual(162, cursor._query_flags)

cursor.add_option(128)

self.assertEqual(162, cursor._query_flags)

cursor.remove_option(128)

cursor2 = self.db.coll.find(cursor_type=CursorType.TAILABLE_AWAIT)

self.assertEqual(34, cursor2._query_flags)

self.assertEqual(cursor._query_flags, cursor2._query_flags)

cursor.remove_option(32)

cursor2 = self.db.coll.find(cursor_type=CursorType.TAILABLE)

self.assertEqual(2, cursor2._query_flags)

self.assertEqual(cursor._query_flags, cursor2._query_flags)

self.assertEqual(2, cursor._query_flags)

cursor.remove_option(32)

self.assertEqual(2, cursor._query_flags)

# Timeout

cursor = self.db.coll.find(no_cursor_timeout=True)

self.assertEqual(16, cursor._query_flags)

cursor2 = self.db.coll.find().add_option(16)

self.assertEqual(cursor._query_flags, cursor2._query_flags)

cursor.remove_option(16)

self.assertEqual(0, cursor._query_flags)

# Tailable / Await data

cursor = self.db.coll.find(cursor_type=CursorType.TAILABLE_AWAIT)

self.assertEqual(34, cursor._query_flags)

cursor2 = self.db.coll.find().add_option(34)

self.assertEqual(cursor._query_flags, cursor2._query_flags)

cursor.remove_option(32)

self.assertEqual(2, cursor._query_flags)

# Partial

cursor = self.db.coll.find(allow_partial_results=True)

self.assertEqual(128, cursor._query_flags)

cursor2 = self.db.coll.find().add_option(128)

self.assertEqual(cursor._query_flags, cursor2._query_flags)

cursor.remove_option(128)

self.assertEqual(0, cursor._query_flags)

def test_add_remove_option_exhaust(self):

# mongos only serves exhaust cursors from 7.1 onwards (SERVER-57297).

if not client_context.supports_exhaust_cursors():

with self.assertRaises(InvalidOperation):

next(self.db.coll.find(cursor_type=CursorType.EXHAUST))

else:

cursor = self.db.coll.find(cursor_type=CursorType.EXHAUST)

self.assertEqual(64, cursor._query_flags)

cursor2 = self.db.coll.find().add_option(64)

self.assertEqual(cursor._query_flags, cursor2._query_flags)

self.assertTrue(cursor._exhaust)

cursor.remove_option(64)

self.assertEqual(0, cursor._query_flags)

self.assertFalse(cursor._exhaust)

def test_allow_disk_use(self):

db = self.db

db.coll.drop()

coll = db.coll

with self.assertRaises(TypeError):

coll.find().allow_disk_use("baz") # type: ignore[arg-type]

cursor = coll.find().allow_disk_use(True)

self.assertEqual(True, cursor._allow_disk_use)

cursor = coll.find().allow_disk_use(False)

self.assertEqual(False, cursor._allow_disk_use)

def test_max_time_ms(self):

db = self.db

db.coll.drop()

coll = db.coll

with self.assertRaises(TypeError):

coll.find().max_time_ms("foo") # type: ignore[arg-type]

coll.insert_one({"amalia": 1})

coll.insert_one({"amalia": 2})

coll.find().max_time_ms(None)

coll.find().max_time_ms(1)

cursor = coll.find().max_time_ms(999)

self.assertEqual(999, cursor._max_time_ms)

cursor = coll.find().max_time_ms(10).max_time_ms(1000)

self.assertEqual(1000, cursor._max_time_ms)

cursor = coll.find().max_time_ms(999)

c2 = cursor.clone()

self.assertEqual(999, c2._max_time_ms)

self.assertIn("$maxTimeMS", cursor._query_spec())

self.assertIn("$maxTimeMS", c2._query_spec())

self.assertTrue(coll.find_one(max_time_ms=1000))

client = self.client

if not client_context.is_mongos and client_context.test_commands_enabled:

# Cursor parses server timeout error in response to initial query.

client.admin.command("configureFailPoint", "maxTimeAlwaysTimeOut", mode="alwaysOn")

try:

cursor = coll.find().max_time_ms(1)

try:

next(cursor)

except ExecutionTimeout:

pass

else:

self.fail("ExecutionTimeout not raised")

with self.assertRaises(ExecutionTimeout):

coll.find_one(max_time_ms=1)

finally:

client.admin.command("configureFailPoint", "maxTimeAlwaysTimeOut", mode="off")

def test_maxtime_ms_message(self):

db = self.db

db.t.insert_one({"x": 1})

with self.assertRaises(OperationFailure) as error:

db.t.find_one({"$where": delay(2)}, max_time_ms=1)

# Newer MongoDB executes $where in WASM and returns Interrupted (11601) instead

# of MaxTimeMSExpired (50) when max_time_ms kills execution; only MaxTimeMSExpired

# errors get the configured timeout details appended.

if isinstance(error.exception, ExecutionTimeout):

self.assertIn("(configured timeouts: connectTimeoutMS: 20000.0ms", str(error.exception))

client = self.rs_client(document_class=RawBSONDocument)

client.db.coll.insert_one({"x": 1})

with self.assertRaises(OperationFailure) as error:

client.db.coll.find_one({"$where": delay(2)}, max_time_ms=1)

if isinstance(error.exception, ExecutionTimeout):

self.assertIn("(configured timeouts: connectTimeoutMS: 20000.0ms", str(error.exception))

def test_max_await_time_ms(self):

db = self.db

db.coll.drop()

coll = db.create_collection("coll", capped=True, size=4096)

with self.assertRaises(TypeError):

coll.find().max_await_time_ms("foo") # type: ignore[arg-type]

coll.insert_one({"amalia": 1})

coll.insert_one({"amalia": 2})

coll.find().max_await_time_ms(None)

coll.find().max_await_time_ms(1)

# When cursor is not tailable_await

cursor = coll.find()

self.assertEqual(None, cursor._max_await_time_ms)

cursor = coll.find().max_await_time_ms(99)

self.assertEqual(None, cursor._max_await_time_ms)

# If cursor is tailable_await and timeout is unset

cursor = coll.find(cursor_type=CursorType.TAILABLE_AWAIT)

self.assertEqual(None, cursor._max_await_time_ms)

# If cursor is tailable_await and timeout is set

cursor = coll.find(cursor_type=CursorType.TAILABLE_AWAIT).max_await_time_ms(99)

self.assertEqual(99, cursor._max_await_time_ms)

cursor = (

coll.find(cursor_type=CursorType.TAILABLE_AWAIT)

.max_await_time_ms(10)

.max_await_time_ms(90)

)

self.assertEqual(90, cursor._max_await_time_ms)

listener = AllowListEventListener("find", "getMore")

coll = (self.rs_or_single_client(event_listeners=[listener])).pymongo_test.coll

# Tailable_defaults.

coll.find(cursor_type=CursorType.TAILABLE_AWAIT).to_list()

# find

self.assertNotIn("maxTimeMS", listener.started_events[0].command)

# getMore

self.assertNotIn("maxTimeMS", listener.started_events[1].command)

listener.reset()

# Tailable_with max_await_time_ms set.

coll.find(cursor_type=CursorType.TAILABLE_AWAIT).max_await_time_ms(99).to_list()

# find

self.assertEqual("find", listener.started_events[0].command_name)

self.assertNotIn("maxTimeMS", listener.started_events[0].command)

# getMore

self.assertEqual("getMore", listener.started_events[1].command_name)

self.assertIn("maxTimeMS", listener.started_events[1].command)

self.assertEqual(99, listener.started_events[1].command["maxTimeMS"])

listener.reset()

# Tailable_with max_time_ms and make sure list() works on synchronous cursors

if _IS_SYNC:

list(coll.find(cursor_type=CursorType.TAILABLE_AWAIT).max_time_ms(99)) # type: ignore[call-overload]

else:

coll.find(cursor_type=CursorType.TAILABLE_AWAIT).max_time_ms(99).to_list()

# find

self.assertEqual("find", listener.started_events[0].command_name)

self.assertIn("maxTimeMS", listener.started_events[0].command)

self.assertEqual(99, listener.started_events[0].command["maxTimeMS"])

# getMore

self.assertEqual("getMore", listener.started_events[1].command_name)

self.assertNotIn("maxTimeMS", listener.started_events[1].command)

listener.reset()

# Tailable_with both max_time_ms and max_await_time_ms

(

coll.find(cursor_type=CursorType.TAILABLE_AWAIT)

.max_time_ms(99)

.max_await_time_ms(99)

.to_list()

)

# find

self.assertEqual("find", listener.started_events[0].command_name)

self.assertIn("maxTimeMS", listener.started_events[0].command)

self.assertEqual(99, listener.started_events[0].command["maxTimeMS"])

# getMore

self.assertEqual("getMore", listener.started_events[1].command_name)

self.assertIn("maxTimeMS", listener.started_events[1].command)

self.assertEqual(99, listener.started_events[1].command["maxTimeMS"])

listener.reset()

# Non tailable_await with max_await_time_ms

coll.find(batch_size=1).max_await_time_ms(99).to_list()

# find

self.assertEqual("find", listener.started_events[0].command_name)

self.assertNotIn("maxTimeMS", listener.started_events[0].command)

# getMore

self.assertEqual("getMore", listener.started_events[1].command_name)

self.assertNotIn("maxTimeMS", listener.started_events[1].command)

listener.reset()

# Non tailable_await with max_time_ms

coll.find(batch_size=1).max_time_ms(99).to_list()

# find

self.assertEqual("find", listener.started_events[0].command_name)

self.assertIn("maxTimeMS", listener.started_events[0].command)

self.assertEqual(99, listener.started_events[0].command["maxTimeMS"])

# getMore

self.assertEqual("getMore", listener.started_events[1].command_name)

self.assertNotIn("maxTimeMS", listener.started_events[1].command)

# Non tailable_await with both max_time_ms and max_await_time_ms

coll.find(batch_size=1).max_time_ms(99).max_await_time_ms(88).to_list()

# find

self.assertEqual("find", listener.started_events[0].command_name)

self.assertIn("maxTimeMS", listener.started_events[0].command)

self.assertEqual(99, listener.started_events[0].command["maxTimeMS"])

# getMore

self.assertEqual("getMore", listener.started_events[1].command_name)

self.assertNotIn("maxTimeMS", listener.started_events[1].command)

@client_context.require_test_commands

@client_context.require_no_mongos

def test_max_time_ms_getmore(self):

# Test that Cursor handles server timeout error in response to getmore.

coll = self.db.coll

coll.insert_many([{} for _ in range(200)])

cursor = coll.find().max_time_ms(100)

# Send initial query before turning on failpoint.

next(cursor)

self.client.admin.command("configureFailPoint", "maxTimeAlwaysTimeOut", mode="alwaysOn")

try:

try:

# Iterate up to first getmore.

cursor.to_list()

except ExecutionTimeout:

pass

else:

self.fail("ExecutionTimeout not raised")

finally:

self.client.admin.command("configureFailPoint", "maxTimeAlwaysTimeOut", mode="off")

def test_explain(self):

a = self.db.coll.find()

a.explain()

for _ in a:

break

b = a.explain()

self.assertIn("executionStats", b)

def test_explain_with_read_concern(self):

# Do not add readConcern level to explain.

listener = AllowListEventListener("explain")

client = self.rs_or_single_client(event_listeners=[listener])

coll = client.pymongo_test.coll.with_options(read_concern=ReadConcern(level="local"))

self.assertTrue(coll.find().explain())

started = listener.started_events

self.assertEqual(len(started), 1)

self.assertNotIn("readConcern", started[0].command)

# https://github.com/mongodb/specifications/blob/master/source/crud/tests/README.md#14-explain-helpers-allow-users-to-specify-maxtimems

def test_explain_csot(self):

# Create a MongoClient with command monitoring enabled (referred to as client).

listener = AllowListEventListener("explain")

client = self.rs_or_single_client(event_listeners=[listener])

# Create a collection, referred to as collection, with the namespace explain-test.collection.

# Workaround for SERVER-108463

names = client["explain-test"].list_collection_names()

if "collection" not in names:

collection = client["explain-test"].create_collection("collection")

else:

collection = client["explain-test"]["collection"]

# Run an explained find on collection. The find will have the query predicate { name: 'john doe' }. Specify a maxTimeMS value of 2000ms for the explain.

with pymongo.timeout(2.0):

self.assertTrue(collection.find({"name": "john doe"}).explain())

# Obtain the command started event for the explain. Confirm that the top-level explain command should has a maxTimeMS value of 2000.

started = listener.started_events

self.assertEqual(len(started), 1)

assert 1500 < started[0].command["maxTimeMS"] <= 2000

def test_hint(self):

db = self.db

with self.assertRaises(TypeError):

db.coll.find().hint(5.5) # type: ignore[arg-type]

db.coll.drop()

db.coll.insert_many([{"num": i, "foo": i} for i in range(100)])

with self.assertRaises(OperationFailure):

db.coll.find({"num": 17, "foo": 17}).hint([("num", ASCENDING)]).explain()

with self.assertRaises(OperationFailure):

db.coll.find({"num": 17, "foo": 17}).hint([("foo", ASCENDING)]).explain()

spec: list[Any] = [("num", DESCENDING)]

_ = db.coll.create_index(spec)

first = next(db.coll.find())

self.assertEqual(0, first.get("num"))

first = next(db.coll.find().hint(spec))

self.assertEqual(99, first.get("num"))

with self.assertRaises(OperationFailure):

db.coll.find({"num": 17, "foo": 17}).hint([("foo", ASCENDING)]).explain()

a = db.coll.find({"num": 17})

a.hint(spec)

for _ in a:

break

self.assertRaises(InvalidOperation, a.hint, spec)

db.coll.drop()

db.coll.insert_many([{"num": i, "foo": i} for i in range(100)])

spec: _IndexList = ["num", ("foo", DESCENDING)]

db.coll.create_index(spec)

first = next(db.coll.find().hint(spec))

self.assertEqual(0, first.get("num"))

self.assertEqual(0, first.get("foo"))

db.coll.drop()

db.coll.insert_many([{"num": i, "foo": i} for i in range(100)])

spec = ["num"]

db.coll.create_index(spec)

first = next(db.coll.find().hint(spec))

self.assertEqual(0, first.get("num"))

def test_hint_by_name(self):

db = self.db

db.coll.drop()

db.coll.insert_many([{"i": i} for i in range(100)])

db.coll.create_index([("i", DESCENDING)], name="fooindex")

first = next(db.coll.find())

self.assertEqual(0, first.get("i"))

first = next(db.coll.find().hint("fooindex"))

self.assertEqual(99, first.get("i"))

def test_limit(self):

db = self.db

with self.assertRaises(TypeError):

db.coll.find().limit(None) # type: ignore[arg-type]

with self.assertRaises(TypeError):

db.coll.find().limit("hello") # type: ignore[arg-type]

with self.assertRaises(TypeError):

db.coll.find().limit(5.5) # type: ignore[arg-type]

self.assertTrue((db.coll.find()).limit(5))

db.coll.drop()

db.coll.insert_many([{"x": i} for i in range(100)])

count = 0

for _ in db.coll.find():

count += 1

self.assertEqual(count, 100)

count = 0

for _ in db.coll.find().limit(20):

count += 1

self.assertEqual(count, 20)

count = 0

for _ in db.coll.find().limit(99):

count += 1

self.assertEqual(count, 99)

count = 0

for _ in db.coll.find().limit(1):

count += 1

self.assertEqual(count, 1)

count = 0

for _ in db.coll.find().limit(0):

count += 1

self.assertEqual(count, 100)

count = 0

for _ in db.coll.find().limit(0).limit(50).limit(10):

count += 1

self.assertEqual(count, 10)

a = db.coll.find()

a.limit(10)

for _ in a:

break

with self.assertRaises(InvalidOperation):

a.limit(5)

def test_max(self):

db = self.db

db.coll.drop()

j_index = [("j", ASCENDING)]

db.coll.create_index(j_index)

db.coll.insert_many([{"j": j, "k": j} for j in range(10)])

def find(max_spec, expected_index):

return db.coll.find().max(max_spec).hint(expected_index)

cursor = find([("j", 3)], j_index)

self.assertEqual(len(cursor.to_list()), 3)

# Tuple.

cursor = find((("j", 3),), j_index)

self.assertEqual(len(cursor.to_list()), 3)

# Compound index.

index_keys = [("j", ASCENDING), ("k", ASCENDING)]

db.coll.create_index(index_keys)

cursor = find([("j", 3), ("k", 3)], index_keys)

self.assertEqual(len(cursor.to_list()), 3)

# Wrong order.

cursor = find([("k", 3), ("j", 3)], index_keys)

with self.assertRaises(OperationFailure):

cursor.to_list()

# No such index.

cursor = find([("k", 3)], "k")

with self.assertRaises(OperationFailure):

cursor.to_list()

with self.assertRaises(TypeError):

db.coll.find().max(10) # type: ignore[arg-type]

with self.assertRaises(TypeError):

db.coll.find().max({"j": 10}) # type: ignore[arg-type]

def test_min(self):

db = self.db

db.coll.drop()

j_index = [("j", ASCENDING)]

db.coll.create_index(j_index)

db.coll.insert_many([{"j": j, "k": j} for j in range(10)])

def find(min_spec, expected_index):

return db.coll.find().min(min_spec).hint(expected_index)

cursor = find([("j", 3)], j_index)

self.assertEqual(len(cursor.to_list()), 7)

# Tuple.

cursor = find((("j", 3),), j_index)

self.assertEqual(len(cursor.to_list()), 7)

# Compound index.

index_keys = [("j", ASCENDING), ("k", ASCENDING)]

db.coll.create_index(index_keys)

cursor = find([("j", 3), ("k", 3)], index_keys)

self.assertEqual(len(cursor.to_list()), 7)

# Wrong order.

cursor = find([("k", 3), ("j", 3)], index_keys)

with self.assertRaises(OperationFailure):

cursor.to_list()

# No such index.

cursor = find([("k", 3)], "k")

with self.assertRaises(OperationFailure):

cursor.to_list()

with self.assertRaises(TypeError):

db.coll.find().min(10) # type: ignore[arg-type]

with self.assertRaises(TypeError):

db.coll.find().min({"j": 10}) # type: ignore[arg-type]

def test_min_max_without_hint(self):

coll = self.db.coll

j_index = [("j", ASCENDING)]

coll.create_index(j_index)

with self.assertRaises(InvalidOperation):

coll.find().min([("j", 3)]).to_list()

with self.assertRaises(InvalidOperation):

coll.find().max([("j", 3)]).to_list()

def test_batch_size(self):

db = self.db

db.coll.drop()

db.coll.insert_many([{"x": x} for x in range(200)])

with self.assertRaises(TypeError):

db.coll.find().batch_size(None) # type: ignore[arg-type]

with self.assertRaises(TypeError):

db.coll.find().batch_size("hello") # type: ignore[arg-type]

with self.assertRaises(TypeError):

db.coll.find().batch_size(5.5) # type: ignore[arg-type]

with self.assertRaises(ValueError):

db.coll.find().batch_size(-1)

self.assertTrue((db.coll.find()).batch_size(5))

a = db.coll.find()

for _ in a:

break

self.assertRaises(InvalidOperation, a.batch_size, 5)

def cursor_count(cursor, expected_count):

count = 0

for _ in cursor:

count += 1

self.assertEqual(expected_count, count)

cursor_count((db.coll.find()).batch_size(0), 200)

cursor_count((db.coll.find()).batch_size(1), 200)

cursor_count((db.coll.find()).batch_size(2), 200)

cursor_count((db.coll.find()).batch_size(5), 200)

cursor_count((db.coll.find()).batch_size(100), 200)

cursor_count((db.coll.find()).batch_size(500), 200)

cursor_count((db.coll.find()).batch_size(0).limit(1), 1)

cursor_count((db.coll.find()).batch_size(1).limit(1), 1)

cursor_count((db.coll.find()).batch_size(2).limit(1), 1)

cursor_count((db.coll.find()).batch_size(5).limit(1), 1)

cursor_count((db.coll.find()).batch_size(100).limit(1), 1)

cursor_count((db.coll.find()).batch_size(500).limit(1), 1)

cursor_count((db.coll.find()).batch_size(0).limit(10), 10)

cursor_count((db.coll.find()).batch_size(1).limit(10), 10)

cursor_count((db.coll.find()).batch_size(2).limit(10), 10)

cursor_count((db.coll.find()).batch_size(5).limit(10), 10)

cursor_count((db.coll.find()).batch_size(100).limit(10), 10)

cursor_count((db.coll.find()).batch_size(500).limit(10), 10)

cur = db.coll.find().batch_size(1)

next(cur)

# find command batchSize should be 1

self.assertEqual(0, len(cur._data))

next(cur)

self.assertEqual(0, len(cur._data))

next(cur)

self.assertEqual(0, len(cur._data))

next(cur)

self.assertEqual(0, len(cur._data))

def test_limit_and_batch_size(self):

db = self.db

db.coll.drop()

db.coll.insert_many([{"x": x} for x in range(500)])

curs = db.coll.find().limit(0).batch_size(10)

next(curs)

self.assertEqual(10, curs._retrieved)

curs = db.coll.find(limit=0, batch_size=10)

next(curs)

self.assertEqual(10, curs._retrieved)

curs = db.coll.find().limit(-2).batch_size(0)

next(curs)

self.assertEqual(2, curs._retrieved)

curs = db.coll.find(limit=-2, batch_size=0)

next(curs)

self.assertEqual(2, curs._retrieved)

curs = db.coll.find().limit(-4).batch_size(5)

next(curs)

self.assertEqual(4, curs._retrieved)

curs = db.coll.find(limit=-4, batch_size=5)

next(curs)

self.assertEqual(4, curs._retrieved)

curs = db.coll.find().limit(50).batch_size(500)

next(curs)

self.assertEqual(50, curs._retrieved)

curs = db.coll.find(limit=50, batch_size=500)

next(curs)

self.assertEqual(50, curs._retrieved)

curs = db.coll.find().batch_size(500)

next(curs)

self.assertEqual(500, curs._retrieved)

curs = db.coll.find(batch_size=500)

next(curs)

self.assertEqual(500, curs._retrieved)

curs = db.coll.find().limit(50)

next(curs)

self.assertEqual(50, curs._retrieved)

curs = db.coll.find(limit=50)

next(curs)

self.assertEqual(50, curs._retrieved)

# these two might be shaky, as the default

# is set by the server. as of 2.0.0-rc0, 101

# or 1MB (whichever is smaller) is default

# for queries without ntoreturn

curs = db.coll.find()

next(curs)

self.assertEqual(101, curs._retrieved)

curs = db.coll.find().limit(0).batch_size(0)

next(curs)

self.assertEqual(101, curs._retrieved)

curs = db.coll.find(limit=0, batch_size=0)

next(curs)

self.assertEqual(101, curs._retrieved)

def test_skip(self):

db = self.db

with self.assertRaises(TypeError):

db.coll.find().skip(None) # type: ignore[arg-type]

with self.assertRaises(TypeError):

db.coll.find().skip("hello") # type: ignore[arg-type]

with self.assertRaises(TypeError):

db.coll.find().skip(5.5) # type: ignore[arg-type]

with self.assertRaises(ValueError):

db.coll.find().skip(-5)

self.assertTrue((db.coll.find()).skip(5))

db.drop_collection("coll")

db.coll.insert_many([{"x": i} for i in range(100)])

for i in db.coll.find():

self.assertEqual(i["x"], 0)

break

for i in db.coll.find().skip(20):

self.assertEqual(i["x"], 20)

break

for i in db.coll.find().skip(99):

self.assertEqual(i["x"], 99)

break

for i in db.coll.find().skip(1):

self.assertEqual(i["x"], 1)

break

for i in db.coll.find().skip(0):

self.assertEqual(i["x"], 0)

break

for i in db.coll.find().skip(0).skip(50).skip(10):

self.assertEqual(i["x"], 10)

break

for _ in db.coll.find().skip(1000):

self.fail()

a = db.coll.find()

a.skip(10)

for _ in a:

break

self.assertRaises(InvalidOperation, a.skip, 5)

def test_sort(self):

db = self.db

with self.assertRaises(TypeError):

db.coll.find().sort(5) # type: ignore[arg-type]

with self.assertRaises(ValueError):

db.coll.find().sort([]) # type: ignore[arg-type]

with self.assertRaises(TypeError):

db.coll.find().sort([], ASCENDING) # type: ignore[arg-type]

with self.assertRaises(TypeError):

db.coll.find().sort([("hello", DESCENDING)], DESCENDING) # type: ignore[arg-type]

db.coll.drop()

unsort = list(range(10))

random.shuffle(unsort)

db.coll.insert_many([{"x": i} for i in unsort])

asc = [i["x"] for i in db.coll.find().sort("x", ASCENDING)]

self.assertEqual(asc, list(range(10)))

asc = [i["x"] for i in db.coll.find().sort("x")]

self.assertEqual(asc, list(range(10)))

asc = [i["x"] for i in db.coll.find().sort([("x", ASCENDING)])]

self.assertEqual(asc, list(range(10)))

expect = list(reversed(range(10)))

desc = [i["x"] for i in db.coll.find().sort("x", DESCENDING)]

self.assertEqual(desc, expect)

desc = [i["x"] for i in db.coll.find().sort([("x", DESCENDING)])]

self.assertEqual(desc, expect)

desc = [i["x"] for i in db.coll.find().sort("x", ASCENDING).sort("x", DESCENDING)]

self.assertEqual(desc, expect)

expected = [(1, 5), (2, 5), (0, 3), (7, 3), (9, 2), (2, 1), (3, 1)]

shuffled = list(expected)

random.shuffle(shuffled)

db.coll.drop()

for a, b in shuffled:

db.coll.insert_one({"a": a, "b": b})

result = [

(i["a"], i["b"]) for i in db.coll.find().sort([("b", DESCENDING), ("a", ASCENDING)])

]

self.assertEqual(result, expected)

result = [(i["a"], i["b"]) for i in db.coll.find().sort([("b", DESCENDING), "a"])]

self.assertEqual(result, expected)

a = db.coll.find()

a.sort("x", ASCENDING)

for _ in a:

break

self.assertRaises(InvalidOperation, a.sort, "x", ASCENDING)

@unittest.skipIf(

def test_where(self):

db = self.db

db.coll.drop()

a = db.coll.find()

with self.assertRaises(TypeError):

a.where(5) # type: ignore[arg-type]

with self.assertRaises(TypeError):

a.where(None) # type: ignore[arg-type]

with self.assertRaises(TypeError):

a.where({}) # type: ignore[arg-type]

db.coll.insert_many([{"x": i} for i in range(10)])

self.assertEqual(3, len(db.coll.find().where("this.x < 3").to_list()))

self.assertEqual(3, len(db.coll.find().where(Code("this.x < 3")).to_list()))

code_with_scope = Code("this.x < i", {"i": 3})

# MongoDB 4.4 removed support for Code with scope.

with self.assertRaises(OperationFailure):

db.coll.find().where(code_with_scope).to_list()

code_with_empty_scope = Code("this.x < 3", {})

with self.assertRaises(OperationFailure):

db.coll.find().where(code_with_empty_scope).to_list()

self.assertEqual(10, len(db.coll.find().to_list()))

self.assertEqual([0, 1, 2], [a["x"] for a in db.coll.find().where("this.x < 3")])

self.assertEqual([], [a["x"] for a in db.coll.find({"x": 5}).where("this.x < 3")])

self.assertEqual([5], [a["x"] for a in db.coll.find({"x": 5}).where("this.x > 3")])

cursor = db.coll.find().where("this.x < 3").where("this.x > 7")

self.assertEqual([8, 9], [a["x"] for a in cursor])

a = db.coll.find()

_ = a.where("this.x > 3")

for _ in a:

break

self.assertRaises(InvalidOperation, a.where, "this.x < 3")

def test_rewind(self):

self.db.coll.insert_many([{"x": i} for i in range(1, 4)])

cursor = self.db.coll.find().limit(2)

count = 0

for _ in cursor:

count += 1

self.assertEqual(2, count)

count = 0

for _ in cursor:

count += 1

self.assertEqual(0, count)

cursor.rewind()

count = 0

for _ in cursor:

count += 1

self.assertEqual(2, count)

cursor.rewind()

count = 0

for _ in cursor:

break

cursor.rewind()

for _ in cursor:

count += 1

self.assertEqual(2, count)

self.assertEqual(cursor, cursor.rewind())

# oplog_reply, and snapshot are all deprecated.

@ignore_deprecations

def test_clone(self):

self.db.coll.insert_many([{"x": i} for i in range(1, 4)])

cursor = self.db.coll.find().limit(2)

count = 0

for _ in cursor:

count += 1

self.assertEqual(2, count)

count = 0

for _ in cursor:

count += 1

self.assertEqual(0, count)

cursor = cursor.clone()

cursor2 = cursor.clone()

count = 0

for _ in cursor:

count += 1

self.assertEqual(2, count)

for _ in cursor2:

count += 1

self.assertEqual(4, count)

cursor.rewind()

count = 0

for _ in cursor:

break

cursor = cursor.clone()

for _ in cursor:

count += 1

self.assertEqual(2, count)

self.assertNotEqual(cursor, cursor.clone())

# Just test attributes

cursor = (

self.db.coll.find(

{"x": re.compile("^hello.*")},

projection={"_id": False},

skip=1,

no_cursor_timeout=True,

cursor_type=CursorType.TAILABLE_AWAIT,

sort=[("x", 1)],

allow_partial_results=True,

oplog_replay=True,

batch_size=123,

collation={"locale": "en_US"},

hint=[("_id", 1)],

max_scan=100,

max_time_ms=1000,

return_key=True,

show_record_id=True,

snapshot=True,