rolling out new feature: make response from a query set using pyexcel v0.1.5

Author: chfw

pyexcel_webio/__init__.py

@@ -53,7 +53,7 @@ def load_book(self, **keywords):
         :returns: A instance of :class:`Book`
         """
         raise NotImplementedError("Please implement this function")
-        
+
     def get_sheet(self, sheet_name=None, **keywords):
         """
         Get a :class:`Sheet` instance from the file
@@ -116,14 +116,20 @@ def get_records(self, sheet_name=None, name_columns_by_row=0, **keywords):
         else:
             return None
 
-    def save_to_database(self, session=None, table=None,
-                         sheet_name=None, name_columns_by_row=0, name_rows_by_column=-1, **keywords):
-        sheet = self.load_single_sheet(sheet_name=sheet_name,
-                                       name_columns_by_row=name_columns_by_row,
-                                       name_rows_by_column=name_rows_by_column,
-                                       **keywords)
+    def save_to_database(
+            self,
+            session=None, table=None,
+            sheet_name=None, name_columns_by_row=0, name_rows_by_column=-1,
+            field_name=None,
+            **keywords):
+        sheet = self.load_single_sheet(
+            field_name=field_name,
+            sheet_name=sheet_name,
+            name_columns_by_row=name_columns_by_row,
+            name_rows_by_column=name_rows_by_column,
+            **keywords)
         if sheet:
-            sheet.save_to_database(session, table)
+            sheet.save_to_database(session, table, **keywords)
 
     def get_book(self, **keywords):
         """Get a instance of :class:`Book` from the file
@@ -147,10 +153,10 @@ def get_book_dict(self, **keywords):
         else:
             return None
 
-    def save_book_to_database(self, session=None, tables=None, **keywords):
-        book = self.load_book(**keywords)
+    def save_book_to_database(self, session=None, tables=None, field_name=None, **keywords):
+        book = self.load_book(field_name=field_name, **keywords)
         if book:
-            book.save_to_database(session, tables)
+            book.save_to_database(session, tables, **keywords)
 
 
 def dummy_func(content, content_type=None, status=200):
@@ -177,7 +183,7 @@ def make_response(pyexcel_instance, file_type, status=200, **keywords):
                         
     :param status: unless a different status is to be returned.
     """
-    io = pe._get_io(file_type)
+    io = pe.get_io(file_type)
     pyexcel_instance.save_to_memory(file_type, io, **keywords)
     io.seek(0)
     return ExcelResponse(io.read(), content_type=FILE_TYPE_MIME_TABLE[file_type], status=status)
@@ -199,6 +205,11 @@ def make_response_from_book_dict(adict, file_type, status=200, **keywords):
     return make_response(pe.Book(adict), file_type, status, **keywords)
 
 
+def make_response_from_query_sets(query_sets, column_names, file_type, status=200, **keywords):
+    sheet = pe.get_sheet(query_sets=query_sets, column_names=column_names)
+    return make_response(sheet, file_type, status, **keywords)
+
+
 def make_response_from_a_table(session, table, file_type, status=200, **keywords):
     sheet = pe.get_sheet(session=session, table=table, **keywords)
     return make_response(sheet, file_type, status, **keywords)

setup.py

@@ -9,13 +9,13 @@
     README_txt = readme.read()
 
 dependencies = [
-    'pyexcel>=0.1.2'
+    'pyexcel>=0.1.5'
 ]
 
 setup(
     name='pyexcel-webio',
     author="C. W.",
-    version='0.0.1',
+    version='0.0.2',
     author_email="[email protected]",
     url="https://github.com/chfw/pyexcel-webio",
     description='A generic request and response interface for pyexcel web extensions.',

tests/test_webio.py

@@ -46,37 +46,31 @@ def test_load_book(self):
         testinput = webio.ExcelInput()
         testinput.get_book(filename="test") # booom
 
-    @raises(IOError)
     def test_get_sheet(self):
         myinput = TestInput()
         sheet = myinput.get_sheet(unrelated="foo bar")
         assert sheet == None
 
-    @raises(IOError)
     def test_get_array(self):
         myinput = TestInput()
         array = myinput.get_array(unrelated="foo bar")
         assert array == None
 
-    @raises(IOError)
     def test_get_dict(self):
         myinput = TestInput()
         result = myinput.get_dict(unrelated="foo bar")
         assert result == None
 
-    @raises(IOError)
     def test_get_records(self):
         myinput = TestInput()
         result = myinput.get_records(unrelated="foo bar")
         assert result == None
 
-    @raises(IOError)
     def test_get_book(self):
         myinput = TestInput()
         result = myinput.get_book(unrelated="foo bar")
         assert result == None
 
-    @raises(IOError)
     def test_get_book_dict(self):
         myinput = TestInput()
         result = myinput.get_book_dict(unrelated="foo bar")
@@ -228,8 +222,27 @@ def test_make_response_from_table(self):
         self.verify()
         session.close()
 
+    def test_make_response_from_query_sets(self):
+        Base.metadata.drop_all(engine)
+        Base.metadata.create_all(engine)
+        row1 = Signature(X=1,Y=2, Z=3)
+        row2 = Signature(X=4, Y=5, Z=6)
+        session = Session()
+        session.add(row1)
+        session.add(row2)
+        session.commit()
+        query_sets=session.query(Signature).filter_by(X=1).all()
+        column_names= ["X", "Y", "Z"]
+        webio.make_response_from_query_sets(query_sets, column_names, "xls")
+        sheet2=pe.get_sheet(file_name=OUTPUT)
+        assert sheet2.to_array() == [
+            ["X", "Y", "Z"],
+            [1, 2, 3]
+        ]
+        session.close()
+
     def verify(self):
-        sheet2 = pe.load(OUTPUT)
+        sheet2 = pe.get_sheet(file_name=OUTPUT)
         assert sheet2.to_array() == self.data
 
     def tearDown(self):