Skip to content

Commit dde28d7

Browse files
committed
PYTHON-2393 Document unicode error handler for MongoClient
1 parent 907bb7e commit dde28d7

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

pymongo/mongo_client.py

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -189,25 +189,25 @@ def __init__(
189189
- `port` (optional): port number on which to connect
190190
- `document_class` (optional): default class to use for
191191
documents returned from queries on this client
192-
- `type_registry` (optional): instance of
193-
:class:`~bson.codec_options.TypeRegistry` to enable encoding
194-
and decoding of custom types.
195192
- `tz_aware` (optional): if ``True``,
196193
:class:`~datetime.datetime` instances returned as values
197194
in a document by this :class:`MongoClient` will be timezone
198195
aware (otherwise they will be naive)
199196
- `connect` (optional): if ``True`` (the default), immediately
200197
begin connecting to MongoDB in the background. Otherwise connect
201198
on the first operation.
199+
- `type_registry` (optional): instance of
200+
:class:`~bson.codec_options.TypeRegistry` to enable encoding
201+
and decoding of custom types.
202+
203+
| **Other optional parameters can be passed as keyword arguments:**
204+
202205
- `directConnection` (optional): if ``True``, forces this client to
203206
connect directly to the specified MongoDB host as a standalone.
204207
If ``false``, the client connects to the entire replica set of
205208
which the given MongoDB host(s) is a part. If this is ``True``
206209
and a mongodb+srv:// URI or a URI containing multiple seeds is
207210
provided, an exception will be raised.
208-
209-
| **Other optional parameters can be passed as keyword arguments:**
210-
211211
- `maxPoolSize` (optional): The maximum allowable number of
212212
concurrent connections to each connected server. Requests to a
213213
server will block if there are `maxPoolSize` outstanding
@@ -338,6 +338,10 @@ def __init__(
338338
`csharpLegacy`, `standard` and `unspecified`. New applications
339339
should consider setting this to `standard` for cross language
340340
compatibility. See :ref:`handling-uuid-data-example` for details.
341+
- `unicode_decode_error_handler`: The error handler to apply when
342+
a Unicode-related error occurs during BSON decoding that would
343+
otherwise raise :exc:`UnicodeDecodeError`. Valid options include
344+
'strict', 'replace', and 'ignore'. Defaults to 'strict'.
341345
342346
| **Write Concern options:**
343347
| (Only set if passed. No default values.)

0 commit comments

Comments
 (0)