Skip to content

Commit 5c38676

Browse files
ShaneHarveyShaneHarvey
authored
PYTHON-3359 Remove Database and Collection timeout override (#1009)
Remove MongoClient.timeout in favor of client.options.timeout.
1 parent c434861 commit 5c38676

10 files changed

+42
-8215
lines changed

‎pymongo/_csot.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ class _TimeoutContext(object):
5858
5959
Use :func:`pymongo.timeout` instead::
6060
61-
with client.timeout(0.5):
61+
with pymongo.timeout(0.5):
6262
client.test.test.insert_one({})
6363
"""
6464

‎pymongo/client_options.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ def read_concern(self):
265265

266266
@property
267267
def timeout(self) -> Optional[float]:
268-
"""The timeout.
268+
"""The configured timeoutMS converted to seconds, or None.
269269
270270
..versionadded: 4.2
271271
"""

‎pymongo/collection.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,6 @@ def __init__(
116116
write_concern: Optional[WriteConcern] = None,
117117
read_concern: Optional["ReadConcern"] = None,
118118
session: Optional["ClientSession"] = None,
119-
timeout: Optional[float] = None,
120119
**kwargs: Any,
121120
) -> None:
122121
"""Get / create a Mongo collection.
@@ -201,7 +200,6 @@ def __init__(
201200
read_preference or database.read_preference,
202201
write_concern or database.write_concern,
203202
read_concern or database.read_concern,
204-
timeout if timeout is not None else database.timeout,
205203
)
206204
if not isinstance(name, str):
207205
raise TypeError("name must be an instance of str")
@@ -395,7 +393,6 @@ def with_options(
395393
read_preference: Optional[_ServerMode] = None,
396394
write_concern: Optional[WriteConcern] = None,
397395
read_concern: Optional["ReadConcern"] = None,
398-
timeout: Optional[float] = None,
399396
) -> "Collection[_DocumentType]":
400397
"""Get a clone of this collection changing the specified settings.
401398
@@ -434,7 +431,6 @@ def with_options(
434431
read_preference or self.read_preference,
435432
write_concern or self.write_concern,
436433
read_concern or self.read_concern,
437-
timeout=timeout if timeout is not None else self.timeout,
438434
)
439435

440436
def bulk_write(

‎pymongo/common.py

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -831,7 +831,6 @@ def __init__(
831831
read_preference: _ServerMode,
832832
write_concern: WriteConcern,
833833
read_concern: ReadConcern,
834-
timeout: Optional[float],
835834
) -> None:
836835
if not isinstance(codec_options, CodecOptions):
837836
raise TypeError("codec_options must be an instance of bson.codec_options.CodecOptions")
@@ -855,12 +854,6 @@ def __init__(
855854
raise TypeError("read_concern must be an instance of pymongo.read_concern.ReadConcern")
856855
self.__read_concern = read_concern
857856

858-
if not isinstance(timeout, (int, float, type(None))):
859-
raise TypeError("timeout must be None, an int, or a float")
860-
if timeout and timeout < 0:
861-
raise TypeError("timeout cannot be negative")
862-
self.__timeout = float(timeout) if timeout else None
863-
864857
@property
865858
def codec_options(self) -> CodecOptions:
866859
"""Read only access to the :class:`~bson.codec_options.CodecOptions`
@@ -910,14 +903,6 @@ def read_concern(self) -> ReadConcern:
910903
"""
911904
return self.__read_concern
912905

913-
@property
914-
def timeout(self) -> Optional[float]:
915-
"""Read only access to the timeout of this instance.
916-
917-
.. versionadded:: 4.2
918-
"""
919-
return self.__timeout
920-
921906

922907
class _CaseInsensitiveDictionary(abc.MutableMapping):
923908
def __init__(self, *args, **kwargs):

‎pymongo/database.py

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,6 @@ def __init__(
7676
read_preference: Optional[_ServerMode] = None,
7777
write_concern: Optional["WriteConcern"] = None,
7878
read_concern: Optional["ReadConcern"] = None,
79-
timeout: Optional[float] = None,
8079
) -> None:
8180
"""Get a database by client and name.
8281
@@ -129,7 +128,6 @@ def __init__(
129128
read_preference or client.read_preference,
130129
write_concern or client.write_concern,
131130
read_concern or client.read_concern,
132-
timeout if timeout is not None else client.timeout,
133131
)
134132

135133
if not isinstance(name, str):
@@ -157,7 +155,6 @@ def with_options(
157155
read_preference: Optional[_ServerMode] = None,
158156
write_concern: Optional["WriteConcern"] = None,
159157
read_concern: Optional["ReadConcern"] = None,
160-
timeout: Optional[float] = None,
161158
) -> "Database[_DocumentType]":
162159
"""Get a clone of this database changing the specified settings.
163160
@@ -197,7 +194,6 @@ def with_options(
197194
read_preference or self.read_preference,
198195
write_concern or self.write_concern,
199196
read_concern or self.read_concern,
200-
timeout if timeout is not None else self.timeout,
201197
)
202198

203199
def __eq__(self, other: Any) -> bool:
@@ -246,7 +242,6 @@ def get_collection(
246242
read_preference: Optional[_ServerMode] = None,
247243
write_concern: Optional["WriteConcern"] = None,
248244
read_concern: Optional["ReadConcern"] = None,
249-
timeout: Optional[float] = None,
250245
) -> Collection[_DocumentType]:
251246
"""Get a :class:`~pymongo.collection.Collection` with the given name
252247
and options.
@@ -293,7 +288,6 @@ def get_collection(
293288
read_preference,
294289
write_concern,
295290
read_concern,
296-
timeout=timeout,
297291
)
298292

299293
def create_collection(
@@ -304,7 +298,6 @@ def create_collection(
304298
write_concern: Optional["WriteConcern"] = None,
305299
read_concern: Optional["ReadConcern"] = None,
306300
session: Optional["ClientSession"] = None,
307-
timeout: Optional[float] = None,
308301
check_exists: Optional[bool] = True,
309302
**kwargs: Any,
310303
) -> Collection[_DocumentType]:
@@ -459,7 +452,6 @@ def create_collection(
459452
write_concern,
460453
read_concern,
461454
session=s,
462-
timeout=timeout,
463455
**kwargs,
464456
)
465457

‎pymongo/mongo_client.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -789,7 +789,6 @@ def __init__(
789789
options.read_preference,
790790
options.write_concern,
791791
options.read_concern,
792-
options.timeout,
793792
)
794793

795794
self._topology_settings = TopologySettings(
@@ -1955,7 +1954,6 @@ def get_database(
19551954
read_preference: Optional[_ServerMode] = None,
19561955
write_concern: Optional[WriteConcern] = None,
19571956
read_concern: Optional["ReadConcern"] = None,
1958-
timeout: Optional[float] = None,
19591957
) -> database.Database[_DocumentType]:
19601958
"""Get a :class:`~pymongo.database.Database` with the given name and
19611959
options.
@@ -2006,7 +2004,7 @@ def get_database(
20062004
name = self.__default_database_name
20072005

20082006
return database.Database(
2009-
self, name, codec_options, read_preference, write_concern, read_concern, timeout
2007+
self, name, codec_options, read_preference, write_concern, read_concern
20102008
)
20112009

20122010
def _database_default_options(self, name):

‎test/csot/command-execution.json

Lines changed: 37 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@
6161
"useMultipleMongoses": false,
6262
"uriOptions": {
6363
"appName": "reduceMaxTimeMSTest",
64-
"w": 1
64+
"w": 1,
65+
"timeoutMS": 500
6566
},
6667
"observeEvents": [
6768
"commandStartedEvent"
@@ -75,35 +76,16 @@
7576
"databaseName": "test"
7677
}
7778
},
78-
{
79-
"collection": {
80-
"id": "regularCollection",
81-
"database": "database",
82-
"collectionName": "coll"
83-
}
84-
},
8579
{
8680
"collection": {
8781
"id": "timeoutCollection",
8882
"database": "database",
89-
"collectionName": "timeoutColl",
90-
"collectionOptions": {
91-
"timeoutMS": 60
92-
}
83+
"collectionName": "timeoutColl"
9384
}
9485
}
9586
]
9687
}
9788
},
98-
{
99-
"name": "insertOne",
100-
"object": "regularCollection",
101-
"arguments": {
102-
"document": {
103-
"_id": 1
104-
}
105-
}
106-
},
10789
{
10890
"name": "insertOne",
10991
"object": "timeoutCollection",
@@ -118,26 +100,14 @@
118100
{
119101
"client": "client",
120102
"events": [
121-
{
122-
"commandStartedEvent": {
123-
"commandName": "insert",
124-
"databaseName": "test",
125-
"command": {
126-
"insert": "coll",
127-
"maxTimeMS": {
128-
"$$exists": false
129-
}
130-
}
131-
}
132-
},
133103
{
134104
"commandStartedEvent": {
135105
"commandName": "insert",
136106
"databaseName": "test",
137107
"command": {
138108
"insert": "timeoutColl",
139109
"maxTimeMS": {
140-
"$$lte": 60
110+
"$$lte": 500
141111
}
142112
}
143113
}
@@ -180,7 +150,8 @@
180150
"useMultipleMongoses": false,
181151
"uriOptions": {
182152
"appName": "rttTooHighTest",
183-
"w": 1
153+
"w": 1,
154+
"timeoutMS": 10
184155
},
185156
"observeEvents": [
186157
"commandStartedEvent"
@@ -194,33 +165,50 @@
194165
"databaseName": "test"
195166
}
196167
},
197-
{
198-
"collection": {
199-
"id": "regularCollection",
200-
"database": "database",
201-
"collectionName": "coll"
202-
}
203-
},
204168
{
205169
"collection": {
206170
"id": "timeoutCollection",
207171
"database": "database",
208-
"collectionName": "timeoutColl",
209-
"collectionOptions": {
210-
"timeoutMS": 2
211-
}
172+
"collectionName": "timeoutColl"
212173
}
213174
}
214175
]
215176
}
216177
},
217178
{
218179
"name": "insertOne",
219-
"object": "regularCollection",
180+
"object": "timeoutCollection",
220181
"arguments": {
221182
"document": {
222-
"_id": 1
183+
"_id": 2
223184
}
185+
},
186+
"expectError": {
187+
"isTimeoutError": true
188+
}
189+
},
190+
{
191+
"name": "insertOne",
192+
"object": "timeoutCollection",
193+
"arguments": {
194+
"document": {
195+
"_id": 2
196+
}
197+
},
198+
"expectError": {
199+
"isTimeoutError": true
200+
}
201+
},
202+
{
203+
"name": "insertOne",
204+
"object": "timeoutCollection",
205+
"arguments": {
206+
"document": {
207+
"_id": 2
208+
}
209+
},
210+
"expectError": {
211+
"isTimeoutError": true
224212
}
225213
},
226214
{
@@ -239,20 +227,7 @@
239227
"expectEvents": [
240228
{
241229
"client": "client",
242-
"events": [
243-
{
244-
"commandStartedEvent": {
245-
"commandName": "insert",
246-
"databaseName": "test",
247-
"command": {
248-
"insert": "coll",
249-
"maxTimeMS": {
250-
"$$exists": false
251-
}
252-
}
253-
}
254-
}
255-
]
230+
"events": []
256231
}
257232
]
258233
}

0 commit comments

Comments
 (0)