Updates for compatibility with Django 4.0+

* Revise list of python versions for tox
* Use updated django url/path syntax
* Update for django 4.0+ compatibility
* Address indentation flagged by flake8
* Update tox.ini
* Allow a wider range of django versions
* Add basic github actions unit test with build matrix
* Remove import error checks for older versions of django
* Exclude incompatible python/django combinations from build matrix
* Add python 3.13 to test matrix
* Update python & Django classifiers to match tested versions
* Configure custom export action for custom export test case

---------

Co-authored-by: Chris Adams <[email protected]>
Co-authored-by: Ben Silverman <[email protected]>

Author: 3 people

.github/workflows/unit_tests.yml

@@ -0,0 +1,60 @@
+name: unit tests
+
+on:
+  push: # run on every push or PR to any branch
+  pull_request:
+  schedule: # run automatically on main branch each Tuesday at 11am
+    - cron: "0 16 * * 2"
+
+jobs:
+  python-unit:
+    name: Python unit tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        django: ["4.0", "4.1", "4.2", "5.0", "5.1"]
+        exclude:
+           # django 5.0 and 5.1 require python 3.10 minimum
+          - python: "3.9"
+            django: 5.0
+          - python: "3.9"
+            django: 5.1
+          # django 4.0 only goes up to python 3.10
+          - python: "3.11"
+            django: 4.0
+          - python: "3.12"
+            django: 4.0
+          - python: "3.13"
+            django: 4.0
+          # django 4.1 only goes up to python 3.11
+          - python: "3.12"
+            django: 4.1
+          - python: "3.13"
+            django: 4.1
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      # Base python cache on the hash of test requirements file
+      # if the file changes, the cache is invalidated.
+      - name: Cache pip
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: pip-${{ hashFiles('requirements-test.txt') }}
+          restore-keys: |
+            pip-${{ hashFiles('requirements-test.txt') }}
+
+      - name: Install package with dependencies
+        run: |
+          pip install -q Django==${{ matrix.django }}
+          pip install -r requirements-test.txt
+
+      - name: Run python tests
+        run: python tests/run_tests.py

requirements.txt

@@ -1,2 +1,2 @@
-django
+django>=4.0,<6.0
 xlsxwriter

setup.py

@@ -12,7 +12,7 @@
 
 setup(
     name='django-tabular-export',
-    version='1.1.0',
+    version='1.2.0',
     description="""Simple spreadsheet exports from Django""",
     long_description=readme,
     author='Chris Adams',
@@ -32,14 +32,19 @@
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Framework :: Django',
-        'Framework :: Django :: 1.8',
-        'Framework :: Django :: 1.9',
+        'Framework :: Django :: 4.0',
+        'Framework :: Django :: 4.1',
+        'Framework :: Django :: 4.2',
+        'Framework :: Django :: 5.0',
+        'Framework :: Django :: 5.1',
         'Intended Audience :: Developers',
         'License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication',
         'Natural Language :: English',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
+        'Programming Language :: Python :: 3.13',
     ],
 )

tabular_export/admin.py

@@ -14,7 +14,7 @@
 
 from functools import wraps
 
-from django.utils.encoding import force_text
+from django.utils.encoding import force_str
 from django.utils.translation import gettext_lazy as _
 
 from .core import export_to_csv_response, export_to_excel_response, flatten_queryset
@@ -32,7 +32,7 @@ def outer(f):
         @wraps(f)
         def inner(modeladmin, request, queryset, filename=None, *args, **kwargs):
             if filename is None:
-                filename = '%s.%s' % (force_text(modeladmin.model._meta.verbose_name_plural), suffix)
+                filename = '%s.%s' % (force_str(modeladmin.model._meta.verbose_name_plural), suffix)
             return f(modeladmin, request, queryset, filename=filename, *args, **kwargs)
         return inner
     return outer

tabular_export/core.py

@@ -16,20 +16,21 @@
 If your Django settings module sets ``TABULAR_RESPONSE_DEBUG`` to ``True`` the data will be dumped as an HTML
 table and will not be delivered as a download.
 """
+
 from __future__ import absolute_import, division, print_function, unicode_literals
 
 import csv
 import datetime
 import sys
 from functools import wraps
 from itertools import chain
+from urllib.parse import quote as urlquote
 
 import xlsxwriter
 from django.conf import settings
 from django.http import HttpResponse, StreamingHttpResponse
-from django.utils.encoding import force_text
-from django.utils.http import urlquote
-from django.views.decorators.cache import never_cache
+from django.utils.encoding import force_str
+from django.utils.cache import add_never_cache_headers
 
 
 def get_field_names_from_queryset(qs):
@@ -90,7 +91,7 @@ def convert_value_to_unicode(v):
     elif hasattr(v, 'isoformat'):
         return v.isoformat()
     else:
-        return force_text(v)
+        return force_str(v)
 
 
 def set_content_disposition(f):
@@ -112,8 +113,9 @@ def inner(filename, *args, **kwargs):
         if not getattr(settings, 'TABULAR_RESPONSE_DEBUG', False):
             return f(filename, *args, **kwargs)
         else:
-            resp = never_cache(export_to_debug_html_response)(filename, *args, **kwargs)
-            del resp['Content-Disposition']  # Don't trigger a download
+            resp = export_to_debug_html_response(filename, *args, **kwargs)
+            del resp["Content-Disposition"]  # Don't trigger a download
+            add_never_cache_headers(resp)
             return resp
 
     return inner
@@ -175,7 +177,7 @@ def export_to_excel_response(filename, headers, rows):
             elif isinstance(col, datetime.date):
                 worksheet.write_datetime(y, x, col, date_format)
             else:
-                worksheet.write(y, x, force_text(col, strings_only=True))
+                worksheet.write(y, x, force_str(col, strings_only=True))
 
     workbook.close()
 

tests/admin.py

@@ -23,5 +23,15 @@ def tags_count(self, obj):
     def get_queryset(self, *args, **kwargs):
         return self.model.objects.all().annotate(tags_count=Count('tags', distinct=True))
 
+    def custom_export_to_csv_action(self, request, queryset):
+        # Add a custom action with the extra verbose name "number of tags"
+        return export_to_csv_action(
+            self,
+            request,
+            queryset,
+            extra_verbose_names={'tags_count': 'number of tags'},
+        )
+
+    actions = (export_to_excel_action, export_to_csv_action, custom_export_to_csv_action)
 
 admin.site.register(TestModel, TestModelAdmin)

tests/run_tests.py

@@ -4,6 +4,7 @@
 
 import os
 import sys
+from uuid import uuid4
 
 import django
 from django.conf import settings
@@ -35,10 +36,27 @@
                        'tests',
                    ],
                    SITE_ID=1,
-                   MIDDLEWARE_CLASSES=('django.contrib.sessions.middleware.SessionMiddleware',
-                                       'django.contrib.auth.middleware.AuthenticationMiddleware',
-                                       'django.contrib.messages.middleware.MessageMiddleware'),
-                   ROOT_URLCONF='tests.urls')
+                   MIDDLEWARE=(
+                      'django.contrib.sessions.middleware.SessionMiddleware',
+                      'django.contrib.auth.middleware.AuthenticationMiddleware',
+                      'django.contrib.messages.middleware.MessageMiddleware'),
+                   ROOT_URLCONF='tests.urls',
+                   TEMPLATES=[
+                      {
+                          'BACKEND': 'django.template.backends.django.DjangoTemplates',
+                          'OPTIONS': {
+                              'context_processors': [
+                                  'django.contrib.auth.context_processors.auth',
+                                  'django.template.context_processors.request',
+                                  'django.contrib.messages.context_processors.messages',
+                              ],
+                              'loaders': [
+                                  'django.template.loaders.app_directories.Loader',
+                              ],
+                          },
+                      },
+                  ],
+                  SECRET_KEY=uuid4(),)
 
 django.setup()
 

tests/test_admin_actions.py

@@ -1,9 +1,13 @@
 # encoding: utf-8
 from __future__ import absolute_import, division, print_function, unicode_literals
+import unittest
 
 from django.contrib.admin.helpers import ACTION_CHECKBOX_NAME
 from django.contrib.auth.models import User
-from django.core.urlresolvers import reverse
+try:
+    from django.urls import reverse
+except ImportError:
+    from django.core.urlresolvers import reverse
 from django.test.testcases import TestCase
 
 from .models import TestModel
@@ -64,9 +68,9 @@ def test_export_to_csv_action(self):
 
         content = list(i.decode('utf-8') for i in response.streaming_content)
         self.assertEqual(len(content), TestModel.objects.count() + 1)
-        self.assertRegexpMatches(content[0], r'^ID,title,tags_count')
-        self.assertRegexpMatches(content[1], r'^1,TEST ITEM 1,0\r\n')
-        self.assertRegexpMatches(content[2], r'^2,TEST ITEM 2,0\r\n')
+        self.assertRegex(content[0], r'^ID,title,tags_count')
+        self.assertRegex(content[1], r'^1,TEST ITEM 1,0\r\n')
+        self.assertRegex(content[2], r'^2,TEST ITEM 2,0\r\n')
 
     def test_custom_export_to_csv_action(self):
         changelist_url = reverse('admin:tests_testmodel_changelist')
@@ -85,6 +89,6 @@ def test_custom_export_to_csv_action(self):
 
         content = list(i.decode('utf-8') for i in response.streaming_content)
         self.assertEqual(len(content), TestModel.objects.count() + 1)
-        self.assertRegexpMatches(content[0], r'^ID,title,number of tags')
-        self.assertRegexpMatches(content[1], r'^1,TEST ITEM 1,0\r\n')
-        self.assertRegexpMatches(content[2], r'^2,TEST ITEM 2,0\r\n')
+        self.assertRegex(content[0], r'^ID,title,number of tags')
+        self.assertRegex(content[1], r'^1,TEST ITEM 1,0\r\n')
+        self.assertRegex(content[2], r'^2,TEST ITEM 2,0\r\n')

tests/urls.py

@@ -1,9 +1,9 @@
 # encoding: utf-8
 from __future__ import absolute_import, division, print_function, unicode_literals
 
-from django.conf.urls import include, url
+from django.urls import path
 from django.contrib import admin
 
 urlpatterns = [
-    url(r'^admin/', include(admin.site.urls)),
+    path("admin/", admin.site.urls),
 ]

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py27, py35, py36
+envlist = py39,py310,py311,py312
 
 [testenv]
 setenv =