Small docstring change to django.views.static

git-svn-id: http://code.djangoproject.com/svn/django/trunk@1094 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Adrian Holovaty 2005-11-06 21:54:37 +00:00
parent 24f666656f
commit f6ce403140
1 changed files with 8 additions and 8 deletions

View File

@ -10,25 +10,25 @@ from django.core.template import Template, Context, TemplateDoesNotExist
def serve(request, path, document_root=None, show_indexes=False): def serve(request, path, document_root=None, show_indexes=False):
""" """
Serve static files below a given point in the directory structure. Serve static files below a given point in the directory structure.
To use, put a URL pattern like:: To use, put a URL pattern such as::
(r'^(?P<path>.*)$', 'django.views.static.serve', {'document_root' : '/path/to/my/files/'}) (r'^(?P<path>.*)$', 'django.views.static.serve', {'document_root' : '/path/to/my/files/'})
in your URL conf; you must provide the ``document_root`` param. You may in your URLconf. You must provide the ``document_root`` param. You may
also set ``show_indexes`` to ``True`` if you'd like to serve a basic index also set ``show_indexes`` to ``True`` if you'd like to serve a basic index
of the directory. This index view will use the template hardcoded below, of the directory. This index view will use the template hardcoded below,
but if you'd like to override it, you can create a template called but if you'd like to override it, you can create a template called
``static/directory_index``. ``static/directory_index``.
""" """
# Clean up given path to only allow serving files below document_root. # Clean up given path to only allow serving files below document_root.
path = posixpath.normpath(urllib.unquote(path)) path = posixpath.normpath(urllib.unquote(path))
newpath = '' newpath = ''
for part in path.split('/'): for part in path.split('/'):
if not part: if not part:
# strip empty path components # strip empty path components
continue continue
drive, part = os.path.splitdrive(part) drive, part = os.path.splitdrive(part)
head, part = os.path.split(part) head, part = os.path.split(part)
if part in (os.curdir, os.pardir): if part in (os.curdir, os.pardir):
@ -67,7 +67,7 @@ DEFAULT_DIRECTORY_INDEX_TEMPLATE = """
</body> </body>
</html> </html>
""" """
def directory_index(path, fullpath): def directory_index(path, fullpath):
try: try:
t = template_loader.get_template('static/directory_index') t = template_loader.get_template('static/directory_index')