Django

Code

Ticket #10356 (closed: fixed)

Opened 1 year ago

Last modified 1 year ago

proxy models: subclass a model without creating a new table

Reported by: rfk Assigned to: mtredinnick
Milestone: Component: Database layer (models, ORM)
Version: 1.0 Keywords:
Cc: Triage Stage: Accepted
Has patch: 0 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

Following a discussion with Malcolm on django-users, I've implemented support for what's tentatively named "proxy models". These provide a way for model subclasses to modify the behaviour of a model without creating a new database table. The canonical example seems to be subclassing the User model - you might want to add additional methods/managers/etc, but you still want to pull data directly from the main users table. Under the attached patch this would look like the following:

    class MyUser(User)
        def extra_method(self):
            print "I am a new method"
        class Meta:
            proxy = True

MyUser? is now simply a different view onto the main User table, rather than a full-blown subclass with a separate table.

The main body of the patch is to db/models/base.py, where the meta attributes of proxy models are automatically set up. Since it's now possible for a model to be using the same (table,primary key) pair as one of its base classes, I've added a small optimisation in db/models/sql/query.py that avoids a needless join in this case. There's also some tests and a first stab at some documentation.

This patch also integrates with (but doesn't require) ticket #3163, by marking proxy models as unmanaged.

The django-users discussion leading to this patch can be found here: http://groups.google.com/group/django-users/browse_thread/thread/fb06ff8e2a296f9c

Attachments

proxy_models.diff (13.2 kB) - added by rfk on 02/25/09 06:56:17.
patch implementing proxy models

Change History

02/25/09 06:56:17 changed by rfk

  • attachment proxy_models.diff added.

patch implementing proxy models

02/25/09 07:00:51 changed by rfk

  • needs_better_patch changed.
  • summary changed from proxy models: subclassing models without create a new table to proxy models: subclass a model without creating a new table.
  • needs_tests changed.
  • needs_docs changed.

whoops, fixed bad grammar in ticket summary

02/26/09 14:25:31 changed by Alex

  • stage changed from Unreviewed to Accepted.

02/28/09 21:48:50 changed by mtredinnick

  • owner changed from nobody to mtredinnick.

03/01/09 20:58:17 changed by mtredinnick

  • component changed from Uncategorized to Database layer (models, ORM).

03/18/09 04:47:09 changed by mtredinnick

  • status changed from new to closed.
  • resolution set to fixed.

(In [10083]) Fixed #10356 -- Added pure-Python inheritance for models (a.k.a proxy models).

Large portions of this are needed for #5420, so I implemented it fully. Thanks to Ryan Kelly for an initial patch to get this started.

Refs #5420.


Add/Change #10356 (proxy models: subclass a model without creating a new table)




Change Properties
Action