Merge pull request #2 from treyhunner/fix-additional-migration

Fix additional migration

Author: KevinGrahamFoster

AUTHORS.rst

@@ -7,6 +7,7 @@ Authors
 - Damien Nozay
 - Daniel Levy
 - Daniel Roschka
+- David Hite
 - George Vilches
 - Hamish Downer
 - jofusa

CHANGES.rst

@@ -1,11 +1,13 @@
 Changes
 =======
 
-tip (unreleased)
-----------------
+1.5.1 (2014-10-13)
+------------------
 - Removed some incompatibilities with non-default admin sites (gh-92)
 - Fixed error caused by ``HistoryRequestMiddleware`` during anonymous requests (gh-115 fixes gh-114)
 - Added workaround for clashing related historical accessors on User (gh-121)
+- Added support for MongoDB AutoField (gh-125)
+- Fixed CustomForeignKeyField errors with 1.7 migrations (gh-126 fixes gh-124)
 
 1.5.0 (2014-08-17)
 ------------------

runtests.py

@@ -21,6 +21,7 @@
     'simple_history',
     'simple_history.tests',
     'simple_history.tests.external',
+    'simple_history.tests.migration_test_app',
 ]
 
 DEFAULT_SETTINGS = dict(

setup.py

@@ -1,6 +1,12 @@
 from setuptools import setup
 import simple_history
 
+tests_require = ["Django>=1.4", "webtest==2.0.6", "django-webtest==1.7"]
+try:
+    from unittest import skipUnless
+except ImportError:  # Python 2.6 compatibility
+    tests_require.append("unittest2")
+
 setup(
     name='django-simple-history',
     version=simple_history.__version__,
@@ -27,7 +33,7 @@
         'Programming Language :: Python :: 3.3',
         "License :: OSI Approved :: BSD License",
     ],
-    tests_require=["Django>=1.4", "webtest==2.0.6", "django-webtest==1.7"],
+    tests_require=tests_require,
     include_package_data=True,
     test_suite='runtests.main',
 )

simple_history/__init__.py

@@ -1,6 +1,6 @@
 from __future__ import unicode_literals
 
-__version__ = '1.5.0'
+__version__ = '1.5.1'
 
 
 def register(model, app=None, manager_name='history', **records_config):

simple_history/manager.py

@@ -89,6 +89,7 @@ def _as_of_set(self, date):
                 queryset.order_by().values_list(pk_attr, flat=True)):
             changes = queryset.filter(**{pk_attr: original_pk})
             last_change = changes.latest('history_date')
-            if changes.filter(history_date=last_change.history_date, history_type='-').exists():
+            if changes.filter(history_date=last_change.history_date,
+                              history_type='-').exists():
                 continue
             yield last_change.instance

simple_history/models.py

@@ -6,20 +6,17 @@
     from django.apps import apps  # Django >= 1.7
 except ImportError:
     apps = None
-from django.db import models
+from django.db import models, router
 from django.db.models.fields.related import RelatedField
 from django.db.models.related import RelatedObject
 from django.conf import settings
 from django.contrib import admin
-from django.utils import importlib
+from django.utils import importlib, six
+from django.utils.encoding import python_2_unicode_compatible
 try:
     from django.utils.encoding import smart_text
 except ImportError:
-    smart_text = unicode
-try:
-    from django.utils.six import text_type
-except ImportError:
-    text_type = unicode
+    from django.utils.encoding import smart_unicode as smart_text
 try:
     from django.utils.timezone import now
 except ImportError:
@@ -28,29 +25,6 @@
 from django.utils.translation import string_concat
 from .manager import HistoryDescriptor
 
-try:
-    basestring
-except NameError:
-    basestring = str  # Python 3 has no basestring
-
-try:
-    from django.utils.encoding import python_2_unicode_compatible
-except ImportError:  # django 1.3 compatibility
-    import sys
-
-    # copy of django function without use of six
-    def python_2_unicode_compatible(klass):
-        """
-        Decorator defining __unicode__ and __str__ as appropriate for Py2/3
-
-        Usage: define __str__ method and apply this decorator to the class.
-        """
-        if sys.version_info[0] != 3:
-            klass.__unicode__ = klass.__str__
-            klass.__str__ = lambda self: self.__unicode__().encode('utf-8')
-        return klass
-
-
 registered_models = {}
 
 
@@ -62,7 +36,7 @@ def __init__(self, verbose_name=None, bases=(models.Model,),
         self.user_set_verbose_name = verbose_name
         self.user_related_name = user_related_name
         try:
-            if isinstance(bases, basestring):
+            if isinstance(bases, six.string_types):
                 raise TypeError
             self.bases = tuple(bases)
         except TypeError:
@@ -149,7 +123,7 @@ def copy_fields(self, model):
                 # Don't allow reverse relations.
                 # ForeignKey knows best what datatype to use for the column
                 # we'll used that as soon as it's finalized by copying rel.to
-                field.__class__ = get_custom_fk_class(type(field))
+                field.__class__ = CustomForeignKeyField
                 field.rel.related_name = '+'
                 field.null = True
                 field.blank = True
@@ -243,7 +217,13 @@ def get_history_user(self, instance):
                 return None
 
 
-class ForeignKeyMixin(object):
+class CustomForeignKeyField(models.ForeignKey):
+
+    def __init__(self, *args, **kwargs):
+        super(CustomForeignKeyField, self).__init__(*args, **kwargs)
+        self.db_constraint = False
+        self.generate_reverse_relation = False
+
     def get_attname(self):
         return self.name
 
@@ -253,7 +233,7 @@ def get_one_to_one_field(self, to_field, other):
         # recursive
         temp_field = self.__class__(to_field.rel.to._meta.object_name)
         for key, val in to_field.__dict__.items():
-            if (isinstance(key, basestring)
+            if (isinstance(key, six.string_types)
                     and not key.startswith('_')):
                 setattr(temp_field, key, val)
         field = self.__class__.get_field(
@@ -268,7 +248,7 @@ def get_field(self, other, cls):
         if isinstance(to_field, models.OneToOneField):
             field = self.get_one_to_one_field(to_field, other)
         elif isinstance(to_field, models.AutoField):
-            field.__class__ = models.IntegerField
+            field.__class__ = convert_auto_field(to_field)
         else:
             field.__class__ = to_field.__class__
             excluded_prefixes = ("_", "__")
@@ -294,7 +274,7 @@ def get_field(self, other, cls):
                 "blank",
             )
             for key, val in to_field.__dict__.items():
-                if (isinstance(key, basestring)
+                if (isinstance(key, six.string_types)
                         and not key.startswith(excluded_prefixes)
                         and key not in excluded_attributes):
                     setattr(field, key, val)
@@ -303,7 +283,13 @@ def get_field(self, other, cls):
     def do_related_class(self, other, cls):
         field = self.get_field(other, cls)
         if not hasattr(self, 'related'):
-            self.related = RelatedObject(other, cls.instance_type, self)
+            try:
+                instance_type = cls.instance_type
+            except AttributeError:  # when model is reconstituted for migration
+                if cls.__module__ != "__fake__":  # not from migrations, error
+                    raise
+            else:
+                self.related = RelatedObject(other, instance_type, self)
         transform_field(field)
         field.rel = None
 
@@ -312,17 +298,12 @@ def contribute_to_class(self, cls, name):
         RelatedField.contribute_to_class(self, cls, name)
 
 
-def get_custom_fk_class(parent_type):
-    return type(str('CustomForeignKey'), (ForeignKeyMixin, parent_type), {})
-
-
 def transform_field(field):
     """Customize field appropriately for use in historical model"""
     field.name = field.attname
     if isinstance(field, models.AutoField):
-        # The historical model gets its own AutoField, so any
-        # existing one must be replaced with an IntegerField.
-        field.__class__ = models.IntegerField
+        field.__class__ = convert_auto_field(field)
+
     elif isinstance(field, models.FileField):
         # Don't copy file, just path.
         field.__class__ = models.TextField
@@ -340,6 +321,19 @@ def transform_field(field):
         field.serialize = True
 
 
+def convert_auto_field(field):
+    """Convert AutoField to a non-incrementing type
+
+    The historical model gets its own AutoField, so any existing one
+    must be replaced with an IntegerField.
+    """
+    connection = router.db_for_write(field.model)
+    if settings.DATABASES[connection]['ENGINE'] in ('django_mongodb_engine',):
+        # Check if AutoField is string for django-non-rel support
+        return models.TextField
+    return models.IntegerField
+
+
 class HistoricalObjectDescriptor(object):
     def __init__(self, model):
         self.model = model

simple_history/tests/migration_test_app/__init__.py

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.db import models, migrations
+import simple_history.models
+from django.conf import settings
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='DoYouKnow',
+            fields=[
+                ('id', models.AutoField(serialize=False, verbose_name='ID', auto_created=True, primary_key=True)),
+            ],
+            options={
+            },
+            bases=(models.Model,),
+        ),
+        migrations.CreateModel(
+            name='HistoricalYar',
+            fields=[
+                ('id', models.IntegerField(verbose_name='ID', auto_created=True, db_index=True, blank=True)),
+                ('history_id', models.AutoField(serialize=False, primary_key=True)),
+                ('history_date', models.DateTimeField()),
+                ('history_type', models.CharField(choices=[('+', 'Created'), ('~', 'Changed'), ('-', 'Deleted')], max_length=1)),
+                ('history_user', models.ForeignKey(null=True, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'historical yar',
+                'ordering': ('-history_date', '-history_id'),
+            },
+            bases=(models.Model,),
+        ),
+        migrations.CreateModel(
+            name='WhatIMean',
+            fields=[
+                ('doyouknow_ptr', models.OneToOneField(primary_key=True, to='migration_test_app.DoYouKnow', auto_created=True, parent_link=True, serialize=False)),
+            ],
+            options={
+            },
+            bases=('migration_test_app.doyouknow',),
+        ),
+        migrations.CreateModel(
+            name='Yar',
+            fields=[
+                ('id', models.AutoField(serialize=False, verbose_name='ID', auto_created=True, primary_key=True)),
+                ('what', models.ForeignKey(to='migration_test_app.WhatIMean')),
+            ],
+            options={
+            },
+            bases=(models.Model,),
+        ),
+        migrations.AddField(
+            model_name='historicalyar',
+            name='what_id',
+            field=simple_history.models.CustomForeignKeyField(to='migration_test_app.WhatIMean', blank=True, null=True, related_name='+'),
+            preserve_default=True,
+        ),
+    ]