Make library django 3 compatible (#64)

* Exclude venv folder from flake8

* Use MIDDLEWARE instead of MIDDLEWARE_CLASSES if django version is greater than 1

* Ran 'make format'

* Update changelog

* Update django_excel.yml

* Update lint.sh

* Update lint.sh

* Update .travis.yml

* Update django_excel.yml

Co-authored-by: jaska <[email protected]>

Author: minhlongdo

.travis.yml

@@ -10,6 +10,7 @@ env:
   - DJANGO_VERSION=1.11.15
   - DJANGO_VERSION=2.0.8
   - DJANGO_VERSION=2.1
+  - DJANGO_VERSION=3.1.2
 python:
   - 3.6
   - 3.7

changelog.yml

@@ -1,6 +1,11 @@
 name: django-excel
 organisation: pyexcel-webwares
 releases:
+- changes:
+  - action: Added
+    details:
+    - 'Support for django 3.x.x'
+    - 'Tested against django 3.x.x'
 - changes:
   - action: Added
     details:

django_excel.yml

@@ -28,3 +28,5 @@ keywords:
   - Django
 description: 
   A django middleware that provides one application programming interface to read and write data in different excel file formats
+flake8_options: --ignore=F401,E402
+moban_command: false

django_excel/__init__.py

@@ -8,105 +8,128 @@
     :copyright: (c) 2015 by Onni Software Ltd.
     :license: New BSD License
 """
-from django.core.files.uploadhandler import (
-    MemoryFileUploadHandler, TemporaryFileUploadHandler)
-from django.core.files.uploadedfile import (
-    InMemoryUploadedFile, TemporaryUploadedFile)
-from django.http import HttpResponse
 import pyexcel as pe
 import pyexcel_webio as webio
+from django.core.files.uploadedfile import (
+    InMemoryUploadedFile,
+    TemporaryUploadedFile,
+)
+from django.core.files.uploadhandler import (
+    MemoryFileUploadHandler,
+    TemporaryFileUploadHandler,
+)
+from django.http import HttpResponse
+
 from ._compact import DJANGO_ONE_SIX, PY2_VERSION, urllib_quote
 
 
 class ExcelMixin(webio.ExcelInput):
     """
     Provide additional pyexcel-webio methods to Django's UploadedFiles
     """
+
     def get_params(self, **keywords):
         extension = self.name.split(".")[-1]
-        keywords['file_type'] = extension
+        keywords["file_type"] = extension
         self.file.seek(0)
         content = self.file.read()
         if content:
-            keywords['file_content'] = content
+            keywords["file_content"] = content
         else:
             raise IOError("No content was uploaded.")
         return keywords
 
-    def save_to_database(self, model=None, initializer=None, mapdict=None,
-                         **keywords):
+    def save_to_database(
+        self, model=None, initializer=None, mapdict=None, **keywords
+    ):
         """
         Save data from a sheet to a nominated django model
         """
         params = self.get_params(**keywords)
-        if 'name_columns_by_row' not in params:
-            params['name_columns_by_row'] = 0
-        if 'name_rows_by_column' not in params:
-            params['name_rows_by_column'] = -1
-        params['dest_model'] = model
-        params['dest_initializer'] = initializer
-        params['dest_mapdict'] = mapdict
+        if "name_columns_by_row" not in params:
+            params["name_columns_by_row"] = 0
+        if "name_rows_by_column" not in params:
+            params["name_rows_by_column"] = -1
+        params["dest_model"] = model
+        params["dest_initializer"] = initializer
+        params["dest_mapdict"] = mapdict
         pe.save_as(**params)
 
-    def save_book_to_database(self, models=None, initializers=None,
-                              mapdicts=None, batch_size=None, bulk_save=None,
-                              **keywords):
+    def save_book_to_database(
+        self,
+        models=None,
+        initializers=None,
+        mapdicts=None,
+        batch_size=None,
+        bulk_save=None,
+        **keywords
+    ):
         """
         Save data from a book to a nominated django models
         """
         params = self.get_params(**keywords)
-        params['dest_models'] = models
-        params['dest_initializers'] = initializers
-        params['dest_mapdicts'] = mapdicts
-        params['dest_batch_size'] = batch_size
-        params['dest_bulk_save'] = bulk_save
+        params["dest_models"] = models
+        params["dest_initializers"] = initializers
+        params["dest_mapdicts"] = mapdicts
+        params["dest_batch_size"] = batch_size
+        params["dest_bulk_save"] = bulk_save
         pe.save_book_as(**params)
 
-    def isave_to_database(self, model=None, initializer=None, mapdict=None,
-                          **keywords):
+    def isave_to_database(
+        self, model=None, initializer=None, mapdict=None, **keywords
+    ):
         """
         Save data from a sheet to a nominated django model
         """
         params = self.get_params(**keywords)
-        params['dest_model'] = model
-        params['dest_initializer'] = initializer
-        params['dest_mapdict'] = mapdict
+        params["dest_model"] = model
+        params["dest_initializer"] = initializer
+        params["dest_mapdict"] = mapdict
         pe.isave_as(**params)
         self.free_resources()
 
-    def isave_book_to_database(self, models=None, initializers=None,
-                               mapdicts=None, batch_size=None, bulk_save=None,
-                               **keywords):
+    def isave_book_to_database(
+        self,
+        models=None,
+        initializers=None,
+        mapdicts=None,
+        batch_size=None,
+        bulk_save=None,
+        **keywords
+    ):
         """
         Save data from a book to a nominated django models
         """
         params = self.get_params(**keywords)
-        params['dest_models'] = models
-        params['dest_initializers'] = initializers
-        params['dest_mapdicts'] = mapdicts
-        params['dest_batch_size'] = batch_size
-        params['dest_bulk_save'] = bulk_save
+        params["dest_models"] = models
+        params["dest_initializers"] = initializers
+        params["dest_mapdicts"] = mapdicts
+        params["dest_batch_size"] = batch_size
+        params["dest_bulk_save"] = bulk_save
         pe.isave_book_as(**params)
 
 
 class ExcelInMemoryUploadedFile(ExcelMixin, InMemoryUploadedFile):
     """
     Mix-in pyexcel-webio methods in InMemoryUploadedFile
     """
+
     pass
 
 
 class TemporaryUploadedExcelFile(ExcelMixin, TemporaryUploadedFile):
     """
     Mix-in pyexcel-webio methods in TemporaryUploadedFile
     """
+
     pass
 
 
 class ExcelMemoryFileUploadHandler(MemoryFileUploadHandler):
     """
     Override MemoryFileUploadHandler to bring in ExcelInMemoryUploadedFile
     """
+
     def file_complete(self, file_size):
         if not self.activated:
             return
@@ -117,7 +140,7 @@ def file_complete(self, file_size):
             name=self.file_name,
             content_type=self.content_type,
             size=file_size,
-            charset=self.charset
+            charset=self.charset,
         )
         if not DJANGO_ONE_SIX:
             keywords["content_type_extra"] = self.content_type_extra
@@ -128,19 +151,15 @@ class TemporaryExcelFileUploadHandler(TemporaryFileUploadHandler):
     """
     Override TemporaryFileUploadHandler to bring in TemporaryUploadedExcelFile
     """
+
     def new_file(self, file_name, *args, **kwargs):
         """
         Create the file object to append to as data is coming in.
         """
         super(TemporaryFileUploadHandler, self).new_file(
-            file_name,
-            *args,
-            **kwargs)
-        custom_args = [
-            self.file_name,
-            self.content_type,
-            0,
-            self.charset]
+            file_name, *args, **kwargs
+        )
+        custom_args = [self.file_name, self.content_type, 0, self.charset]
         if not DJANGO_ONE_SIX:
             custom_args.append(self.content_type_extra)
         self.file = TemporaryUploadedExcelFile(*custom_args)
@@ -153,30 +172,33 @@ def _make_response(content, content_type, status, file_name=None):
     response = HttpResponse(content, content_type=content_type, status=status)
     if file_name:
         if PY2_VERSION and isinstance(file_name, unicode):
-            file_name = file_name.encode('utf-8')
+            file_name = file_name.encode("utf-8")
         url_encoded_file_name = urllib_quote(file_name)
-        response["Content-Disposition"] = (
-            "attachment; filename=%s;filename*=utf-8''%s"
-            % (url_encoded_file_name, url_encoded_file_name)
+        response[
+            "Content-Disposition"
+        ] = "attachment; filename=%s;filename*=utf-8''%s" % (
+            url_encoded_file_name,
+            url_encoded_file_name,
         )
     return response
 
 
 webio.init_webio(_make_response)
 
 
-from pyexcel_webio import (  # noqa
+from pyexcel_webio import (
     make_response,
-    make_response_from_array,
+    make_response_from_array,  # noqa
+    make_response_from_book_dict,
     make_response_from_dict,
+    make_response_from_query_sets,
     make_response_from_records,
-    make_response_from_book_dict,
-    make_response_from_query_sets
 )
 
 
-def make_response_from_a_table(model, file_type,
-                               status=200, file_name=None, **keywords):
+def make_response_from_a_table(
+    model, file_type, status=200, file_name=None, **keywords
+):
     """
     Produce a single sheet Excel book of *file_type*
 
@@ -185,12 +207,14 @@ def make_response_from_a_table(model, file_type,
     :param status: same as :meth:`~django_excel.make_response`
     """
     sheet = pe.get_sheet(model=model, **keywords)
-    return make_response(sheet, file_type, status,
-                         file_name=file_name, **keywords)
+    return make_response(
+        sheet, file_type, status, file_name=file_name, **keywords
+    )
 
 
-def make_response_from_tables(models, file_type,
-                              status=200, file_name=None, **keywords):
+def make_response_from_tables(
+    models, file_type, status=200, file_name=None, **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*
@@ -201,5 +225,6 @@ def make_response_from_tables(models, file_type,
     :param status: same as :meth:`~django_excel.make_response`
     """
     book = pe.get_book(models=models, **keywords)
-    return make_response(book, file_type, status,
-                         file_name=file_name, **keywords)
+    return make_response(
+        book, file_type, status, file_name=file_name, **keywords
+    )

django_excel/_compact.py

@@ -1,20 +1,22 @@
-import pkg_resources
 from distutils.version import LooseVersion
 
+import pkg_resources
+
 try:
     # if in py2
     from urllib import quote as urllib_quote
+
     PY2_VERSION = True
 except ImportError:
     # else (aka in py3)
     from urllib.parse import quote as urllib_quote  # noqa: F401
+
     PY2_VERSION = False
 
 
-django_version = pkg_resources.get_distribution('django').version
+django_version = pkg_resources.get_distribution("django").version
 
 
-DJANGO_ONE_SIX = (
-    LooseVersion(django_version) < LooseVersion("1.7.0") and
-    LooseVersion(django_version) > LooseVersion("1.5.12")
-)
+DJANGO_ONE_SIX = LooseVersion(django_version) < LooseVersion(
+    "1.7.0"
+) and LooseVersion(django_version) > LooseVersion("1.5.12")

lint.sh

@@ -1,2 +1,4 @@
 pip install flake8
-flake8 --exclude=.moban.d,docs,setup.py   --builtins=unicode,xrange,long .  && python setup.py checkdocs
+
+flake8 --exclude=.moban.d,docs,setup.py --ignore=F401,E402,W504,E226  --builtins=unicode,xrange,long .  && python setup.py checkdocs
+

mysite/settings.py

@@ -10,6 +10,7 @@
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 import os
+import django
 
 BASE_DIR = os.path.dirname(os.path.dirname(__file__))
 
@@ -40,7 +41,7 @@
     'polls'
 )
 
-MIDDLEWARE_CLASSES = (
+COMMON_MIDDLEWARE = (
     'django.contrib.sessions.middleware.SessionMiddleware',
     'django.middleware.common.CommonMiddleware',
     'django.middleware.csrf.CsrfViewMiddleware',
@@ -49,6 +50,15 @@
     'django.middleware.clickjacking.XFrameOptionsMiddleware'
 )
 
+if django.VERSION[0] > 1:
+    MIDDLEWARE = (
+        'django.middleware.security.SecurityMiddleware',
+        *COMMON_MIDDLEWARE
+    )
+
+else:
+    MIDDLEWARE_CLASSES = COMMON_MIDDLEWARE
+
 
 ROOT_URLCONF = 'mysite.urls'