Opened 8 years ago

Closed 8 days ago

#15665 closed Bug (duplicate)

Inline admins are broken when primary key is not an AutoField and not editable.

Reported by: Sebastian Noack Owned by: nobody
Component: contrib.admin Version: 1.2
Severity: Normal Keywords:
Cc: olivier.dalang@…, Andi Albrecht Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no


For each inline object, a hidden field for its primary key (if it is an AutoField) is included in the form. But if you inherit from a concrete model that has a custom (not AutoField) primary key, you end up in a situation where you have a primary key which is a OneToOneField that is not editable in the admin.

from django.db import models

class Event(models.Model):
    name = models.CharField(max_length=100, primary_key=True)

    def __unicode__(self):

class Person(models.Model):
    name = models.CharField(max_length=100, primary_key=True)

    def __unicode__(self):

class Visitor(Person):
    event = models.ForeignKey(Event)

    def __unicode__(self):
        return u"'%s' at '%s'" % (self.person_ptr, self.event)
from django.contrib import admin

class VisitorInline(admin.StackedInline):
    model = Visitor

class EventAdmin(admin.ModelAdmin):
    inlines = [VisitorInline], EventAdmin)

In that case there is no element in the form that holds the primary key and you get the Exception below, when you try to save an existing object in the admin.

Traceback (most recent call last):

  File "/home/sebastian/djacap/fam/src/famtest/django/core/servers/", line 280, in run
    self.result = application(self.environ, self.start_response)

  File "/home/sebastian/djacap/fam/src/famtest/django/core/servers/", line 674, in __call__
    return self.application(environ, start_response)

  File "/home/sebastian/djacap/fam/src/famtest/django/core/handlers/", line 241, in __call__
    response = self.get_response(request)

  File "/home/sebastian/djacap/fam/src/famtest/django/core/handlers/", line 141, in get_response
    return self.handle_uncaught_exception(request, resolver, sys.exc_info())

  File "/home/sebastian/djacap/fam/src/famtest/django/core/handlers/", line 165, in handle_uncaught_exception
    return debug.technical_500_response(request, *exc_info)

  File "/home/sebastian/djacap/fam/src/famtest/django/views/", line 58, in technical_500_response
    html = reporter.get_traceback_html()

  File "/home/sebastian/djacap/fam/src/famtest/django/core/handlers/", line 100, in get_response
    response = callback(request, *callback_args, **callback_kwargs)

  File "/home/sebastian/djacap/fam/src/famtest/django/contrib/admin/", line 239, in wrapper
    return self.admin_site.admin_view(view)(*args, **kwargs)

  File "/home/sebastian/djacap/fam/src/famtest/django/utils/", line 76, in _wrapped_view
    response = view_func(request, *args, **kwargs)

  File "/home/sebastian/djacap/fam/src/famtest/django/views/decorators/", line 69, in _wrapped_view_func
    response = view_func(request, *args, **kwargs)

  File "/home/sebastian/djacap/fam/src/famtest/django/contrib/admin/", line 190, in inner
    return view(request, *args, **kwargs)

  File "/home/sebastian/djacap/fam/src/famtest/django/utils/", line 21, in _wrapper
    return decorator(bound_func)(*args, **kwargs)

  File "/home/sebastian/djacap/fam/src/famtest/django/utils/", line 76, in _wrapped_view
    response = view_func(request, *args, **kwargs)

  File "/home/sebastian/djacap/fam/src/famtest/django/utils/", line 17, in bound_func
    return func(self, *args2, **kwargs2)

  File "/home/sebastian/djacap/fam/src/famtest/django/db/", line 299, in _commit_on_success
    res = func(*args, **kw)

  File "/home/sebastian/djacap/fam/src/famtest/django/contrib/admin/", line 890, in change_view

  File "/home/sebastian/djacap/fam/src/famtest/django/forms/", line 705, in __init__

  File "/home/sebastian/djacap/fam/src/famtest/django/forms/", line 429, in __init__
    super(BaseModelFormSet, self).__init__(**defaults)

  File "/home/sebastian/djacap/fam/src/famtest/django/forms/", line 47, in __init__

  File "/home/sebastian/djacap/fam/src/famtest/django/forms/", line 97, in _construct_forms

  File "/home/sebastian/djacap/fam/src/famtest/django/forms/", line 718, in _construct_form
    form = super(BaseInlineFormSet, self)._construct_form(i, **kwargs)

  File "/home/sebastian/djacap/fam/src/famtest/django/forms/", line 446, in _construct_form
    pk =[pk_key]

  File "/home/sebastian/djacap/fam/src/famtest/django/utils/", line 235, in __getitem__
    raise MultiValueDictKeyError("Key %r not found in %r" % (key, self))

MultiValueDictKeyError: "Key 'visitor_set-0-person_ptr' not found in <QueryDict: {u'visitor_set-__prefix__-event': [u'FOSDEM'], u'name': [u'FOSDEM'], u'visitor_set-0-name': [u'Me'], u'visitor_set-3-event': [u'FOSDEM'], u'visitor_set-3-name': [u''], u'visitor_set-1-event': [u'FOSDEM'], u'visitor_set-1-name': [u''], u'visitor_set-2-event': [u'FOSDEM'], u'visitor_set-2-name': [u''], u'visitor_set-INITIAL_FORMS': [u'1'], u'visitor_set-TOTAL_FORMS': [u'4'], u'csrfmiddlewaretoken': [u'85dd78ff278138c4c70f2d1c8107bd95'], u'visitor_set-0-event': [u'FOSDEM'], u'_continue': [u'Save and continue editing'], u'visitor_set-MAX_NUM_FORMS': [u''], u'visitor_set-__prefix__-name': [u'']}>"

I found following line in admin/edit_inline/tabular.html and admin/edit_inline/stacked.html.

{% if inline_admin_form.has_auto_field %}{{ inline_admin_form.pk_field.field }}{% endif %}

Removing the check for has_auto_field fixed the error described above, but leads to wrong behavior, when modifying the value of the concrete base class's primary key (the name field in the example above) in the inline admin, resulting in a new entry.

I have reproduced that issue with django 1.2.3, 1.2.4, 1.2.5 and the latest version from SVN.

Change History (19)

comment:1 Changed 8 years ago by Luke Plant

Type: Bug

comment:2 Changed 8 years ago by Luke Plant

Severity: Normal

comment:3 Changed 8 years ago by anonymous

Component: Database layer (models, ORM)contrib.admin

comment:3 Changed 8 years ago by anonymous

Component: Database layer (models, ORM)contrib.admin

comment:4 Changed 8 years ago by Luke Plant

Triage Stage: UnreviewedAccepted

Accepted on the basis that we should do something better than crash. What exactly to do is tricky - it is similar to the case of editing the primary key value, which can result a new row rather than a changed row, IIRC.

comment:5 Changed 8 years ago by Sebastian Noack

I was able to work around that issue and make the objects from the inline admin editable including their primary key by following hack. It deletes all objects and re-adds them again. In my opinion django must support that case by default. But maybe their is a better way as first removing all objects.

from django.contrib import admin
from django.db import transaction

class SuperAdmin(admin.ModelAdmin):
    inlines = [SubSubInline]

    def save_model(self, *args, **kwargs):
        super(SuperAdmin, self).save_model(*args, **kwargs)
        self._saved = True

    def change_view(self, request, *args, **kwargs):
        if request.method != 'POST':
            return super(SuperAdmin, self).change_view(request, *args, **kwargs)


        # ModelAdmin.change_view is decorated with autocommit. So we
        # have to lazy patch the transaction API in order to bypass
        # transaction management from within ModelAdmin.change_view.
        # So we can rollback the transaction afterwards if needed.
        transaction_api = (transaction.enter_transaction_management,
                           transaction.commit, transaction.rollback)

        transaction.enter_transaction_management = lambda *args, **kwargs: None
        transaction.leave_transaction_management = lambda *args, **kwargs: None
        transaction.commit                       = lambda *args, **kwargs: None
        transaction.rollback                     = lambda *args, **kwargs: None

            for inline in self.inline_instances:
                prefix = inline.get_formset(request).get_default_prefix()

                request.POST = request.POST.copy()
                request.POST[prefix + '-INITIAL_FORMS'] = '0'


            return super(SuperAdmin, self).change_view(request, *args, **kwargs)
             transaction.commit, transaction.rollback) = transaction_api

            if getattr(self, '_saved', False):
                del self._saved

comment:6 Changed 8 years ago by Luke Plant

Probably related: #2259

comment:7 Changed 8 years ago by Alexander Herrmann

Easy pickings: unset
UI/UX: unset

Looks like an duplicate of #13696

comment:8 Changed 3 years ago by Tim Graham

This remains an issue as of 7a5b7e35bf2e219225b9f26d3dd3e34f26e83e9c (Django

comment:9 Changed 3 years ago by Olivier

Cc: olivier.dalang@… added

I agree it's kind of tricky when the user can change the ID (as expeced behaviour is not clear), but the issue also happens in a very normal case, simply when one is using UUIDs instead of regular autoincremented IDs :

from django.db import models
import uuid

class Event( models.Model ):
    id = models.UUIDField(primary_key=True, default=uuid.uuid4)
    name = models.CharField(max_length=10, blank=False)

    def __str__(self):

class Person( models.Model ):
    id = models.UUIDField(primary_key=True, default=uuid.uuid4)
    parent = models.ForeignKey('Event', null=True, blank=True, related_name='children')
    name = models.CharField(max_length=10, blank=True)

    def __str__(self):

class Visitor(Person):
from django.contrib import admin
from .models import Event, Visitor

class VisitorInline( admin.TabularInline ):
    model = Visitor
    show_change_link = True

class EventAdmin( admin.ModelAdmin ):
    inlines = [VisitorInline,], EventAdmin)

comment:10 Changed 3 years ago by Olivier

Has patch: set
Needs tests: set

I had a look at the source. I see two places where this can be fixed :

  1. in django/db/models/

Model inheritance is created using OneToOneField but doesn't set the field to editable=False.
This seems wrong, but at the same time, it seem to be consistent with regular primary keys, that for some reason don't set editable=False neither.
The fix consists of settings editable=False on those fields.
I'm not sure of the consequences of this, but this breaks potentially a lot of things.

  1. in django/contrib/admin/

There's a needs_explicit_pk_field() method which is exactly for that.
The fix B consists of return True if the primary key is a OneToOneField.
I guess this has much less consequences and is much safer.

What do you think ? For which fix should I open a PR ? Is there any chance this gets backported to 1.9 ?

comment:11 Changed 3 years ago by Tim Graham

I closed #26934 as a duplicate.

comment:12 Changed 3 years ago by Tim Graham

Needs tests: unset

comment:13 Changed 2 years ago by Tim Graham

Patch needs improvement: set

comment:14 Changed 2 years ago by Tim Graham

Patch needs improvement: unset

comment:15 Changed 2 years ago by Tim Graham

Patch needs improvement: set

As noted on the PR, the fix allows data corruption in some cases.

comment:16 Changed 15 months ago by Andi Albrecht

Cc: Andi Albrecht added

comment:17 Changed 8 days ago by Olivier

I think this is a duplicate of #27967 (which is fixed).

Last edited 8 days ago by Tim Graham (previous) (diff)

comment:18 Changed 8 days ago by Tim Graham

Resolution: duplicate
Status: newclosed
Note: See TracTickets for help on using tickets.
Back to Top