Browse files

Documented send_from_directory

  • Loading branch information...
1 parent ac13def commit c34b03e9a677e467ea420d4286d4350ed429a4b8 @mitsuhiko mitsuhiko committed Jul 5, 2010
Showing with 12 additions and 0 deletions.
  1. +1 −0 CHANGES
  2. +2 −0 docs/api.rst
  3. +9 −0 flask/helpers.py
View
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
-----------
View
2 docs/api.rst
@@ -230,6 +230,8 @@ Useful Functions and Classes
.. autofunction:: send_file
+.. autofunction:: send_from_directory
+
.. autofunction:: escape
.. autoclass:: Markup
View
9 flask/helpers.py
@@ -303,6 +303,15 @@ def download_file(filename):
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.

0 comments on commit c34b03e

Please sign in to comment.