Merge pull request #8 from abehrens/file_name_override

credit goes to @abehrens, adding file_name option to make_response

Author: chfw

README.rst

@@ -85,9 +85,9 @@ Here are some example codes::
 
     from flask import Flask, request, jsonify
     from flask.ext import excel
-    
+
     app=Flask(__name__)
-    
+
     @app.route("/upload", methods=['GET', 'POST'])
     def upload_file():
         if request.method == 'POST':
@@ -100,11 +100,15 @@ Here are some example codes::
         <p><input type=file name=file><input type=submit value=Upload>
     	</form>
         '''
-    
+
     @app.route("/download", methods=['GET'])
     def download_file():
         return excel.make_response_from_array([[1,2], [3, 4]], "csv")
-    
+
+    @app.route("/export", methods=['GET'])
+    def export_records():
+        return excel.make_response_from_array([[1,2], [3, 4]], "csv", file_name="export_data")
+
     if __name__ == "__main__":
         app.run()
 

VERSION

@@ -101,6 +101,10 @@ A minimal application may look like this::
     def download_file():
         return excel.make_response_from_array([[1,2], [3, 4]], "csv")
 
+    @app.route("/export", methods=['GET'])
+    def export_records():
+        return excel.make_response_from_array([[1,2], [3, 4]], "csv", file_name="export_data")
+
     # insert database related code here
     
     if __name__ == "__main__":
@@ -351,51 +355,57 @@ Response methods
                         * 'ods'
 
       :param status: unless a different status is to be returned.
-            
-   .. method:: make_response_from_array(array, file_type, status=200)
+      :param file_name: provide a custom file name for the response, excluding the file extension
+
+   .. method:: make_response_from_array(array, file_type, status=200, file_name=None)
 
       :param array: a list of lists
       :param file_type: same as :meth:`~flask_excel.make_response`
       :param status: same as :meth:`~flask_excel.make_response`
-            
-   .. method:: make_response_from_dict(dict, file_type, status=200)
+      :param file_name: same as :meth:`~flask_excel.make_response`
+
+   .. method:: make_response_from_dict(dict, file_type, status=200, file_name=None)
 
       :param dict: a dictinary of lists
       :param file_type: same as :meth:`~flask_excel.make_response`
       :param status: same as :meth:`~flask_excel.make_response`
-            
-   .. method:: make_response_from_records(records, file_type, status=200)
+      :param file_name: same as :meth:`~flask_excel.make_response`
+
+   .. method:: make_response_from_records(records, file_type, status=200, file_name=None)
 
       :param records: a list of dictionaries
       :param file_type: same as :meth:`~flask_excel.make_response`
       :param status: same as :meth:`~flask_excel.make_response`
-            
-                
-   .. method:: make_response_from_book_dict(book_dict, file_type, status=200)
+      :param file_name: same as :meth:`~flask_excel.make_response`
+
+   .. method:: make_response_from_book_dict(book_dict, file_type, status=200, file_name=None)
 
       :param book_dict: a dictionary of two dimensional arrays
       :param file_type: same as :meth:`~flask_excel.make_response`
       :param status: same as :meth:`~flask_excel.make_response`
+      :param file_name: same as :meth:`~flask_excel.make_response`
 
-   .. method:: make_response_from_a_table(session, table, file_type status=200)
+   .. method:: make_response_from_a_table(session, table, file_type status=200, file_name=None)
 
       Produce a single sheet Excel book of *file_type*
 
       :param session: SQLAlchemy session
       :param table: a SQLAlchemy table
       :param file_type: same as :meth:`~flask_excel.make_response`
       :param status: same as :meth:`~flask_excel.make_response`
+      :param file_name: same as :meth:`~flask_excel.make_response`
 
-   .. method:: make_response_from_query_sets(query_sets, column_names, file_type status=200)
+   .. method:: make_response_from_query_sets(query_sets, column_names, file_type status=200, file_name=None)
 
       Produce a single sheet Excel book of *file_type* from your custom database queries
 
       :param query_sets: a query set
       :param column_names: a nominated column names. It could not be None, otherwise no data is returned.
       :param file_type: same as :meth:`~flask_excel.make_response`
       :param status: same as :meth:`~flask_excel.make_response`
+      :param file_name: same as :meth:`~flask_excel.make_response`
 
-   .. method:: make_response_from_tables(session, tables, file_type status=200)
+   .. method:: make_response_from_tables(session, tables, file_type status=200, file_name=None)
 
       Produce a multiple sheet Excel book of *file_type*. It becomes the same
       as :meth:`~flask_excel.make_response_from_a_table` if you pass *tables*
@@ -405,8 +415,9 @@ Response methods
       :param tables: SQLAlchemy tables
       :param file_type: same as :meth:`~flask_excel.make_response`
       :param status: same as :meth:`~flask_excel.make_response`
+      :param file_name: same as :meth:`~flask_excel.make_response`
+
 
-                
 Indices and tables
 --------------------
 

doc/source/index.rst

@@ -25,6 +25,10 @@ def upload_file():
 def download_file():
     return excel.make_response_from_array([[1,2], [3, 4]], "csv")
 
+@app.route("/export", methods=['GET'])
+def export_records():
+    return excel.make_response_from_array([[1,2], [3, 4]], "csv", file_name="export_data")
+
 # insert database related code here
 
 if __name__ == "__main__":

document.bat

@@ -18,20 +18,37 @@ def get_file_tuple(self, field_name):
         filename = filehandle.filename
         extension = filename.split(".")[1]
         return extension, filehandle
-    
 
 Flask.request_class = ExcelRequest
 webio.ExcelResponse = Response
 
-from pyexcel_webio import (
-    make_response,
-    make_response_from_array,
-    make_response_from_dict,
-    make_response_from_records,
-    make_response_from_book_dict,
-    make_response_from_a_table,
-    make_response_from_query_sets,
-    make_response_from_tables
-)
-
-__VERSION__ = '0.0.3'
+def add_file_name(response, file_name, file_type):
+    if file_name:
+        response.headers["Content-Disposition"] = "attachment; filename=%s.%s" % (file_name, file_type)
+    return response
+
+def make_response(pyexcel_instance, file_type, status=200, file_name=None, **keywords):
+    return add_file_name(webio.make_response(pyexcel_instance, file_type, status=status, **keywords), file_name, file_type)
+
+def make_response_from_array(array, file_type, status=200, file_name=None, **keywords):
+    return add_file_name(webio.make_response_from_array(array, file_type, status=status, **keywords), file_name, file_type)
+
+def make_response_from_dict(adict, file_type, status=200, file_name=None, **keywords):
+    return add_file_name(webio.make_response_from_dict(adict, file_type, status=status, **keywords), file_name, file_type)
+
+def make_response_from_records(records, file_type, status=200, file_name=None, **keywords):
+    return add_file_name(webio.make_response_from_records(records, file_type, status=status, **keywords), file_name, file_type)
+
+def make_response_from_book_dict(adict, file_type, status=200, file_name=None, **keywords):
+    return add_file_name(webio.make_response_from_book_dict(adict, file_type, status=status, **keywords), file_name, file_type)
+
+def make_response_from_a_table(session, table, file_type, status=200, file_name=None, **keywords):
+    return add_file_name(webio.make_response_from_a_table(session, table, file_type, status=status, **keywords), file_name, file_type)
+
+def make_response_from_query_sets(query_sets, column_names, file_type, status=200, file_name=None, **keywords):
+    return add_file_name(webio.make_response_from_query_sets(query_sets, column_names, file_type, status=status, **keywords), file_name, file_type)
+
+def make_response_from_tables(session, tables, file_type, status=200, file_name=None, **keywords):
+    return add_file_name(webio.make_response_from_tables(session, tables, file_type, status=status, **keywords), file_name, file_type)
+
+__VERSION__ = '0.0.4'

examples/tiny_example.py

@@ -44,3 +44,10 @@ def test_download(self):
                 array = sheet.to_array()
                 assert array == self.data
 
+    def test_override_file_name(self):
+        for file_type in FILE_TYPE_MIME_TABLE.keys():
+            file_name = 'override_file_name'
+            response = self.app.post('/file_name/%s/%s' % (file_type, file_name))
+            assert response.content_type == FILE_TYPE_MIME_TABLE[file_type]
+            assert response.headers.get("Content-Disposition", None) == ("attachment; filename=%s.%s" % (file_name, file_type))
+

flask_excel/__init__.py

@@ -4,6 +4,7 @@
 import pyexcel.ext.xls
 import pyexcel.ext.ods3
 import pyexcel.ext.xlsx
+import pyexcel as pe
 from flask.ext.sqlalchemy import SQLAlchemy
 from datetime import datetime
 
@@ -75,6 +76,10 @@ def switch(file_type):
     sheet = request.get_sheet(field_name='file')
     return excel.make_response(sheet, file_type)
 
+@app.route("/file_name/<file_type>/<file_name>", methods=['POST'])
+def swtich_file_name(file_type, file_name):
+    return excel.make_response(pe.Sheet(["a", "b", "c"]), file_type, file_name=file_name)
+
 @app.route("/exchange/<struct_type>", methods=['POST'])
 def upload_array(struct_type):
     if struct_type == "array":