Ticket #6218: t6218b.patch

django/conf/__init__.py

@@ -11 +11 @@
 import time     # Needed for Windows
 
 from django.conf import global_settings
+from django.core.exceptions import ImproperlyConfigured
 from django.utils.functional import LazyObject
 from django.utils import importlib
 
@@ -59 +60 @@
         return bool(self._wrapped)
     configured = property(configured)
 
-class Settings(object):
+
+class BaseSettings(object):
+    """
+    Common logic for settings whether set by a module or by the user.
+    """
+    def __setattr__(self, name, value):
+        if name == "MEDIA_URL" and value and value[-1] != '/':
+            import warnings
+            warnings.warn('If set, MEDIA_URL must end in a slash',
+                          category=PendingDeprecationWarning)
+        object.__setattr__(self, name, value)
+
+
+class Settings(BaseSettings):
     def __init__(self, settings_module):
         # update this dict from global settings (but only for ALL_CAPS settings)
         for setting in dir(global_settings):
@@ -108 +122 @@
             os.environ['TZ'] = self.TIME_ZONE
             time.tzset()
 
-class UserSettingsHolder(object):
+
+class UserSettingsHolder(BaseSettings):
     """
     Holder for user configured settings.
     """
@@ -132 +147 @@
     # For Python < 2.6:
     __members__ = property(lambda self: self.__dir__())
 
-settings = LazySettings()
 
+settings = LazySettings()

django/conf/global_settings.py

@@ -263 +263 @@
 MEDIA_ROOT = ''
 
 # URL that handles the media served from MEDIA_ROOT.
-# Example: "http://media.lawrence.com"
+# Example: "http://media.lawrence.com/"
 MEDIA_URL = ''
 
 # List of upload handler classes to be applied in order.

django/conf/project_template/settings.py

@@ -48 +48 @@
 MEDIA_ROOT = ''
 
 # URL that handles the media served from MEDIA_ROOT. Make sure to use a
-# trailing slash if there is a path component (optional in other cases).
-# Examples: "http://media.lawrence.com", "http://example.com/media/"
+# trailing slash.
+# Examples: "http://media.lawrence.com/", "http://example.com/media/"
 MEDIA_URL = ''
 
 # URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a

docs/ref/settings.txt

@@ -1072 +1072 @@
 Default: ``''`` (Empty string)
 
 URL that handles the media served from ``MEDIA_ROOT``.
-Example: ``"http://media.lawrence.com"``
+Example: ``"http://media.lawrence.com/"``
 
-Note that this should have a trailing slash if it has a path component.
-
-Good: ``"http://www.example.com/static/"``
-Bad: ``"http://www.example.com/static"``
+It must end in a slash if set to a non-empty value.
 
 .. setting:: MIDDLEWARE_CLASSES
 

docs/releases/1.3.txt

@@ -81 +81 @@
 encouraged you redeploy your Django instances using :doc:`mod_wsgi
 </howto/deployment/modwsgi>`.
 
+Other changes in Django 1.3
+===========================
+
+``MEDIA_URL`` must end in a slash
+---------------------------------
+
+Previously, the ``MEDIA_URL`` setting only required a trailing slash if it
+contained a suffix beyond the domain name.
+
+A trailing slash is now *required* for ``MEDIA_URL`` as long as it is not
+blank. This ensures there is a consistent way to combine ``MEDIA_URL`` in
+templates.
+
+Project settings modules which provide a ``MEDIA_URL`` without a trailing slash
+will now raise an ``PendingDeprecation`` warning.
+
+In Django 1.4 this same condition will raise an ``ImproperlyConfigured`` exception.
+
 What's new in Django 1.3
 ========================
 

tests/regressiontests/settings_tests/tests.py

@@ -1 +1 @@
 import unittest
-from django.conf import settings
+from django.conf import settings, UserSettingsHolder, global_settings
+
+def setattr_settings(settings_module, attr, value):
+    setattr(settings_module, attr, value)
+
 
 class SettingsTests(unittest.TestCase):
 
@@ -15 +19 @@
 
     def test_settings_delete_wrapped(self):
         self.assertRaises(TypeError, delattr, settings, '_wrapped')
+
+
+class MediaURLTests(unittest.TestCase):
+    settings_module = settings
+
+    def setUp(self):
+        self._original_media_url = self.settings_module.MEDIA_URL
+
+    def tearDown(self):
+        self.settings_module.MEDIA_URL = self._original_media_url
+
+    def test_blank(self):
+        """
+        If blank, no PendingDeprecationWarning error will be raised, even though it
+        doesn't end in a slash.
+        """
+        self.settings_module.MEDIA_URL = ''
+        self.assertEqual('', self.settings_module.MEDIA_URL)
+
+    def test_end_slash(self):
+        """
+        MEDIA_URL works if you end in a slash.
+        """
+        self.settings_module.MEDIA_URL = '/foo/'
+        self.assertEqual('/foo/', self.settings_module.MEDIA_URL)
+
+        self.settings_module.MEDIA_URL = 'http://media.foo.com/'
+        self.assertEqual('http://media.foo.com/',
+                         self.settings_module.MEDIA_URL)
+
+    def test_no_end_slash(self):
+        """
+        MEDIA_URL raises an PendingDeprecationWarning error if it doesn't end in a
+        slash.
+        """
+        import warnings
+        warnings.filterwarnings('error', 'If set, MEDIA_URL must end in a slash', PendingDeprecationWarning)
+
+        self.assertRaises(PendingDeprecationWarning, setattr_settings,
+                          self.settings_module, 'MEDIA_URL', '/foo')
+
+        self.assertRaises(PendingDeprecationWarning, setattr_settings,
+                          self.settings_module, 'MEDIA_URL',
+                          'http://media.foo.com')
+
+    def test_double_slash(self):
+        """
+        If a MEDIA_URL ends in more than one slash, presume they know what
+        they're doing.
+        """
+        self.settings_module.MEDIA_URL = '/stupid//'
+        self.assertEqual('/stupid//', self.settings_module.MEDIA_URL)
+
+        self.settings_module.MEDIA_URL = 'http://media.foo.com/stupid//'
+        self.assertEqual('http://media.foo.com/stupid//',
+                         self.settings_module.MEDIA_URL)
+
+
+class MediaURLUserSettingsHolderTests(unittest.TestCase):
+    settings_module = UserSettingsHolder(global_settings)
+ No newline at end of file