Browse Source

Documented send_from_directory

pull/112/head
Armin Ronacher 15 years ago
parent
commit
c34b03e9a6
  1. 1
      CHANGES
  2. 2
      docs/api.rst
  3. 9
      flask/helpers.py

1
CHANGES

@ -24,6 +24,7 @@ Codename to be decided, release date to be announced.
- added support for per-package template and static-file directories.
- removed support for `create_jinja_loader` which is no longer used
in 0.5 due to the improved module support.
- added a helper function to expose files from any directory.
Version 0.4
-----------

2
docs/api.rst

@ -230,6 +230,8 @@ Useful Functions and Classes
.. autofunction:: send_file
.. autofunction:: send_from_directory
.. autofunction:: escape
.. autoclass:: Markup

9
flask/helpers.py

@ -303,6 +303,15 @@ def send_from_directory(directory, filename, **options):
return send_from_directory(app.config['UPLOAD_FOLDER'],
filename, as_attachment=True)
.. admonition:: Sending files and Performance
It is strongly recommended to activate either `X-Sendfile` support in
your webserver or (if no authentication happens) to tell the webserver
to serve files for the given path on its own without calling into the
web application for improved performance.
.. versionadded:: 0.5
:param directory: the directory where all the files are stored.
:param filename: the filename relative to that directory to
download.

Loading…
Cancel
Save