Added Django 3 and Python 3.8 support (#610)

* Added Django 3 and Python 3.8 support

* Use django 3.0 release candidate to test on for now. will update when actual release is made

* Updated flake8

Author: Ross Mechanic

.travis.yml

@@ -8,16 +8,18 @@ python:
   - 3.5
   - 3.6
   - 3.7
+  - 3.8
 
 env:
   - DJANGO="Django>=1.11,<1.12"
   - DJANGO="Django>=2.0,<2.1"
   - DJANGO="Django>=2.1,<2.2"
   - DJANGO="Django>=2.2,<2.3"
+  - DJANGO="Django==3.0rc1"
 
 install:
   - pip install -U coverage codecov
-  - pip install -U flake8==3.6.0
+  - pip install -U flake8==3.7.9
   - pip install -U $DJANGO
   - if [[ $TRAVIS_PYTHON_VERSION == '3.6' ]]; then pip install black; fi
   - if [[ $TRAVIS_PYTHON_VERSION == '3.7' ]]; then pip install black; fi
@@ -31,15 +33,27 @@ script:
 
 matrix:
   exclude:
+    - python: 3.8
+      env: DJANGO="Django>=1.11,<1.12"
     - python: 2.7
       env: DJANGO="Django>=2.0,<2.1"
+    - python: 3.8
+      env: DJANGO="Django>=2.0,<2.1"
     - python: 2.7
       env: DJANGO="Django>=2.1,<2.2"
     - python: 3.4
       env: DJANGO="Django>=2.1,<2.2"
+    - python: 3.8
+      env: DJANGO="Django>=2.1,<2.2"
     - python: 2.7
       env: DJANGO="Django>=2.2,<2.3"
     - python: 3.4
       env: DJANGO="Django>=2.2,<2.3"
+    - python: 2.7
+      env: DJANGO="Django==3.0rc1"
+    - python: 3.4
+      env: DJANGO="Django==3.0rc1"
+    - python: 3.5
+      env: DJANGO="Django==3.0rc1"
 
 after_success: codecov

CHANGES.rst

@@ -9,7 +9,8 @@ Unreleased
 - Fix `model_to_dict` to detect changes in a parent model when using
   `inherit=True` (backwards-incompatible for users who were directly
   using previous version) (gh-576)
-- Use an iterator for `clean_duplicate_history`
+- Use an iterator for `clean_duplicate_history` (gh-604)
+- Add support for Python 3.8 and Django 3.0 (gh-610)
 
 2.7.3 (2019-07-15)
 ------------------

README.rst

@@ -40,7 +40,8 @@ This app supports the following combinations of Django and Python:
 1.11        2.7, 3.4, 3.5, 3.6, 3.7
 2.0         3.4, 3.5, 3.6, 3.7
 2.1         3.5, 3.6, 3.7
-2.2         3.5, 3.6, 3.7
+2.2         3.5, 3.6, 3.7, 3.8
+3.0         3.6, 3.7, 3.8
 ==========  =======================
 
 Getting Help

docs/common_issues.rst

@@ -188,10 +188,8 @@ A few notes:
 Usage with django-modeltranslation
 ----------------------------------
 
-If you have ``django-modeltranslation`` installed, you will need to use the ``register()`` 
-method to model translation, as described `here`_.
-
-..  _here https://github.com/treyhunner/django-simple-history/issues/209#issuecomment-181676111
+If you have ``django-modeltranslation`` installed, you will need to use the ``register()``
+method to model translation, as described `here <https://github.com/treyhunner/django-simple-history/issues/209#issuecomment-181676111>`__.
 
 
 Pointing to the model

setup.py

@@ -3,49 +3,50 @@
 
 tests_require = [
     "Django>=1.11",
-    "WebTest==2.0.24",
-    "django-webtest==1.8.0",
     "mock==1.0.1",
     "six",
 ]
 
-setup(
-    name="django-simple-history",
-    version=simple_history.__version__,
-    description="Store model history and view/revert changes from admin site.",
-    long_description="\n".join((open("README.rst").read(), open("CHANGES.rst").read())),
-    author="Corey Bertram",
-    author_email="[email protected]",
-    maintainer="Trey Hunner",
-    url="https://github.com/treyhunner/django-simple-history",
-    packages=[
-        "simple_history",
-        "simple_history.management",
-        "simple_history.management.commands",
-        "simple_history.templatetags",
-    ],
-    classifiers=[
-        "Development Status :: 5 - Production/Stable",
-        "Framework :: Django",
-        "Environment :: Web Environment",
-        "Intended Audience :: Developers",
-        "Framework :: Django",
-        "Framework :: Django :: 1.11",
-        "Framework :: Django :: 2.0",
-        "Framework :: Django :: 2.1",
-        "Framework :: Django :: 2.2",
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 2.7",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.4",
-        "Programming Language :: Python :: 3.5",
-        "Programming Language :: Python :: 3.6",
-        "Programming Language :: Python :: 3.7",
-        "License :: OSI Approved :: BSD License",
-    ],
-    python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
-    tests_require=tests_require,
-    install_requires=["six"],
-    include_package_data=True,
-    test_suite="runtests.main",
-)
+with open("README.rst") as readme, open("CHANGES.rst") as changes:
+    setup(
+        name="django-simple-history",
+        version=simple_history.__version__,
+        description="Store model history and view/revert changes from admin site.",
+        long_description="\n".join((readme.read(), changes.read())),
+        author="Corey Bertram",
+        author_email="[email protected]",
+        maintainer="Trey Hunner",
+        url="https://github.com/treyhunner/django-simple-history",
+        packages=[
+            "simple_history",
+            "simple_history.management",
+            "simple_history.management.commands",
+            "simple_history.templatetags",
+        ],
+        classifiers=[
+            "Development Status :: 5 - Production/Stable",
+            "Framework :: Django",
+            "Environment :: Web Environment",
+            "Intended Audience :: Developers",
+            "Framework :: Django",
+            "Framework :: Django :: 1.11",
+            "Framework :: Django :: 2.0",
+            "Framework :: Django :: 2.1",
+            "Framework :: Django :: 2.2",
+            "Framework :: Django :: 3.0",
+            "Programming Language :: Python",
+            "Programming Language :: Python :: 2.7",
+            "Programming Language :: Python :: 3",
+            "Programming Language :: Python :: 3.4",
+            "Programming Language :: Python :: 3.5",
+            "Programming Language :: Python :: 3.6",
+            "Programming Language :: Python :: 3.7",
+            "Programming Language :: Python :: 3.8",
+            "License :: OSI Approved :: BSD License",
+        ],
+        python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
+        tests_require=tests_require,
+        install_requires=["six"],
+        include_package_data=True,
+        test_suite="runtests.main",
+    )

simple_history/admin.py

@@ -1,5 +1,6 @@
 from __future__ import unicode_literals
 
+import django
 from django import http
 from django.conf import settings
 from django.conf.urls import url
@@ -10,13 +11,18 @@
 from django.core.exceptions import PermissionDenied
 from django.shortcuts import get_object_or_404, render
 from django.urls import reverse
-from django.utils.encoding import force_text
 from django.utils.html import mark_safe
 from django.utils.text import capfirst
-from django.utils.translation import ugettext as _
 
 from . import utils
 
+if django.VERSION < (2,):
+    from django.utils.encoding import force_text as force_str
+    from django.utils.translation import ugettext as _
+else:
+    from django.utils.encoding import force_str
+    from django.utils.translation import gettext as _
+
 USER_NATURAL_KEY = tuple(key.lower() for key in settings.AUTH_USER_MODEL.split(".", 1))
 
 SIMPLE_HISTORY_EDIT = getattr(settings, "SIMPLE_HISTORY_EDIT", False)
@@ -80,9 +86,9 @@ def history_view(self, request, object_id, extra_context=None):
             content_type.model,
         )
         context = {
-            "title": _("Change history: %s") % force_text(obj),
+            "title": _("Change history: %s") % force_str(obj),
             "action_list": action_list,
-            "module_name": capfirst(force_text(opts.verbose_name_plural)),
+            "module_name": capfirst(force_str(opts.verbose_name_plural)),
             "object": obj,
             "root_path": getattr(self.admin_site, "root_path", None),
             "app_label": app_label,
@@ -102,8 +108,8 @@ def response_change(self, request, obj):
             verbose_name = obj._meta.verbose_name
 
             msg = _('The %(name)s "%(obj)s" was changed successfully.') % {
-                "name": force_text(verbose_name),
-                "obj": force_text(obj),
+                "name": force_str(verbose_name),
+                "obj": force_str(obj),
             }
 
             self.message_user(
@@ -167,7 +173,7 @@ def history_form_view(self, request, object_id, version_id, extra_context=None):
         model_name = original_opts.model_name
         url_triplet = self.admin_site.name, original_opts.app_label, model_name
         context = {
-            "title": _("Revert %s") % force_text(obj),
+            "title": _("Revert %s") % force_str(obj),
             "adminform": admin_form,
             "object_id": object_id,
             "original": obj,

simple_history/models.py

@@ -2,33 +2,36 @@
 
 import copy
 import importlib
-import six
 import threading
 import uuid
 import warnings
 
+import django
+import six
 from django.apps import apps
 from django.conf import settings
 from django.contrib import admin
 from django.contrib.auth import get_user_model
 from django.core.exceptions import ObjectDoesNotExist
-from django.core.serializers import serialize
 from django.db import models
 from django.db.models import Q
 from django.db.models.fields.proxy import OrderWrt
 from django.forms.models import model_to_dict
 from django.urls import reverse
-from django.utils.encoding import python_2_unicode_compatible, smart_text
 from django.utils.text import format_lazy
 from django.utils.timezone import now
-from django.utils.translation import ugettext_lazy as _
-
 from simple_history import utils
 from . import exceptions
 from .manager import HistoryDescriptor
 from .signals import post_create_historical_record, pre_create_historical_record
 
-import json
+if django.VERSION < (2,):
+    from django.utils.translation import ugettext_lazy as _
+    from django.utils.encoding import smart_text as smart_str
+    from django.utils.encoding import python_2_unicode_compatible
+else:
+    from django.utils.translation import gettext_lazy as _
+    from django.utils.encoding import smart_str
 
 registered_models = {}
 
@@ -223,7 +226,12 @@ def create_history_model(self, model, inherited):
         name = self.get_history_model_name(model)
 
         registered_models[model._meta.db_table] = model
-        return python_2_unicode_compatible(type(str(name), self.bases, attrs))
+        history_model = type(str(name), self.bases, attrs)
+        return (
+            python_2_unicode_compatible(history_model)
+            if django.VERSION < (2,)
+            else history_model
+        )
 
     def fields_included(self, model):
         fields = []
@@ -448,7 +456,7 @@ def get_meta_options(self, model):
         if self.user_set_verbose_name:
             name = self.user_set_verbose_name
         else:
-            name = format_lazy("historical {}", smart_text(model._meta.verbose_name))
+            name = format_lazy("historical {}", smart_str(model._meta.verbose_name))
         meta_fields["verbose_name"] = name
         if self.app:
             meta_fields["app_label"] = self.app