kwargs docs; remove engine; "fix" test

Author: aclark4life

README.md

@@ -121,9 +121,9 @@ DATABASES = {
 `OPTIONS` is an optional dictionary of parameters that will be passed to
 [`MongoClient`](https://pymongo.readthedocs.io/en/stable/api/pymongo/mongo_client.html).
 
-Alternatively, those that follow the [twelve-factor app methodology](
-https://www.12factor.net/backing-services) can configure Django's `DATABASES`
-with `django_mongodb.parse_uri(MONGODB_URI)`:
+Alternatively, those that follow the [twelve-factor app](
+https://www.12factor.net/backing-services) methodology can configure Django's
+`DATABASES` with `django_mongodb.parse_uri(MONGODB_URI)`:
 
 ```python
 import django_mongodb
@@ -132,6 +132,22 @@ MONGODB_URI = "mongodb+srv://myDatabaseUser:D1fficultP%[email protected]
 DATABASES["default"] = django_mongodb.parse_uri(MONGODB_URI)
 ```
 
+#### Additional options
+
+`parse_uri` also accepts these keyword arguments:
+
+| Argument             | Default               |
+| -------------------- | --------------------- |
+| `conn_max_age`       | `0`                   |
+| `conn_health_checks` | `False`               |
+| `test`               | `{}`                  |
+
+`conn_max_age` and `conn_health_checks` can be used with [persistent database
+connections](https://docs.djangoproject.com/en/latest/ref/databases/#persistent-database-connections)
+
+`test` can be used to provide a dictionary of [settings for test databases](
+https://docs.djangoproject.com/en/latest/ref/settings/#test).
+
 Congratulations, your project is ready to go!
 
 ## Notes on Django QuerySets

django_mongodb/utils.py

@@ -26,7 +26,7 @@ def check_django_compatability():
         )
 
 
-def parse_uri(uri, engine="django_mongodb", conn_max_age=None, conn_health_checks=None, test=None):
+def parse_uri(uri, conn_max_age=0, conn_health_checks=False, test=None):
     """
     Parse a MongoDB URI and return a dictionary of Django database
     settings. This function is a wrapper around PyMongo's
@@ -49,22 +49,18 @@ def parse_uri(uri, engine="django_mongodb", conn_max_age=None, conn_health_check
             host = ",".join([f"{host}:{port}" for host, port in nodelist])
 
     settings_dict = {
-        "ENGINE": engine,
+        "ENGINE": "django_mongodb",
         "NAME": uri["database"],
         "HOST": host,
         "PORT": port,
         "USER": uri.get("username"),
         "PASSWORD": uri.get("password"),
         "OPTIONS": uri.get("options"),
+        "CONN_MAX_AGE": conn_max_age,
+        "CONN_HEALTH_CHECKS": conn_health_checks,
     }
 
-    if conn_max_age is not None:
-        settings_dict["CONN_MAX_AGE"] = conn_max_age
-
-    if conn_health_checks is not None:
-        settings_dict["CONN_HEALTH_CHECKS"] = conn_health_checks
-
-    if test is not None:
+    if test:
         settings_dict["TEST"] = test
 
     return settings_dict

tests/utils_/test_parse.py

@@ -52,11 +52,6 @@ def test_localhost_bad_credentials(self):
         with self.assertRaises(pymongo.errors.InvalidURI):
             django_mongodb.parse_uri("mongodb://:@localhost/myDatabase")
 
-    @patch("dns.resolver.resolve")
-    def test_engine_kwarg(self, mock_resolver):
-        settings_dict = django_mongodb.parse_uri(URI, engine="some_other_engine")
-        self.assertEqual(settings_dict["ENGINE"], "some_other_engine")
-
     @patch("dns.resolver.resolve")
     def test_conn_max_age_kwarg(self, mock_resolver):
         settings_dict = django_mongodb.parse_uri(URI, conn_max_age=600)