Remove parse_uri() per deprecation timeline

Author: timgraham

django_mongodb_backend/__init__.py

@@ -2,7 +2,7 @@
 
 # Check Django compatibility before other imports which may fail if the
 # wrong version of Django is installed.
-from .utils import check_django_compatability, parse_uri
+from .utils import check_django_compatability
 
 check_django_compatability()
 
@@ -15,8 +15,6 @@
 from .lookups import register_lookups  # noqa: E402
 from .query import register_nodes  # noqa: E402
 
-__all__ = ["parse_uri"]
-
 register_aggregates()
 register_checks()
 register_expressions()

django_mongodb_backend/utils.py

@@ -1,16 +1,13 @@
 import copy
 import time
-import warnings
 
 import django
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured, ValidationError
 from django.db.backends.utils import logger
-from django.utils.deprecation import RemovedInDjango60Warning
 from django.utils.functional import SimpleLazyObject
 from django.utils.text import format_lazy
 from django.utils.version import get_version_tuple
-from pymongo.uri_parser import parse_uri as pymongo_parse_uri
 
 
 def check_django_compatability():
@@ -30,50 +27,6 @@ def check_django_compatability():
         )
 
 
-def parse_uri(uri, *, db_name=None, options=None, test=None):
-    """
-    Convert the given uri into a dictionary suitable for Django's DATABASES
-    setting.
-    """
-    warnings.warn(
-        'parse_uri() is deprecated. Put the connection string in DATABASES["HOST"] instead.',
-        RemovedInDjango60Warning,
-        stacklevel=2,
-    )
-    uri = pymongo_parse_uri(uri)
-    host = None
-    port = None
-    if uri["fqdn"]:
-        # This is a SRV URI and the host is the fqdn.
-        host = f"mongodb+srv://{uri['fqdn']}"
-    else:
-        nodelist = uri.get("nodelist")
-        if len(nodelist) == 1:
-            host, port = nodelist[0]
-        elif len(nodelist) > 1:
-            host = ",".join([f"{host}:{port}" for host, port in nodelist])
-    db_name = db_name or uri["database"]
-    if not db_name:
-        raise ImproperlyConfigured("You must provide the db_name parameter.")
-    opts = uri.get("options")
-    if options:
-        opts.update(options)
-    settings_dict = {
-        "ENGINE": "django_mongodb_backend",
-        "NAME": db_name,
-        "HOST": host,
-        "PORT": port,
-        "USER": uri.get("username"),
-        "PASSWORD": uri.get("password"),
-        "OPTIONS": opts,
-    }
-    if "authSource" not in settings_dict["OPTIONS"] and uri["database"]:
-        settings_dict["OPTIONS"]["authSource"] = uri["database"]
-    if test:
-        settings_dict["TEST"] = test
-    return settings_dict
-
-
 def prefix_validation_error(error, prefix, code, params):
     """
     Prefix a validation error message while maintaining the existing

docs/intro/configure.rst

@@ -122,7 +122,7 @@ If you have a connection string, you can provide it like this::
 .. versionchanged:: 5.2.1
 
     Support for the connection string in ``"HOST"`` was added. Previous
-    versions recommended using :func:`~django_mongodb_backend.utils.parse_uri`.
+    versions recommended using ``django_mongodb_backend.utils.parse_uri()``.
 
 Alternatively, you can separate the connection string so that your settings
 look more like what you usually see with Django. This constructs a

docs/ref/utils.rst

@@ -9,42 +9,4 @@ This document covers the public API parts of ``django_mongodb_backend.utils``.
 Most of the module's contents are designed for internal use and only the
 following parts can be considered stable.
 
-``parse_uri()``
-===============
-
-.. function:: parse_uri(uri, db_name=None, options=None, test=None)
-
-    .. deprecated:: 5.2.2
-
-        ``parse_uri()`` is deprecated in favor of putting the connection string
-        in ``DATABASES["HOST"]``. See :ref:`the deprecation timeline
-        <parse-uri-deprecation>` for upgrade instructions.
-
-    Parses a MongoDB `connection string`_ into a dictionary suitable for
-    Django's :setting:`DATABASES` setting.
-
-    .. _connection string: https://www.mongodb.com/docs/manual/reference/connection-string/
-
-    Example::
-
-        import django_mongodb_backend
-
-        MONGODB_URI = "mongodb+srv://my_user:my_password@cluster0.example.mongodb.net/defaultauthdb?retryWrites=true&w=majority&tls=false"
-        DATABASES["default"] = django_mongodb_backend.parse_uri(MONGODB_URI, db_name="example")
-
-    You must specify ``db_name`` (the :setting:`NAME` of your database) if the
-    URI doesn't specify ``defaultauthdb``.
-
-    You can use the parameters to customize the resulting :setting:`DATABASES`
-    setting:
-
-    - Use ``options`` to provide a dictionary of parameters to
-      :class:`~pymongo.mongo_client.MongoClient`. These will be merged with
-      (and, in the case of duplicates, take precedence over) any options
-      specified in the URI.
-
-    - Use ``test`` to provide a dictionary of settings for test databases in
-      the format of :setting:`TEST <DATABASE-TEST>`.
-
-    But for maximum flexibility, construct :setting:`DATABASES` manually as
-    described in :ref:`configuring-databases-setting`.
+(Currently there is nothing.)

docs/releases/5.0.x.rst

@@ -16,7 +16,7 @@ Django MongoDB Backend 5.0.x
   <django:persistent-database-connections>`.
 - Added :doc:`async <django:topics/async>` support.
 - Added the ``db_name`` parameter to
-  :func:`~django_mongodb_backend.utils.parse_uri`.
+  ``django_mongodb_backend.utils.parse_uri()``.
 - Added ``django_mongodb_backend.routers.MongoRouter`` to allow
   :djadmin:`dumpdata` to ignore embedded models. See
   :ref:`configuring-database-routers-setting`.

docs/releases/5.1.x.rst

@@ -61,7 +61,7 @@ Django MongoDB Backend 5.1.x
   <django:persistent-database-connections>`.
 - Added :doc:`async <django:topics/async>` support.
 - Added the ``db_name`` parameter to
-  :func:`~django_mongodb_backend.utils.parse_uri`.
+  ``django_mongodb_backend.utils.parse_uri()``.
 - Added ``django_mongodb_backend.routers.MongoRouter`` to allow
   :djadmin:`dumpdata` to ignore embedded models. See
   :ref:`configuring-database-routers-setting`.

docs/releases/5.2.x.rst

@@ -95,7 +95,7 @@ New features
 
 - Allowed :ref:`specifying the MongoDB connection string
   <configuring-databases-setting>` in ``DATABASES["HOST"]``, eliminating the
-  need to use :func:`~django_mongodb_backend.utils.parse_uri` to configure the
+  need to use ``django_mongodb_backend.utils.parse_uri()`` to configure the
   :setting:`DATABASES` setting.
 
 Bug fixes
@@ -144,7 +144,7 @@ New features
 - Added support for :doc:`Atlas Search queries </ref/models/search>`.
 - Added subquery support for :class:`~.fields.EmbeddedModelArrayField`.
 - Added the ``options`` parameter to
-  :func:`~django_mongodb_backend.utils.parse_uri`.
+  ``django_mongodb_backend.utils.parse_uri()``.
 - Added support for :ref:`database transactions <transactions>`.
 - Added :class:`~.fields.PolymorphicEmbeddedModelField` and
   :class:`~.fields.PolymorphicEmbeddedModelArrayField` for storing a model
@@ -231,7 +231,7 @@ Backwards incompatible changes
 
 - The minimum supported version of ``pymongo`` is increased from 4.6 to 4.7.
 - The ``conn_max_age`` parameter of
-  :func:`~django_mongodb_backend.utils.parse_uri` is removed because persistent
+  ``django_mongodb_backend.utils.parse_uri()`` is removed because persistent
   connections are now used by default.
 
 Bug fixes