Ticket #5742: static_patterns.patch

django/conf/urls/defaults.py

@@ -1 +1 @@
 from django.core.urlresolvers import RegexURLPattern, RegexURLResolver
 from django.core.exceptions import ImproperlyConfigured
 
-__all__ = ['handler404', 'handler500', 'include', 'patterns', 'url']
+__all__ = ['handler404', 'handler500', 'include', 'patterns', 'url',
+           'static_pattern']
 
 handler404 = 'django.views.defaults.page_not_found'
 handler500 = 'django.views.defaults.server_error'
@@ -30 +31 @@
                 view = prefix + '.' + view
         return RegexURLPattern(regex, view, kwargs, name)
 
+def static_pattern(url=None, root=None, name=None, kwargs=None, debug_only=True):
+    from django.conf import settings
+    from django.views.static import serve
+    if debug_only and not settings.DEBUG:
+        return []
+    # Default to using MEDIA_URL and MEDIA_ROOT from settings.
+    if url is None:
+        url = settings.MEDIA_URL
+    if root is None:
+        root = settings.MEDIA_ROOT
+    # Don't add anything if either is blank
+    if not url or not root:
+        return []
+    # Can't do a static pattern for a remote.
+    if '://' in url or not url:
+        return []
+    # Remove any prepending '/' from the URL - we don't want it for the regex.
+    regex = r'^%s(?P<path>.*)' % url.lstrip('/')
+    kwargs = kwargs or {}
+    kwargs.update({'document_root': root})
+    return [RegexURLPattern(regex, serve, kwargs, name)]

docs/static_files.txt

@@ -123 +123 @@
 in your production settings file. But you should be doing that anyway.
 
 .. _DEBUG setting: ../settings/#debug
+
+``static_patterns`` shortcut
+============================
+
+To make this even simpler, a shortcut is also imported along with the other
+``django.conf.urls.defaults`` called ``static_patterns``.
+
+The most common usage, serving files from ``MEDIA_ROOT`` to ``MEDIA_URL`` when
+``DEBUG`` is ``True``, can be achieved by simply adding the following to the end
+of your URLconf::
+
+    urlpatterns += static_pattern()
+
+You can specify options to ``static_pattern`` to customize it's usage:
+
+    ===============  ===========================================================
+    Argument         Description
+    ===============  ===========================================================
+    ``url``          The URL which files are served to. Defaults to
+                     ``MEDIA_URL``.
+    ``root``         The root of the filesystem to serve files from. Defaults to
+                     ``MEDIA_ROOT``.
+    ``name``         Name the URL pattern.
+    ``kwargs``       A dictionary of extra arguments (such as ``show_indexes``)
+                     to pass to the ``serve`` view.
+    ``debug_only``   If ``True``, only serves the files if ``DEBUG`` is
+                     ``True``. Defaults to ``True``.
+    ===============  ===========================================================
+
+In addition to the ``debug_only`` argument test, files will not get served if
+``url`` or ``root`` are empty, or if ``url`` is a remote URL.