Opened 8 years ago

Last modified 5 years ago

#9982 new Bug

Inconsistent behavior on model save depending on whether OneToOneField is a primary key

Reported by: sean@… Owned by:
Component: Database layer (models, ORM) Version: 1.0
Severity: Normal Keywords: OneToOneField primary_key IntegrityError
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


When using a OneToOneField to make one model extend another, I noticed a behavioral inconsistency depending on whether the related model's OneToOneField was also the primary key or not.

The inconsistency is to do with when save() can be called on model instances.
Consider the following example models:

class BaseModel(models.Model):

class ExtendedModel(models.Model):
    link = models.OneToOneField(BaseModel)

It is not possible to first instantiate these models and later on save them - an IntegrityError would be raised when saving the ExtendedModel. E.g.,

o1 = BaseModel()
o2 = ExtendedModel(link=o1)

when o2 is saved it will raise an IntegrityError because it doesn't have a value for the primary key of the model it is related to. I think o1's primary key is copied when o2 is initialized, and is None at this point because o1 isn't saved yet.

However, if the definition of ExtendedModel is changed so that the OneToOneField is also the primary key, it now becomes possible to save the model instances in this order. To test this I changed the model definition as follows:

class ExtendedModel(models.Model):
    link = models.OneToOneField(BaseModel, primary_key=True)

When using this model definition it seems that o1's primary key is copied when o2 is saved, as opposed to when o2 is initialized. This inconsistency caused a lot of head scratching here.


Change History (8)

comment:1 Changed 8 years ago by mtredinnick

  • Needs documentation unset
  • Needs tests unset
  • Owner changed from nobody to mtredinnick
  • Patch needs improvement unset
  • Status changed from new to assigned

The second case shouldn't work either. I'll have to check whether it's really doing something sensible there (as opposed to just not raising an error). It may be because of something in place for model inheritance that it's working; I seem to recall we added an admin-related workaround that was a bit of a hack. In which case, it'll just need documentation.

Django cannot read your mind and does not automatically save things. So you do need to save something before using it as a reference. The first case is consistent and you should always save before using something as a related instance.

Leaving open until I understand and document (at a minimum) what's happening.

comment:2 Changed 7 years ago by anonymous

  • milestone post-1.0 deleted

Milestone post-1.0 deleted

comment:3 Changed 7 years ago by jacob

  • milestone set to 1.1
  • Triage Stage changed from Unreviewed to Accepted

comment:4 Changed 7 years ago by jacob

  • milestone changed from 1.1 to 1.2

Pushing to 1.2: this is an inconsistancy, not an outright bug.

comment:5 Changed 6 years ago by mtredinnick

  • milestone 1.2 deleted
  • Owner mtredinnick deleted
  • Status changed from assigned to new

Moving off the 1.2 milestone. As noted in the first comment, this should be raising an error in the case that appears to work, in the best case. So it's not a case of something not working that should.

comment:6 Changed 5 years ago by SmileyChris

  • Severity set to Normal
  • Type set to Bug

comment:7 Changed 5 years ago by aaugustin

  • UI/UX unset

Change UI/UX from NULL to False.

comment:8 Changed 5 years ago by aaugustin

  • Easy pickings unset

Change Easy pickings from NULL to False.

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