Update for django-reversion 2.04

Author: Michael Shannon

reversion_compare/admin.py

@@ -34,7 +34,7 @@
     import reversion # django-reversion <= 1.9
 
 from reversion.admin import VersionAdmin
-
+from reversion_compare import reversion_api
 from reversion_compare.forms import SelectDiffForm
 from reversion_compare.mixins import CompareMixin, CompareMethodsMixin
 
@@ -111,7 +111,7 @@ def _get_action_list(self, request, object_id, extra_context=None):
                                args=(quote(version.object_id), version.id)),
             }
             for version
-            in self._order_version_queryset(self.revision_manager.get_for_object_reference(
+            in self._order_version_queryset(reversion_api.get_for_object_reference(
                 self.model,
                 object_id,
             ).select_related("revision__user"))
@@ -168,7 +168,7 @@ def compare_view(self, request, object_id, extra_context=None):
 
         object_id = unquote(object_id)  # Underscores in primary key get quoted to "_5F"
         obj = get_object_or_404(self.model, pk=object_id)
-        queryset = self.revision_manager.get_for_object(obj)
+        queryset = reversion_api.get_for_object(obj)
         version1 = get_object_or_404(queryset, pk=version_id1)
         version2 = get_object_or_404(queryset, pk=version_id2)
 

reversion_compare/compare.py

@@ -2,6 +2,7 @@
 
 from django import forms
 
+
 class SelectDiffForm(forms.Form):
     version_id1 = forms.IntegerField(min_value=1)
     version_id2 = forms.IntegerField(min_value=1)

reversion_compare/forms.py

@@ -15,7 +15,6 @@
     :license: GNU GPL v3 or above, see LICENSE for more details.
 """
 
-
 import difflib
 import logging
 
@@ -38,7 +37,6 @@
 else:
     google_diff_match_patch = True
     dmp = diff_match_patch()
-#google_diff_match_patch = False # manually disable, for testing
 
 
 def highlight_diff(diff_text):
@@ -220,10 +218,8 @@ class PatchedModelAdmin(AdminClass, ModelAdmin):
     admin_site.register(model, PatchedModelAdmin)
 
 
-
 if __name__ == "__main__":
     import doctest
     print(doctest.testmod(
-#        verbose=True
         verbose=False
     ))

reversion_compare/helpers.py

@@ -12,14 +12,12 @@
 from django.template.loader import render_to_string
 
 from reversion_compare.helpers import html_diff
-from reversion.revisions import default_revision_manager
-
 from reversion_compare.compare import CompareObjects
 
+
 class CompareMixin(object, ):
     """A mixin to add comparison capabilities to your views"""
-    
-    revision_manager = default_revision_manager
+
     # list/tuple of field names for the compare view. Set to None for all existing fields
     compare_fields = None
 
@@ -46,7 +44,6 @@ def _get_compare(self, obj_compare):
 
         def _get_compare_func(suffix):
             func_name = "compare_%s" % suffix
-            # logger.debug("func_name: %s", func_name)
             if hasattr(self, func_name):
                 func = getattr(self, func_name)
                 return func
@@ -102,7 +99,7 @@ def compare(self, obj, version1, version2):
             )
             if isinstance(f, models.ForeignKey) and f not in fields:
                 self.reverse_fields.append(f.rel)
-        #print(self.reverse_fields)
+
         fields += self.reverse_fields
 
         has_unfollowed_fields = False
@@ -121,8 +118,7 @@ def compare(self, obj, version1, version2):
                 continue
 
             is_reversed = field in self.reverse_fields
-            obj_compare = CompareObjects(field, field_name, obj, version1, version2, self.revision_manager, is_reversed)
-            #obj_compare.debug()
+            obj_compare = CompareObjects(field, field_name, obj, version1, version2, is_reversed)
 
             is_related = obj_compare.is_related
             follow = obj_compare.follow
@@ -171,9 +167,7 @@ def generic_add_remove(self, raw_value1, raw_value2, value1, value2):
 
     def compare_ForeignKey(self, obj_compare):
         related1, related2 = obj_compare.get_related()
-        obj_compare.debug()
         value1, value2 = str(related1), str(related2)
-        # value1, value2 = repr(related1), repr(related2)
         return self.generic_add_remove(related1, related2, value1, value2)
 
     def simple_compare_ManyToManyField(self, obj_compare):
@@ -215,15 +209,15 @@ def compare_FileField(self, obj_compare):
         return self.generic_add_remove(value1, value2, value1, value2)
 
     def compare_DateTimeField(self, obj_compare):
-        ''' compare all model datetime field in ISO format '''
+        """ compare all model datetime field in ISO format """
         context = {
             "date1": obj_compare.value1,
             "date2": obj_compare.value2,
         }
         return render_to_string("reversion-compare/compare_DateTimeField.html", context)
 
     def compare_BooleanField(self, obj_compare):
-        ''' compare booleans as a complete field, rather than as a string '''
+        """ compare booleans as a complete field, rather than as a string """
         context = {
             "bool1": obj_compare.value1,
             "bool2": obj_compare.value2,

reversion_compare/mixins.py

@@ -1,19 +1,30 @@
-
 import reversion
-if reversion.__version__ > (1,10):
+from reversion.models import Revision, Version
+
+if reversion.__version__ > (2, 0):
     from reversion import revisions as reversion
     from reversion.revisions import (
         register, unregister, is_registered,
-        get_for_object, get_registered_models, get_deleted,
-        create_revision, set_comment
+        get_registered_models,
+        create_revision, set_comment, _get_options
     )
+    get_for_object_reference = Version.objects.get_for_object_reference
+    get_for_object = Version.objects.get_for_object
+    get_deleted = Version.objects.get_deleted
+elif reversion.__version__ > (1, 10):
+    from reversion import revisions as reversion
+    from reversion.revisions import (
+        register, unregister, is_registered,
+        get_for_object, get_for_object_reference, get_registered_models, get_deleted,
+        create_revision, set_comment, default_revision_manager
+    )
+    _get_options = default_revision_manager.get_adapter
 else:
     # django-reversion <= 1.9
     from reversion import (
         register, unregister, is_registered,
-        get_for_object, get_registered_models, get_deleted,
-        create_revision, set_comment
+        get_for_object, get_for_object_reference, get_registered_models, get_deleted,
+        create_revision, set_comment, default_revision_manager
     )
+    _get_options = default_revision_manager.get_adapter
 
-
-from reversion.models import Revision, Version, has_int_pk

reversion_compare/reversion_api.py

@@ -2,9 +2,11 @@
 from django.shortcuts import get_object_or_404
 from django.views.generic.detail import DetailView
 
+from reversion_compare import reversion_api
 from reversion_compare.forms import SelectDiffForm
 from reversion_compare.mixins import CompareMixin, CompareMethodsMixin
 
+
 class HistoryCompareDetailView(CompareMixin, CompareMethodsMixin, DetailView):
     """This class can be used to add a non-admin view for comparing your object's versions.
     
@@ -49,14 +51,13 @@ class SimpleModelHistoryCompareView(HistoryCompareDetailView):
     """
 
     def _get_action_list(self, ):
-        opts = self.model._meta
         action_list = [
             {
                 "version": version,
                 "revision": version.revision,
             }
             for version
-            in self._order_version_queryset(self.revision_manager.get_for_object(
+            in self._order_version_queryset(reversion_api.get_for_object(
                 self.get_object(),
             ).select_related("revision__user"))
         ]
@@ -93,7 +94,7 @@ def get_context_data(self, **kwargs):
                 version_id1, version_id2 = version_id2, version_id1
 
             obj = self.get_object()
-            queryset = self.revision_manager.get_for_object(obj)
+            queryset = reversion_api.get_for_object(obj)
             version1 = get_object_or_404(queryset, pk=version_id1)
             version2 = get_object_or_404(queryset, pk=version_id2)
 
@@ -120,7 +121,6 @@ def get_context_data(self, **kwargs):
                 )
                 context.update({'prev_url': prev_url})
 
-
         # Compile the context.
         context.update({
             "action_list": action_list,

reversion_compare/views.py

@@ -210,19 +210,16 @@ def get_authors():
     include_package_data=True,  # include package data under svn source control
     install_requires=[
         "Django>=1.8",
-        "django-reversion>=1.9",
+        "django-reversion>=1.10.2.2",
     ],
     tests_require=[
         "django-tools",  # https://github.com/jedie/django-tools/
     ],
     zip_safe=False,
     classifiers=[
-#        "Development Status :: 4 - Beta",
         "Development Status :: 5 - Production/Stable",
         "Environment :: Web Environment",
         "Intended Audience :: Developers",
-#        "Intended Audience :: Education",
-#        "Intended Audience :: End Users/Desktop",
         "License :: OSI Approved :: GNU General Public License (GPL)",
         "Programming Language :: Python",
         "Programming Language :: Python :: 2.7",

setup.py

@@ -12,10 +12,6 @@
 
 from __future__ import unicode_literals, print_function
 
-
-from reversion.models import Revision, Version
-from reversion.revisions import RevisionManager
-
 from django.contrib import admin
 from reversion_compare.admin import CompareVersionAdmin
 
@@ -52,10 +48,9 @@ class VariantModelAdmin(CompareVersionAdmin):
 admin.site.register(VariantModel, VariantModelAdmin)
 
 
-custom_revision_manager = RevisionManager("custom")
-
 class CustomModelAdmin(CompareVersionAdmin):
-    revision_manager = custom_revision_manager
+    pass
+
 admin.site.register(CustomModel, CustomModelAdmin)
 
 admin.site.register(Identity, CustomModelAdmin)

tests/admin.py

@@ -42,51 +42,61 @@ def __str__(self):
     https://github.com/etianen/django-reversion/wiki/Low-level-API
 """
 
+
 @python_2_unicode_compatible
 class Building(models.Model):
     address = models.CharField(max_length=128)
+
     def __str__(self):
         return self.address
 
+
 @python_2_unicode_compatible
 class Factory(Building):
     name = models.CharField(max_length=128)
+
     def __str__(self):
         return self.name
 
+
 @python_2_unicode_compatible
 class Car(models.Model):
     name = models.CharField(max_length=128)
     manufacturer = models.ForeignKey(Factory, related_name="cars")
     supplier = models.ManyToManyField(Factory, related_name="suppliers", blank=True)
+
     def __str__(self):
         return "%s from %s supplier(s): %s" % (self.name, self.manufacturer, ", ".join([s.name for s in self.supplier.all()]))
 
 
 @python_2_unicode_compatible
 class Pet(models.Model):
     name = models.CharField(max_length=100)
+
     def __str__(self):
         return self.name
 
+
 @python_2_unicode_compatible
 class Person(models.Model):
     name = models.CharField(max_length=100)
     pets = models.ManyToManyField(Pet, blank=True)
     # If you work someone, its at a build, but maybe not a factory!
     workplace = models.ForeignKey(Building, related_name="workers", null=True)
+
     def __str__(self):
         return self.name
 
+
 @python_2_unicode_compatible
 class Identity(models.Model):
     id_numer = models.CharField(max_length=100)
     person = models.OneToOneField(Person, related_name='_identity')
+
     def __str__(self):
         return self.id_numer
 
 reversion_api.register(Person, follow=["pets"])
-#reversion_api.register(Pet, follow=["person_set"])
 reversion_api.register(Pet)
 
 
@@ -140,7 +150,6 @@ class VariantModel(models.Model):
     def __str__(self):
         return "VariantModel instance pk: %i" % self.pk
 
-#------------------------------------------------------------------------------
 
 class CustomModel(models.Model):
     "Model which uses a custom version manager."