Docs for pymongo.uri_parser.

Author: behackett

doc/api/pymongo/index.rst

@@ -42,3 +42,4 @@ Deprecated sub-modules (moved to the :mod:`bson` package):
  son
  timestamp
  tz_util
+ uri_parser

doc/api/pymongo/uri_parser.rst

@@ -0,0 +1,6 @@
+:mod:`uri_parser` -- Tools to parse and validate a MongoDB URI
+==============================================================
+
+.. automodule:: pymongo.uri_parser
+ :synopsis: Tools to parse and validate a MongoDB URI.
+ :members:

pymongo/uri_parser.py

@@ -209,16 +209,16 @@ def split_hosts(hosts, default_port=DEFAULT_PORT):
 def parse_uri(uri, default_port=DEFAULT_PORT):
  """Parse and validate a MongoDB URI.
 
- Returns a dict of the form:
-
- {
- 'nodelist': <list of (host, port) tuples>,
- 'username': <username> or None,
- 'password': <password> or None,
- 'database': <database name> or None,
- 'collection': <collection name> or None,
- 'options': <dict of MongoDB URI options>
- }
+ Returns a dict of the form::
+
+  {
+  'nodelist': <list of (host, port) tuples>,
+  'username': <username> or None,
+  'password': <password> or None,
+  'database': <database name> or None,
+  'collection': <collection name> or None,
+  'options': <dict of MongoDB URI options>
+  }
 
  :Parameters:
  - `uri`: The MongoDB URI to parse.