Completely remove use of CustomForeignKeyField

Author: macro1

simple_history/models.py

@@ -2,33 +2,37 @@
 
 import threading
 import copy
-try:
-    from django.apps import apps
-except ImportError:  # Django < 1.7
-    apps = None
+import warnings
+
 from django.db import models, router
 from django.db.models import loading
 from django.db.models.fields.proxy import OrderWrt
 from django.db.models.fields.related import RelatedField
-try:
-    from django.db.models.fields.related import RelatedObject
-except ImportError:
-    pass
 from django.conf import settings
 from django.contrib import admin
 from django.utils import importlib, six
 from django.utils.encoding import python_2_unicode_compatible
 from django.utils.encoding import smart_text
 from django.utils.timezone import now
 from django.utils.translation import string_concat
+
+from .manager import HistoryDescriptor
+
+try:
+    from django.apps import apps
+except ImportError:  # Django < 1.7
+    apps = None
+try:
+    from django.db.models.fields.related import RelatedObject
+except ImportError:
+    RelatedObject = None
 try:
     from south.modelsinspector import add_introspection_rules
 except ImportError:  # south not present
     pass
 else:  # south configuration for CustomForeignKeyField
     add_introspection_rules(
         [], ["^simple_history.models.CustomForeignKeyField"])
-from .manager import HistoryDescriptor
 
 registered_models = {}
 
@@ -124,29 +128,25 @@ def copy_fields(self, model):
         for field in model._meta.fields:
             field = copy.copy(field)
             field.rel = copy.copy(field.rel)
-            if isinstance(field, models.ForeignKey):
-                if not 'RelatedObject' in globals():
-                    old_field = field
-                    field = type(field)(field.rel.to, related_name='+', null=True, blank=True)
-                    field.rel = old_field.rel
-                    field.rel.related_name = '+'
-                    field.name = old_field.name
-                    field.db_constraint = False
-                    field._unique = False
-                    setattr(field, 'attname', field.name)
-                else:
-                    # 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
-                    # Django < 1.8
-                    field.__class__ = CustomForeignKeyField
-                    field.rel.related_name = '+'
-                    field.null = True
-                    field.blank = True
             if isinstance(field, OrderWrt):
                 # OrderWrt is a proxy field, switch to a plain IntegerField
                 field.__class__ = models.IntegerField
-            transform_field(field)
+            if isinstance(field, models.ForeignKey):
+                old_field = field
+                field = type(field)(
+                    field.rel.to,
+                    related_name='+',
+                    null=True,
+                    blank=True,
+                    primary_key=False,
+                    db_index=True,
+                    serialize=True,
+                )
+                field._unique = False
+                field.name = old_field.name
+                field.db_constraint = False
+            else:
+                transform_field(field)
             fields[field.name] = field
         return fields
 
@@ -241,6 +241,8 @@ def get_history_user(self, instance):
 class CustomForeignKeyField(models.ForeignKey):
 
     def __init__(self, *args, **kwargs):
+        warnings.warn("CustomForeignKeyField is deprecated.",
+                      DeprecationWarning)
         super(CustomForeignKeyField, self).__init__(*args, **kwargs)
         self.db_constraint = False
         self.generate_reverse_relation = False

simple_history/tests/migration_test_app/migrations/0001_initial.py

@@ -3,7 +3,7 @@
 from __future__ import unicode_literals
 
 from django.db import models, migrations
-import simple_history.models
+import django.db.models.deletion
 from django.conf import settings
 
 
@@ -30,12 +30,9 @@ class Migration(migrations.Migration):
                 ('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)),
+                ('history_user', models.ForeignKey(on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, null=True)),
             ],
-            options={
-                'verbose_name': 'historical yar',
-                'ordering': ('-history_date', '-history_id'),
-            },
+            options={'ordering': ('-history_date', '-history_id'), 'get_latest_by': 'history_date', 'verbose_name': 'historical yar'},
             bases=(models.Model,),
         ),
         migrations.CreateModel(
@@ -59,8 +56,8 @@ class Migration(migrations.Migration):
         ),
         migrations.AddField(
             model_name='historicalyar',
-            name='what_id',
-            field=simple_history.models.CustomForeignKeyField(to='migration_test_app.WhatIMean', blank=True, null=True, related_name='+'),
+            name='what',
+            field=models.ForeignKey(related_name='+', db_constraint=False, blank=True, to='migration_test_app.WhatIMean', null=True),
             preserve_default=True,
         ),
     ]

simple_history/tests/tests/test_admin.py

@@ -234,4 +234,3 @@ def test_deleteting_user(self):
 
         historical_poll = poll.history.all()[0]
         self.assertEqual(historical_poll.history_user, None)
-

simple_history/tests/tests/test_models.py

@@ -487,20 +487,20 @@ def test_invalid_bases(self):
             self.assertRaises(TypeError, HistoricalRecords, bases=bases)
 
     def test_import_related(self):
-        field_object = HistoricalChoice._meta.get_field_by_name('poll_id')[0]
+        field_object = HistoricalChoice._meta.get_field_by_name('poll')[0]
         try:
             related_model = field_object.rel.related_model
         except AttributeError:  # Django<1.8
             related_model = field_object.related.model
-        self.assertEqual(related_model, Choice)
+        self.assertEqual(related_model, HistoricalChoice)
 
     def test_string_related(self):
-        field_object = HistoricalState._meta.get_field_by_name('library_id')[0]
+        field_object = HistoricalState._meta.get_field_by_name('library')[0]
         try:
             related_model = field_object.rel.related_model
         except AttributeError:  # Django<1.8
             related_model = field_object.related.model
-        self.assertEqual(related_model, State)
+        self.assertEqual(related_model, HistoricalState)
 
     @skipUnless(django.get_version() >= "1.7", "Requires 1.7 migrations")
     def test_state_serialization_of_customfk(self):
@@ -660,7 +660,8 @@ class TestLatest(TestCase):
     """"Test behavior of `latest()` without any field parameters"""
 
     def setUp(self):
-        poll = Poll.objects.create(question="Does `latest()` work?", pub_date=yesterday)
+        poll = Poll.objects.create(
+            question="Does `latest()` work?", pub_date=yesterday)
         poll.pub_date = today
         poll.save()