#24208 closed Cleanup/optimization (fixed)
Change in `get_all_related_objects` behavior.
Reported by: | Tom Christie | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | 1.8alpha1 |
Severity: | Release blocker | Keywords: | |
Cc: | Tom Christie, cmawebsite@… | Triage Stage: | Ready for checkin |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
In Django 1.8 alpha, the behavior of the internal get_all_related_objects()
changes.
If I have a model with a reverse foreign key relationship then...
- In 1.7
get_all_related_objects
returns the relationship asdjango.db.models.related.RelatedObject
with themodel
attribute set to the source of the relationship. - In 1.8-alpha
get_all_related_objects
returns the relationship asdjango.db.models.fields.related.ManyToOneRel
with themodel
attribute set to the target of the relationship.
Effect is that for REST framework ModelSerializers any automatic reverse relationships will be incorrectly generated.
This is private API, but it's also currently API that third party apps do need to rely on in order to be able to function and correctly introspect the model relationships.
I'd also be okay with a resolution where this *isn't* fixed per-se, but that it is at least demonstrated that there's now an alternative route that I can use to correctly determine the reverse relationships.
Change History (8)
comment:1 by , 10 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:2 by , 10 years ago
Triage Stage: | Accepted → Unreviewed |
---|
Workaround - .related_model
will return the source model, so...
for relation in opts.get_all_related_objects(): to_model = getattr(relation, 'related_model', relation.model)
Appears to work consistently across Django versions.
comment:3 by , 10 years ago
Component: | Database layer (models, ORM) → Documentation |
---|---|
Triage Stage: | Unreviewed → Accepted |
Type: | Bug → Cleanup/optimization |
comment:4 by , 10 years ago
Cc: | added |
---|
Yes, this was a backwards-incompatible decision we made, but it needs to be documented.
I think we should document the getattr() approach. I've ran into this issue with contribute_to_related_class
and used the getattr() approach.
comment:6 by , 10 years ago
Triage Stage: | Accepted → Ready for checkin |
---|
comment:7 by , 10 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
The likely reason for this regression is that field.rel.model was defined differently from field.related.model. After removal of RelatedObject field.related is just a property that returns field.rel. Also, get_all_related_objects() used to return field.related, but now it likely returns field.rel instances.
I see a couple of approaches to solve this issue:
I think approach 1. is preferable. It should be easy to do so, and the field.related API is deprecated, so we get to remove the proxy object in a couple of releases.