bring isave_to_database and isave_book_to_database to sqlalchemy based extensions: Flask-Excel and pyramid-excel

Author: chfw

CHANGELOG.rst

@@ -1,14 +1,20 @@
 Change log
 ================================================================================
 
-0.1.2 - deferred
+0.1.2 - unreleased
 --------------------------------------------------------------------------------
 
 Added
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 #. To bring isave_as and isave_book_as to web clients
 
+Updated
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+#. replaced monkey-patching initialization step. For all extension developer,
+   please call init_webio(your_response_function)
+
 0.1.1 - 07.07.2017
 --------------------------------------------------------------------------------
 

pyexcel_webio.yaml

@@ -5,6 +5,6 @@ version: "0.1.2"
 current_version: "0.1.2"
 release: "0.1.1"
 dependencies:
-  - pyexcel>=0.4.0
+  - pyexcel>=0.6.0
 description:
   A generic request and response interface for pyexcel web extensions.

pyexcel_webio/__init__.py

@@ -169,6 +169,30 @@ def save_to_database(self, session=None, table=None,
         params['dest_auto_commit'] = auto_commit
         pe.save_as(**params)
 
+    def isave_to_database(self, session=None, table=None,
+                          initializer=None, mapdict=None,
+                          auto_commit=True,
+                          **keywords):
+        """
+        Save data from a sheet to database
+
+        :param session: a SQLAlchemy session
+        :param table: a database table
+        :param initializer: a custom table initialization function if
+                            you have one
+        :param mapdict: the explicit table column names if your excel
+                        data do not have the exact column names
+        :param keywords: additional keywords to
+                         :meth:`pyexcel.Sheet.save_to_database`
+        """
+        params = self.get_params(**keywords)
+        params['dest_session'] = session
+        params['dest_table'] = table
+        params['dest_initializer'] = initializer
+        params['dest_mapdict'] = mapdict
+        params['dest_auto_commit'] = auto_commit
+        pe.isave_as(**params)
+
     def get_book(self, **keywords):
         """Get a instance of :class:`Book` from the file
 
@@ -212,6 +236,31 @@ def save_book_to_database(self, session=None, tables=None,
         params['dest_auto_commit'] = auto_commit
         pe.save_book_as(**params)
 
+    def isave_book_to_database(self, session=None, tables=None,
+                               initializers=None, mapdicts=None,
+                               auto_commit=True, **keywords):
+        """
+        Save a book into database
+
+        :param session: a SQLAlchemy session
+        :param tables: a list of database tables
+        :param initializers: a list of model
+                             initialization functions.
+        :param mapdicts: a list of explicit table column names
+                         if your excel data sheets do not have
+                         the exact column names
+        :param keywords: additional keywords to
+                         :meth:`pyexcel.Book.save_to_database`
+
+        """
+        params = self.get_params(**keywords)
+        params['dest_session'] = session
+        params['dest_tables'] = tables
+        params['dest_initializers'] = initializers
+        params['dest_mapdicts'] = mapdicts
+        params['dest_auto_commit'] = auto_commit
+        pe.isave_book_as(**params)
+
     def free_resources(self):
         """
         After you have used iget_array and iget_records, it's

requirements.txt

@@ -1 +1 @@
-pyexcel>=0.4.0
+pyexcel>=0.6.0

rnd_requirements.txt

@@ -1,6 +1,3 @@
-https://github.com/chfw/lml/archive/master.zip
 https://github.com/pyexcel/pyexcel/archive/master.zip
-https://github.com/pyexcel/pyexcel-io/archive/v0.4.x.zip
-https://github.com/pyexcel/pyexcel-xls/archive/v0.4.x.zip
 
 

setup.py

@@ -49,7 +49,7 @@
 ]
 
 INSTALL_REQUIRES = [
-    'pyexcel>=0.4.0',
+    'pyexcel>=0.6.0',
 ]
 
 

tests/test_webio.py

@@ -141,6 +141,18 @@ def test_save_to_database(self):
         assert array == self.data
         self.session.close()
 
+    def test_isave_to_database(self):
+        Base.metadata.drop_all(engine)
+        Base.metadata.create_all(engine)
+        self.session = Session()
+        myinput = TestInput()
+        myinput.isave_to_database(file_name=self.testfile,
+                                  session=self.session,
+                                  table=Signature)
+        array = pe.get_array(session=self.session, table=Signature)
+        assert array == self.data
+        self.session.close()
+
     def tearDown(self):
         os.unlink(self.testfile)
 
@@ -227,6 +239,20 @@ def test_save_to_database(self):
         assert array == self.data1
         self.session.close()
 
+    def test_isave_to_database(self):
+        Base.metadata.drop_all(engine)
+        Base.metadata.create_all(engine)
+        self.session = Session()
+        myinput = TestInput()
+        myinput.isave_book_to_database(file_name=self.testfile,
+                                       session=self.session,
+                                       tables=[Signature, Signature2])
+        array = pe.get_array(session=self.session, table=Signature)
+        self.assertEqual(array, self.data)
+        array = pe.get_array(session=self.session, table=Signature2)
+        assert array == self.data1
+        self.session.close()
+
     def tearDown(self):
         os.unlink(self.testfile)