Merge branch 'allow-no-db-name'

Author: dcrosta

docs/index.rst

@@ -46,6 +46,13 @@ You can use :attr:`~flask_pymongo.PyMongo.db` directly in views:
         return render_template("index.html",
             online_users=online_users)
 
+.. note::
+
+    Previous versions of Flask-PyMongo required that the MongoDB URI
+    contained a database name; as of 2.2, this requirement is lifted. If
+    there is no database name, the :attr:`~flask_pymongo.PyMongo.db`
+    attribute will be ``None``.
+
 
 Compatibility
 -------------
@@ -129,13 +136,12 @@ Classes
 
    .. attribute:: cx
 
-      The :class:`~flask_pymongo.wrappers.MongoClient` or
-      :class:`~flask_pymongo.wrappers.MongoReplicaSetClient`, depending on
-      the type of connection described by the URI.
+      The :class:`~flask_pymongo.wrappers.MongoClient` connected to the
+      MongoDB server.
 
    .. attribute:: db
 
-      The :class:`~flask_pymongo.wrappers.Database` if a URI was used and it
+      The :class:`~flask_pymongo.wrappers.Database` if the URI used
       named a database, and ``None`` otherwise.
 
 
@@ -167,6 +173,12 @@ History and Contributors
 
 Changes:
 
+- 2.2.0: November 1, 2018
+
+  - `#114 <https://github.com/dcrosta/flask-pymongo/pull/114>`_ Accept
+    keyword arguments to :meth:`~flask_pymongo.PyMongo.save_file` (Andrew C.
+    Hawkins).
+
 - 2.1.0: August 6, 2018
 
   - `#114 <https://github.com/dcrosta/flask-pymongo/pull/114>`_ Accept

flask_pymongo/__init__.py

@@ -100,12 +100,6 @@ class PyMongo(object):
     variable, or as an argument to the constructor or ``init_app``. See
     :meth:`init_app` for more detail.
 
-    .. versionchanged:: 2.0
-
-       Flask-PyMongo no longer accepts many of the configuration variables
-       it did in previous versions. You must now use a MongoDB URI to
-       configure Flask-PyMongo.
-
     """
 
     def __init__(self, app=None, uri=None, *args, **kwargs):
@@ -118,18 +112,22 @@ def __init__(self, app=None, uri=None, *args, **kwargs):
     def init_app(self, app, uri=None, *args, **kwargs):
         """Initialize this :class:`PyMongo` for use.
 
-        Configure a :class:`~pymongo.mongo_client.MongoClient` or
-        :class:`~pymongo.mongo_replica_set_client.MongoReplicaSetClient`
+        Configure a :class:`~pymongo.mongo_client.MongoClient`
         in the following scenarios:
 
         1. If ``uri`` is not ``None``, pass the ``uri`` and any positional
-           or keyword arguments to MongoClient
+           or keyword arguments to :class:`~pymongo.mongo_client.MongoClient`
         2. If ``uri`` is ``None``, and a Flask config variable named
            ``MONGO_URI`` exists, use that as the ``uri`` as above.
 
         The caller is responsible for ensuring that additional positional
         and keyword arguments result in a valid call.
 
+        .. versionchanged:: 2.2
+
+           The ``uri`` is no longer required to contain a database name. If it
+           does not, then the :attr:`db` attribute will be ``None``.
+
         .. versionchanged:: 2.0
 
            Flask-PyMongo no longer accepts many of the configuration variables
@@ -149,16 +147,13 @@ def init_app(self, app, uri=None, *args, **kwargs):
         parsed_uri = uri_parser.parse_uri(uri)
         database_name = parsed_uri["database"]
 
-        # Avoid a more confusing error later when we try to get the DB
-        if not database_name:
-            raise ValueError("Your URI must specify a database name")
-
         # Try to delay connecting, in case the app is loaded before forking, per
         # http://api.mongodb.com/python/current/faq.html#is-pymongo-fork-safe
         kwargs.setdefault("connect", False)
 
         self.cx = MongoClient(*args, **kwargs)
-        self.db = self.cx[database_name]
+        if database_name:
+            self.db = self.cx[database_name]
 
         app.url_map.converters["ObjectId"] = BSONObjectIdConverter
 

flask_pymongo/tests/test_config.py

@@ -1,3 +1,4 @@
+from contextlib import contextmanager
 import time
 
 import pymongo
@@ -11,6 +12,14 @@ class CouldNotConnect(Exception):
     pass
 
 
+@contextmanager
+def doesnt_raise(exc=BaseException):
+    try:
+        yield
+    except exc:
+        pytest.fail("{} was raised but should not have been".format(exc))
+
+
 class FlaskPyMongoConfigTest(FlaskRequestTest):
 
     def setUp(self):
@@ -81,11 +90,13 @@ def test_it_doesnt_connect_by_default(self):
         with pytest.raises(CouldNotConnect):
             _wait_until_connected(mongo, timeout=0.2)
 
-    def test_it_requires_db_name_in_uri(self):
+    def test_it_doesnt_require_db_name_in_uri(self):
         uri = "mongodb://localhost:{}".format(self.port)
 
-        with pytest.raises(ValueError):
-            flask_pymongo.PyMongo(self.app, uri)
+        with doesnt_raise(Exception):
+            mongo = flask_pymongo.PyMongo(self.app, uri)
+
+        assert mongo.db is None
 
 
 def _wait_until_connected(mongo, timeout=1.0):