Warn email schema console:// to be deprecated

Apps using schema console:// still works, which is converted to
consolemail:// internally in order to work with django-environ.
Meanwhile, a deprecation warning is output for console://.

Signed-off-by: Chenxiong Qi <[email protected]>

Author: tkdchen

configurations/values.py

@@ -3,6 +3,7 @@
 import decimal
 import os
 import sys
+import warnings
 
 from django.core import validators
 from django.core.exceptions import ValidationError, ImproperlyConfigured
@@ -414,8 +415,24 @@ def setup(self, name):
         return value
 
 
+def env_email_url_config(cls, url, backend=None):
+    """
+    Convert schema to consolemail in order to be compatible with old
+    console:// schema.
+
+    This could be removed and set EmailURLValue.caster to Env.email_url_config
+    directly after the deprecation is removed.
+    """
+    if url.startswith('console://'):
+        warnings.warn('Email schema console:// is deprecated. Please use '
+                      'consolemail:// in new code.',
+                      DeprecationWarning)
+        url = url.replace('console://', 'consolemail://')
+    return Env.email_url_config(url, backend=backend)
+
+
 class EmailURLValue(CastingMixin, MultipleMixin, Value):
-    caster = Env.email_url_config
+    caster = env_email_url_config
     message = 'Cannot interpret email URL value {0!r}'
     late_binding = True
 

tests/test_values.py

@@ -411,14 +411,18 @@ def test_email_url_value(self):
                 'EMAIL_HOST_USER': '[email protected]',
                 'EMAIL_PORT': 587,
                 'EMAIL_USE_TLS': True})
-        with env(EMAIL_URL='consolemail://'):
+        with env(EMAIL_URL='console://'):
             self.assertEqual(value.setup('EMAIL_URL'), {
                 'EMAIL_BACKEND': 'django.core.mail.backends.console.EmailBackend',  # noqa: E501
                 'EMAIL_FILE_PATH': '',
                 'EMAIL_HOST': None,
                 'EMAIL_HOST_PASSWORD': None,
                 'EMAIL_HOST_USER': None,
                 'EMAIL_PORT': None})
+        with env(EMAIL_URL='console://'):
+            with patch('warnings.warn') as warn:
+                value.setup('EMAIL_URL')
+            warn.asset_called_once()
         with env(EMAIL_URL='smtps://[email protected]:[email protected]:wrong'):  # noqa: E501
             self.assertRaises(ValueError, value.setup, 'TEST')