add core._set_version() and VersionField._set_version_value()

Author: saxix

concurrency/admin.py

@@ -1,7 +1,7 @@
 ## -*- coding: utf-8 -*-
 from __future__ import absolute_import, unicode_literals
 import re
-from django.utils.encoding import force_text, force_unicode
+from django.utils.encoding import force_text
 from django.contrib import admin, messages
 from django.core.exceptions import ImproperlyConfigured, ValidationError
 from django.db.models import Q
@@ -13,7 +13,8 @@
 from django.http import HttpResponse, HttpResponseRedirect
 from django.utils.translation import ungettext, ugettext as _
 from concurrency import forms
-from concurrency.api import get_revision_of_object, get_version_fieldname
+from concurrency import core
+from concurrency.api import get_revision_of_object
 from concurrency.config import conf, CONCURRENCY_LIST_EDITABLE_POLICY_SILENT
 from concurrency.exceptions import RecordModifiedError
 from concurrency.forms import ConcurrentForm, VersionWidget
@@ -160,7 +161,7 @@ def save_model(self, request, obj, form, change):
             if change:
                 version = request.POST.get('_concurrency_version_{0.pk}'.format(obj), None)
                 if version:
-                    setattr(obj, get_version_fieldname(obj), int(version))
+                    core._set_version(obj, version)
             super(ConcurrencyListEditableMixin, self).save_model(request, obj, form, change)
         except RecordModifiedError:
             self._concurrency_list_editable_errors.append(obj.pk)
@@ -169,35 +170,25 @@ def save_model(self, request, obj, form, change):
             else:
                 raise
 
-
-class ConcurrentModelAdmin(ConcurrencyActionMixin,
-                           ConcurrencyListEditableMixin,
-                           admin.ModelAdmin):
-    form = ConcurrentForm
-    formfield_overrides = {forms.VersionField: {'widget': VersionWidget}}
-
     def changelist_view(self, request, extra_context=None):
         self._concurrency_list_editable_errors = []
-        return super(ConcurrentModelAdmin, self).changelist_view(request, extra_context)
-
-    def save_model(self, request, obj, form, change):
-        return super(ConcurrentModelAdmin, self).save_model(request, obj, form, change)
+        return super(ConcurrencyListEditableMixin, self).changelist_view(request, extra_context)
 
     def log_change(self, request, object, message):
         if object.pk in self._concurrency_list_editable_errors:
             return
-        super(ConcurrentModelAdmin, self).log_change(request, object, message)
+        super(ConcurrencyListEditableMixin, self).log_change(request, object, message)
 
     def log_deletion(self, request, object, object_repr):
         if object.pk in self._concurrency_list_editable_errors:
             return
-        super(ConcurrentModelAdmin, self).log_deletion(request, object, object_repr)
+        super(ConcurrencyListEditableMixin, self).log_deletion(request, object, object_repr)
 
     def message_user(self, request, message, **kwargs):
         # This is ugly but we do not want to touch the changelist_view() code.
         opts = self.model._meta
         if self._concurrency_list_editable_errors:
-            names = force_unicode(opts.verbose_name), force_unicode(opts.verbose_name_plural)
+            names = force_text(opts.verbose_name), force_text(opts.verbose_name_plural)
             pattern = r"(?P<num>\d+) ({0}|{1})".format(*names)
             rex = re.compile(pattern)
             m = rex.match(message)
@@ -213,12 +204,19 @@ def message_user(self, request, message, **kwargs):
                                              "Records `{0}` have been modified and were not updated",
                                              concurrency_errros).format(ids))
                     if updated_record == 1:
-                        name = force_unicode(opts.verbose_name)
+                        name = force_text(opts.verbose_name)
                     else:
-                        name = force_unicode(opts.verbose_name_plural)
+                        name = force_text(opts.verbose_name_plural)
                     message = ungettext("%(count)s %(name)s was changed successfully.",
                                         "%(count)s %(name)s were changed successfully.",
                                         updated_record) % {'count': updated_record,
                                                            'name': name}
 
-        return super(ConcurrentModelAdmin, self).message_user(request, message, **kwargs)
+        return super(ConcurrencyListEditableMixin, self).message_user(request, message, **kwargs)
+
+
+class ConcurrentModelAdmin(ConcurrencyActionMixin,
+                           ConcurrencyListEditableMixin,
+                           admin.ModelAdmin):
+    form = ConcurrentForm
+    formfield_overrides = {forms.VersionField: {'widget': VersionWidget}}

concurrency/api.py

@@ -3,20 +3,16 @@
 import logging
 from contextlib import contextmanager
 from django.core.exceptions import ImproperlyConfigured
-from concurrency.core import _select_lock, _wrap_model_save
+from concurrency.core import _select_lock, _wrap_model_save, get_version_fieldname
 from concurrency.exceptions import RecordModifiedError
 
 __all__ = ['apply_concurrency_check', 'concurrency_check', 'get_revision_of_object',
            'RecordModifiedError', 'disable_concurrency', 'disable_sanity_check',
-           'get_object_with_version', 'get_version', 'is_changed']
+           'get_object_with_version', 'get_version', 'is_changed', 'get_version_fieldname']
 
 logger = logging.getLogger(__name__)
 
 
-def get_version_fieldname(obj):
-    return obj.RevisionMetaInfo.field.attname
-
-
 def get_revision_of_object(obj):
     """
         returns teh version of the passed object

concurrency/core.py

@@ -1,4 +1,4 @@
-from __future__ import absolute_import, unicode_literals
+from __future__ import absolute_import
 import logging
 from functools import update_wrapper
 from django.db import connections, router
@@ -21,6 +21,20 @@ def emit(self, record):
 __all__ = []
 
 
+def get_version_fieldname(obj):
+    return obj.RevisionMetaInfo.field.attname
+
+
+def _set_version(obj, version):
+    """
+    Set the given version on the passed object
+
+    This function should be used with 'raw' values, any type conversion should be managed in
+    VersionField._set_version_value(). This is needed for future enhancement of concurrency.
+    """
+    obj._revisionmetainfo.field._set_version_value(obj, version)
+
+
 def _select_lock(model_instance, version_value=None):
     version_field = model_instance.RevisionMetaInfo.field
     value = version_value or getattr(model_instance, version_field.name)
@@ -49,7 +63,6 @@ def _wrap_model_save(model, force=False):
         old_save = getattr(model, 'save')
         setattr(model, 'save', _wrap_save(old_save))
         model.RevisionMetaInfo.versioned_save = True
-        model._revisionmetainfo = RevisionMetaInfo()
 
 
 def _wrap_save(func):

concurrency/fields.py

@@ -47,10 +47,15 @@ def contribute_to_class(self, cls, name):
         if hasattr(cls, 'RevisionMetaInfo'):
             return
         setattr(cls, 'RevisionMetaInfo', RevisionMetaInfo())
+        #TODO: allow user customization of RevisionMetaInfo
+        cls._revisionmetainfo = cls.RevisionMetaInfo
         _wrap_model_save(cls)
         cls.RevisionMetaInfo.field = self
         cls.RevisionMetaInfo.manually = self.manually
 
+    def _set_version_value(self, model_instance, value):
+        setattr(model_instance, self.attname, int(value))
+
 
 class IntegerVersionField(VersionField):
     """
@@ -68,7 +73,7 @@ def get_internal_type(self):
     def pre_save(self, model_instance, add):
         old_value = getattr(model_instance, self.attname, 0)
         value = max(int(old_value) + 1, (int(time.time() * 1000000) - OFFSET))
-        setattr(model_instance, self.attname, value)
+        self._set_version_value(model_instance, value)
         return value
 
 
@@ -84,7 +89,7 @@ def get_internal_type(self):
 
     def pre_save(self, model_instance, add):
         value = int(getattr(model_instance, self.attname, 0)) + 1
-        setattr(model_instance, self.attname, value)
+        self._set_version_value(model_instance, value)
         return value
 
 

concurrency/tests/admin_list_editable.py

@@ -2,7 +2,7 @@
 from __future__ import absolute_import, unicode_literals
 from django.contrib.admin.models import LogEntry
 from django.contrib.contenttypes.models import ContentType
-from django.utils.encoding import force_unicode
+from django.utils.encoding import force_text
 
 from concurrency.tests.base import AdminTestCase, SENTINEL
 from concurrency.tests.models import ListEditableConcurrentModel, NoActionsConcurrentModel
@@ -59,7 +59,7 @@ def test_message_user(self):
 
         self.assertIn('Record with pk `1` has been modified and was not updated',
                       messages)
-        self.assertIn('1 %s was changed successfully.' % force_unicode(self.TARGET._meta.verbose_name),
+        self.assertIn('1 %s was changed successfully.' % force_text(self.TARGET._meta.verbose_name),
                       messages)
 
     def test_message_user_no_changes(self):
@@ -72,9 +72,9 @@ def test_message_user_no_changes(self):
         form['form-0-dummy_char'] = 'CHAR1'
         res = form.submit('_save').follow()
 
-        messages = map(str, list(res.context['messages']))
+        messages = list(map(str, list(res.context['messages'])))
 
-        self.assertIn('No %s were changed due conflict errors' % force_unicode(self.TARGET._meta.verbose_name),
+        self.assertIn('No %s were changed due conflict errors' % force_text(self.TARGET._meta.verbose_name),
                       messages)
         self.assertEqual(len(messages), 1)