Opened 8 years ago

Closed 8 years ago

Last modified 5 years ago

#8309 closed (fixed)

GenericForeignKey fails when used in abstract base models

Reported by: Wonlay Owned by: Jacob
Component: Contrib apps Version: master
Severity: Keywords: GenericForeignKey, model inheritance
Cc: carl@…, wonlay@…, albrecht.andi@…, gonz@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:


The following code will reproduce this bug:

# aaa/
from django.contrib.contenttypes.models import ContentType
from django.contrib.contenttypes import generic

class MyModel(models.Model):
	field = models.IntegerField()

class TaggedItemBase(models.Model):
	class Meta:
		abstract = True

	content_type = models.ForeignKey(ContentType)
	object_id = models.PositiveIntegerField()

	content_object = generic.GenericForeignKey()

class TaggedItem(TaggedItemBase):
	"""A tag on an item."""
	tag = models.SlugField()

	class Meta:
		ordering = ["tag"]

	def __unicode__(self):
		return self.tag

# From command shell
>>> from aaa.models import MyModel, TaggedItem
>>> m = MyModel(field=1)
>>> t = TaggedItem(content_object=m, tag="my")
Traceback (most recent call last):
  File "<console>", line 1, in ?
  File "/usr/lib/python2.4/site-packages/django/db/models/", line 240, in __init__
    raise TypeError, "'%s' is an invalid keyword argument for this function" % kwargs.keys()[0]
TypeError: 'content_object' is an invalid keyword argument for this function

If we do not use model inheritance, the script works fine.

Attachments (1)

genericforeignkey_fail_in_abstract_models_r8507.diff (4.9 KB) - added by Manuel Saelices 8 years ago.
Patch that fixes problem (with tests)

Download all attachments as: .zip

Change History (17)

comment:1 Changed 8 years ago by Malcolm Tredinnick

milestone: 1.0 beta1.0
Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset
Triage Stage: UnreviewedAccepted

comment:2 Changed 8 years ago by Carl Meyer

Cc: carl@… added

comment:3 Changed 8 years ago by Wonlay

Cc: wonlay@… added

It may caused by:

GenericForeignKey.contribute_to_class is called on TaggedItemBase(not on TaggedItem), and register a signal pre_init.

When initialize the subclass TaggedItem, the signal does not fire.

comment:4 Changed 8 years ago by Wonlay

I found that 'content_object' is not in TaggedItem.__dict__, missing due to inheritance?

comment:5 Changed 8 years ago by Andi Albrecht

Cc: albrecht.andi@… added

comment:6 Changed 8 years ago by Manuel Saelices

Owner: changed from nobody to Manuel Saelices

comment:7 Changed 8 years ago by Manuel Saelices

Status: newassigned

comment:8 Changed 8 years ago by Manuel Saelices

Real problem is in this fragment of django.db.base.ModelBase class:

                # The abstract base class case.
                names = set([ for f in new_class._meta.local_fields + new_class._meta.many_to_many])
                for field in base._meta.local_fields + base._meta.local_many_to_many:
                    if in names:
                        raise FieldError('Local field %r in class %r clashes with field of similar name from abstract base class %r'
                                % (, name, base.__name__))
                    new_class.add_to_class(, copy.deepcopy(field))

The problem is django.contrib.generic.GenericForeignKey.contribute_to_class doesnt call to cls._meta.add_field(self), that insert field into base._meta.local_fields.

But the thing is GenericForeignKey is not a real field... is a virtual field. I'll try take a workaround that also implements a new feature, for adding virtual fields thats follow inheritance.

Changed 8 years ago by Manuel Saelices

Patch that fixes problem (with tests)

comment:9 Changed 8 years ago by Manuel Saelices

Has patch: set

comment:10 Changed 8 years ago by anonymous

msaelices's patch works fine for me?
Is it time to check in?

comment:11 Changed 8 years ago by Manuel Saelices

I'm not a core dev, I think patch works and of course pass all model tests. If a core developer think patch is good, he will check in as soon as possible (it's scheduled for 1.0)

comment:12 Changed 8 years ago by anonymous

Cc: gonz@… added

comment:13 Changed 8 years ago by Jacob

Owner: changed from Manuel Saelices to Jacob
Status: assignednew

comment:14 Changed 8 years ago by Jacob

Status: newassigned

comment:15 Changed 8 years ago by Jacob

Resolution: fixed
Status: assignedclosed

(In [8855]) Fixed #8309: subclasses now inherit GenericForeignKey correctly. There's also now an internal API so that other "virtual fields" like GFK can be inherited as well. Thanks, msaelices.

comment:16 Changed 5 years ago by Jacob

milestone: 1.0

Milestone 1.0 deleted

Note: See TracTickets for help on using tickets.
Back to Top