Opened 7 years ago

Closed 3 months ago

#10506 closed Bug (fixed)

Automatically use correct auto-manager class for inherited models

Reported by: mtredinnick Owned by: mtredinnick
Component: Database layer (models, ORM) Version: master
Severity: Normal Keywords: use_for_related_fields
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

When creating a subclass of a model with a default manager that has use_for_related_fields = True, and if the subclass has no explicit manager set, we should use the class of the parent's manager. This is consistent with every other time we create an automatic manager (in fact, the docs added in r10057 hint that we already do this, but it's not quite true for subclasses yet).

For multiple base classes, we walk them all and choose the most derived manager satisfying this constraint. It should subclass all the other managers that also do. If there is no such manager (e.g. two different managers subclassing django.db.models.Manager), we raise an error and the user has to specify the default manager themselves. This is because there would be no way to ensure that an appropriate get_query_set() method id used

Using MRO to determine the class type is wrong, since a model that inherits from both an ordinary model and a gis model, in that order, needs a GeoManager (which already subclasses Manager, so we're fine).

When this is done, there's a "TODO" in the gis tests that can be removed, too (in a child model).

I'll get to this before 1.1, but I had to fix the first parts of this as part of some other yak-shaving and don't want to get distracted on this yet.

Change History (9)

comment:1 Changed 7 years ago by mtredinnick

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Summary changed from Understand correct auto-manager class for inherited models to Automatically use correct auto-manager class for inherited models
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 7 years ago by mtredinnick

  • milestone 1.1 deleted

Given the work to do before 1.1, pushing this one to later.

comment:3 Changed 5 years ago by SmileyChris

  • Severity set to Normal
  • Type set to Bug

comment:4 Changed 5 years ago by aaugustin

  • UI/UX unset

Change UI/UX from NULL to False.

comment:5 Changed 5 years ago by aaugustin

  • Easy pickings unset

Change Easy pickings from NULL to False.

comment:6 Changed 8 months ago by poleha

Replying to mtredinnick:

When creating a subclass of a model with a default manager that has use_for_related_fields = True, and if the subclass has no explicit manager set, we should use the class of the parent's manager.

I don't think that child class should inherit parent class's manager since documentation says it shouldn't: https://docs.djangoproject.com/en/dev/topics/db/managers/#custom-managers-and-model-inheritance

comment:7 Changed 4 months ago by timgraham

  • Keywords use_for_related_fields added

comment:8 Changed 3 months ago by loic

PR6175 revamps manager inheritance and allows choosing the default manager explicitly through the base_manager_name model option.

Last edited 3 months ago by loic (previous) (diff)

comment:9 Changed 3 months ago by Loïc Bistuer <loic.bistuer@…>

  • Resolution set to fixed
  • Status changed from new to closed

In ed0ff91:

Fixed #10506, #13793, #14891, #25201 -- Introduced new APIs to specify models' default and base managers.

This deprecates use_for_related_fields.

Old API:

class CustomManager(models.Model):

use_for_related_fields = True

class Model(models.Model):

custom_manager = CustomManager()

New API:

class Model(models.Model):

custom_manager = CustomManager()

class Meta:

base_manager_name = 'custom_manager'

Refs #20932, #25897.

Thanks Carl Meyer for the guidance throughout this work.
Thanks Tim Graham for writing the docs.

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