forked from mongodb/mongo-python-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy patherrors.py
More file actions
268 lines (187 loc) · 8.06 KB
/
errors.py
File metadata and controls
268 lines (187 loc) · 8.06 KB
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
# Copyright 2009-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.
"""Exceptions raised by PyMongo."""
import sys
from bson.errors import *
try:
from ssl import CertificateError
except ImportError:
from pymongo.ssl_match_hostname import CertificateError
class PyMongoError(Exception):
"""Base class for all PyMongo exceptions."""
def __init__(self, message='', error_labels=None):
super(PyMongoError, self).__init__(message)
self._message = message
self._error_labels = set(error_labels or [])
def has_error_label(self, label):
"""Return True if this error contains the given label.
.. versionadded:: 3.7
"""
return label in self._error_labels
def _add_error_label(self, label):
"""Add the given label to this error."""
self._error_labels.add(label)
def _remove_error_label(self, label):
"""Remove the given label from this error."""
self._error_labels.remove(label)
def __str__(self):
if sys.version_info[0] == 2 and isinstance(self._message, unicode):
return self._message.encode('utf-8', errors='replace')
return str(self._message)
class ProtocolError(PyMongoError):
"""Raised for failures related to the wire protocol."""
class ConnectionFailure(PyMongoError):
"""Raised when a connection to the database cannot be made or is lost."""
def __init__(self, message='', error_labels=None):
if error_labels is None:
# Connection errors are transient errors by default.
error_labels = ("TransientTransactionError",)
super(ConnectionFailure, self).__init__(
message, error_labels=error_labels)
class AutoReconnect(ConnectionFailure):
"""Raised when a connection to the database is lost and an attempt to
auto-reconnect will be made.
In order to auto-reconnect you must handle this exception, recognizing that
the operation which caused it has not necessarily succeeded. Future
operations will attempt to open a new connection to the database (and
will continue to raise this exception until the first successful
connection is made).
Subclass of :exc:`~pymongo.errors.ConnectionFailure`.
"""
def __init__(self, message='', errors=None):
super(AutoReconnect, self).__init__(message)
self.errors = self.details = errors or []
class NetworkTimeout(AutoReconnect):
"""An operation on an open connection exceeded socketTimeoutMS.
The remaining connections in the pool stay open. In the case of a write
operation, you cannot know whether it succeeded or failed.
Subclass of :exc:`~pymongo.errors.AutoReconnect`.
"""
class NotMasterError(AutoReconnect):
"""The server responded "not master" or "node is recovering".
These errors result from a query, write, or command. The operation failed
because the client thought it was using the primary but the primary has
stepped down, or the client thought it was using a healthy secondary but
the secondary is stale and trying to recover.
The client launches a refresh operation on a background thread, to update
its view of the server as soon as possible after throwing this exception.
Subclass of :exc:`~pymongo.errors.AutoReconnect`.
"""
class ServerSelectionTimeoutError(AutoReconnect):
"""Thrown when no MongoDB server is available for an operation
If there is no suitable server for an operation PyMongo tries for
``serverSelectionTimeoutMS`` (default 30 seconds) to find one, then
throws this exception. For example, it is thrown after attempting an
operation when PyMongo cannot connect to any server, or if you attempt
an insert into a replica set that has no primary and does not elect one
within the timeout window, or if you attempt to query with a Read
Preference that the replica set cannot satisfy.
"""
class ConfigurationError(PyMongoError):
"""Raised when something is incorrectly configured.
"""
class OperationFailure(PyMongoError):
"""Raised when a database operation fails.
.. versionadded:: 2.7
The :attr:`details` attribute.
"""
def __init__(self, error, code=None, details=None):
error_labels = None
if details is not None:
error_labels = details.get('errorLabels')
super(OperationFailure, self).__init__(
error, error_labels=error_labels)
self.__code = code
self.__details = details
@property
def code(self):
"""The error code returned by the server, if any.
"""
return self.__code
@property
def details(self):
"""The complete error document returned by the server.
Depending on the error that occurred, the error document
may include useful information beyond just the error
message. When connected to a mongos the error document
may contain one or more subdocuments if errors occurred
on multiple shards.
"""
return self.__details
class CursorNotFound(OperationFailure):
"""Raised while iterating query results if the cursor is
invalidated on the server.
.. versionadded:: 2.7
"""
class ExecutionTimeout(OperationFailure):
"""Raised when a database operation times out, exceeding the $maxTimeMS
set in the query or command option.
.. note:: Requires server version **>= 2.6.0**
.. versionadded:: 2.7
"""
class WriteConcernError(OperationFailure):
"""Base exception type for errors raised due to write concern.
.. versionadded:: 3.0
"""
class WriteError(OperationFailure):
"""Base exception type for errors raised during write operations.
.. versionadded:: 3.0
"""
class WTimeoutError(WriteConcernError):
"""Raised when a database operation times out (i.e. wtimeout expires)
before replication completes.
With newer versions of MongoDB the `details` attribute may include
write concern fields like 'n', 'updatedExisting', or 'writtenTo'.
.. versionadded:: 2.7
"""
class DuplicateKeyError(WriteError):
"""Raised when an insert or update fails due to a duplicate key error."""
class BulkWriteError(OperationFailure):
"""Exception class for bulk write errors.
.. versionadded:: 2.7
"""
def __init__(self, results):
super(BulkWriteError, self).__init__(
"batch op errors occurred", 65, results)
class InvalidOperation(PyMongoError):
"""Raised when a client attempts to perform an invalid operation."""
class InvalidName(PyMongoError):
"""Raised when an invalid name is used."""
class CollectionInvalid(PyMongoError):
"""Raised when collection validation fails."""
class InvalidURI(ConfigurationError):
"""Raised when trying to parse an invalid mongodb URI."""
class ExceededMaxWaiters(PyMongoError):
"""Raised when a thread tries to get a connection from a pool and
``maxPoolSize * waitQueueMultiple`` threads are already waiting.
.. versionadded:: 2.6
"""
pass
class DocumentTooLarge(InvalidDocument):
"""Raised when an encoded document is too large for the connected server.
"""
pass
class EncryptionError(PyMongoError):
"""Raised when encryption or decryption fails.
This error always wraps another exception which can be retrieved via the
:attr:`cause` property.
.. versionadded:: 3.9
"""
def __init__(self, cause):
super(EncryptionError, self).__init__(str(cause))
self.__cause = cause
@property
def cause(self):
"""The exception that caused this encryption or decryption error."""
return self.__cause