implemented, documented and tested database operations

Author: chfw

db.sqlite3

@@ -74,10 +74,26 @@ def new_file(self, file_name, *args, **kwargs):
     make_response_from_book_dict,
 )
 
-def make_response_from_a_model(model, file_type, status=200, **keywords):
-    sheet = pe.get_sheet(model, **keywords)
+def make_response_from_a_table(model, file_type, status=200, **keywords):
+    """
+    Produce a single sheet Excel book of *file_type*
+
+    :param model: a Django model
+    :param file_type: same as :meth:`~django_excel.make_response`
+    :param status: same as :meth:`~django_excel.make_response`
+    """
+    sheet = pe.get_sheet(model=model, **keywords)
     return make_response(sheet, file_type, status, **keywords)
 
-def make_response_from_models(models, file_type, status=200, **keywords):
-    book = pe.get_book(models, **keywords)
+def make_response_from_tables(models, file_type, status=200, **keywords):
+    """
+    Produce a multiple sheet Excel book of *file_type*. It becomes the same
+    as :meth:`~django_excel.make_response_from_a_table` if you pass *tables*
+    with an array that has a single table
+    
+    :param models: a list of Django models
+    :param file_type: same as :meth:`~django_excel.make_response`
+    :param status: same as :meth:`~django_excel.make_response`
+    """    
+    book = pe.get_book(models=models, **keywords)
     return make_response(book, file_type, status, **keywords)

django_excel/__init__.py

@@ -230,25 +230,8 @@ Response methods
       :param file_type: same as :meth:`~django_excel.make_response`
       :param status: same as :meth:`~django_excel.make_response`
 
-   .. method:: make_response_from_a_table(session, table, file_type status=200)
-
-      Produce a single sheet Excel book of *file_type*
-
-      :param session: SQLAlchemy session
-      :param table: a SQLAlchemy table
-      :param file_type: same as :meth:`~django_excel.make_response`
-      :param status: same as :meth:`~django_excel.make_response`
-
-   .. method:: make_response_from_tables(session, tables, file_type status=200)
-
-      Produce a multiple sheet Excel book of *file_type*. It becomes the same
-      as :meth:`~django_excel.make_response_from_a_table` if you pass *tables*
-      with an array that has a single table
-      
-      :param session: SQLAlchemy session
-      :param tables: SQLAlchemy tables
-      :param file_type: same as :meth:`~django_excel.make_response`
-      :param status: same as :meth:`~django_excel.make_response`
+   .. autofunction:: make_response_from_a_table(model, file_type status=200)
+   .. autofunction:: make_response_from_tables(models, file_type status=200)
 
 
 Indices and tables
@@ -257,4 +240,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

doc/source/index.rst

@@ -40,9 +40,9 @@ def download(request, file_type):
 
 def export_data(request, atype):
     if atype == "sheet":
-        return excel.make_response_from_a_model(Question, 'csv')
+        return excel.make_response_from_a_table(Question, 'xls')
     elif atype == "book":
-        return excel.make_response_from_a_model([Question, Choice], 'csv')
+        return excel.make_response_from_tables([Question, Choice], 'xls')
 
 def import_data(request):
     if request.method == "POST":
@@ -59,7 +59,7 @@ def choice_func(row):
                     (Choice, ['question', 'choice_text', 'votes'], choice_func, 0) 
                  ]
                 )
-            return HttpResponse("OK")
+            return HttpResponse("OK", status=200)
         else:
             return HttpResponseBadRequest()
     else:

polls/views.py

@@ -1,5 +1,7 @@
+from polls.models import Question, Choice
 from django.test import Client, TestCase
 from django.test.utils import override_settings
+from textwrap import dedent
 import pyexcel as pe
 import pyexcel.ext.xls
 import pyexcel.ext.xlsx
@@ -11,7 +13,6 @@
     from ordereddict import OrderedDict
 else:
     from collections import OrderedDict
-    
 if PY2:
     import pyexcel.ext.ods
     from StringIO import StringIO
@@ -112,6 +113,71 @@ def test_exchange(self):
             os.unlink(tmp_filename)
 
 
+class DatabaseOperationsTestCase(TestCase):
+    def setUp(self):
+        self.testfile = "sample-data.xls"
+        Question.objects.all().delete()
+        Choice.objects.all().delete()
+
+    def testBook(self):
+        fp = open(self.testfile, "rb")
+        response = self.client.post('/polls/import/', data={"file": fp})
+        assert response.status_code == 200
+        response2 = self.client.get('/polls/export/book')
+        assert response2.status_code == 200
+        book = pe.load_book_from_memory('xls', response2.content)
+        content = dedent("""
+        Sheet Name: question
+        +----+---------------------------+----------------------------------------------+----------+
+        | id | pub_date                  | question_text                                | slug     |
+        +----+---------------------------+----------------------------------------------+----------+
+        | 1  | 2015-01-28T00:00:00+00:00 | What is your favourite programming language? | language |
+        +----+---------------------------+----------------------------------------------+----------+
+        | 2  | 2015-01-29T00:00:00+00:00 | What is your favourite IDE?                  | ide      |
+        +----+---------------------------+----------------------------------------------+----------+
+        Sheet Name: choice
+        +---------------+----+-------------+-------+
+        | choice_text   | id | question_id | votes |
+        +---------------+----+-------------+-------+
+        | Java          | 1  | 1           | 0     |
+        +---------------+----+-------------+-------+
+        | C++           | 2  | 1           | 0     |
+        +---------------+----+-------------+-------+
+        | C             | 3  | 1           | 0     |
+        +---------------+----+-------------+-------+
+        | Eclipse       | 4  | 2           | 0     |
+        +---------------+----+-------------+-------+
+        | Visual Studio | 5  | 2           | 0     |
+        +---------------+----+-------------+-------+
+        | PyCharm       | 6  | 2           | 0     |
+        +---------------+----+-------------+-------+
+        | IntelliJ      | 7  | 2           | 0     |
+        +---------------+----+-------------+-------+""").strip('\n')
+        assert str(book) == content
+
+    def testSheet(self):
+        fp = open(self.testfile, "rb")
+        response = self.client.post('/polls/import/', data={"file": fp})
+        assert response.status_code == 200
+        response2 = self.client.get('/polls/export/sheet')
+        assert response2.status_code == 200
+        sheet = pe.load_from_memory('xls', response2.content)
+        content = dedent("""
+        Sheet Name: question
+        +----+---------------------------+----------------------------------------------+----------+
+        | id | pub_date                  | question_text                                | slug     |
+        +----+---------------------------+----------------------------------------------+----------+
+        | 1  | 2015-01-28T00:00:00+00:00 | What is your favourite programming language? | language |
+        +----+---------------------------+----------------------------------------------+----------+
+        | 2  | 2015-01-29T00:00:00+00:00 | What is your favourite IDE?                  | ide      |
+        +----+---------------------------+----------------------------------------------+----------+""").strip('\n')
+        assert str(sheet) == content
+
+
 @override_settings(FILE_UPLOAD_MAX_MEMORY_SIZE=1)
 class ExcelResponseUsingFileTestCase(ExcelResponseTestCase):
+    pass
+
+@override_settings(FILE_UPLOAD_MAX_MEMORY_SIZE=1)
+class DatabaseOperationsUsingFileTestCase(DatabaseOperationsTestCase):
     pass