Changes between Version 185 and Version 186 of BackwardsIncompatibleChanges

Timestamp:

Jul 18, 2008, 7:13:20 PM (16 years ago)

Author:

Brian Rosner

Comment:

added a bit too much from nfa wiki page.

BackwardsIncompatibleChanges

@@ -685 +685 @@
 As of [7967] we have merged newforms-admin into trunk. Here is list of things that have changed:
 
-{{{
-#!python
-
-# OLD:
-from django.conf.urls.defaults import *
-
-urlpatterns = patterns('',
-    (r'^admin/', include('django.contrib.admin.urls')),
-)
-
-# NEW:
-from django.conf.urls.defaults import *
-from django.contrib import admin
-
-admin.autodiscover()
-
-urlpatterns = patterns('',
-    (r'^admin/(.*)', admin.site.root),
-)
-}}}
-
-Note that, in this above URLconf example, we're dealing with the object {{{django.contrib.admin.site}}}. This is an instance of {{{django.contrib.admin.AdminSite}}}, which is a class that lets you specify admin-site functionality. The object {{{django.contrib.admin.site}}} is a default {{{AdminSite}}} instance that is created for you automatically, but you can also create other instances as you see fit.
-
-We use the {{{admin.autodiscover()}}} call above to force the import of the {{{admin.py}}} module of each {{{INSTALLED_APPS}}} entry. This won't be needed if you use your own {{{AdminSite}}} instance since you will likely be importing those modules explicily in a project-level {{{admin.py}}}. This was added in [7872].
-
-Previously, there was one "global" version of the admin site, which used all models that contained a {{{class Admin}}}. This new scheme allows for much more fine-grained control over your admin sites, allowing you to have multiple admin sites in the same Django instance.
-
-In this example, we create two {{{AdminSite}}} instances, registering different models with both. Assume {{{Book}}}, {{{Author}}}, {{{Musician}}} and {{{Instrument}}} are Django model classes (not instances).
-
-{{{
-#!python
-
-# project-level admin.py
-
-from django.contrib import admin
-from myproject.myapp.models import Book, Author
-from myproject.anotherapp.models import Musician, Instrument
-
-site1 = admin.AdminSite()
-site1.register(Book)
-site1.register(Author)
-
-site2 = admin.AdminSite()
-site2.register(Musician)
-site2.register(Instrument)
-
-# URLconf
-
-from django.conf.urls.defaults import *
-from myproject.admin import site1, site2
-
-urlpatterns = patterns('',
-    (r'^book_admin/(.*)', site1.root),
-    (r'^music_admin/(.*)', site2.root),
-)
-}}}
-
-With this example, if you go to {{{/book_admin/}}}, you'll get a Django admin site for the {{{Book}}} and {{{Author}}} models. If you go to {{{/music_admin/}}}, you'll get a Django admin site for the {{{Musician}}} and {{{Instrument}}} models.
-
-Admin options -- the inner {{{class Admin}}} -- have changed, too. Models no longer use an inner class to declare their admin site options. In fact, '''all admin functionality has been decoupled from the model syntax'''! How, then, do we declare admin options? Like this:
-
-{{{
-#!python
-# a sample models.py file
-from django.db import models
-
-class Author(models.Model):
-    first_name = models.CharField(max_length=30)
-    last_name = models.CharField(max_length=30)
-
-    def __unicode__(self):
-        return u'%s %s' % (self.first_name, self.last_name)
-
-class Book(models.Model):
-    title = models.CharField(max_length=100)
-    author = models.ForeignKey(Author)
-
-# a sample admin.py file (in same app)
-from django.contrib import admin
-from myproject.myapp.models import Author, Book
-
-class BookAdmin(admin.ModelAdmin):
-    list_display = ('title', 'author')
-    ordering = ('title',)
-
-admin.site.register(Author)
-admin.site.register(Book, BookAdmin)
-}}}
-
-In this example, we register both {{{Author}}} and {{{Book}}} with the {{{AdminSite}}} instance {{{django.contrib.admin.site}}}. {{{Author}}} doesn't need any custom admin options, so we just call {{{admin.site.register(Author)}}}. {{{Book}}}, on the other hand, has some custom admin options, so we define a {{{BookAdmin}}} class and pass that class as a second argument to {{{admin.site.register()}}}.
-
-You'll notice the {{{BookAdmin}}} class looks a lot like the old-style {{{class Admin}}}. Almost all of the old {{{class Admin}}} options work exactly the same, with one or two exceptions. (For the options that have changed, we've made them '''much''' more powerful.) In addition to the classic options such as {{{list_display}}} and {{{ordering}}}, the {{{ModelAdmin}}} class introduces a wealth of extra hooks you can use to customize the admin site for that particular model. For example:
-
-{{{
-#!python
-
-class BookAdmin(admin.ModelAdmin):
-    list_display = ('title', 'author')
-    ordering = ('title',)
-
-    def has_change_permission(self, request, obj=None):
-        """
-        John can only edit books by Roald Dahl.
-        """
-        if obj and request.user.username == 'john':
-            return obj.author.last_name == 'Dahl'
-        return super(BookAdmin, self).has_change_permission(request, obj)
-}}}
-
-Look at the class {{{ModelAdmin}}} in the file [source:/django/branches/newforms-admin/django/contrib/admin/options.py django/contrib/admin/options.py] to see all of the methods you can override. This is exciting stuff.
-
-== To-do list ==
-
-  * See [http://code.djangoproject.com/query?status=new&status=assigned&status=reopened&keywords=%7Enfa-blocker&order=priority list of tickets] blocking the merge to trunk.
-  * See [http://code.djangoproject.com/query?status=new&status=assigned&status=reopened&keywords=%7Enfa-someday&order=priority list of tickets] that will be looked at after a merge to trunk.
-  * See [http://code.djangoproject.com/query?status=new&status=assigned&status=reopened&status=closed&keywords=%7Enfa-fixed&order=priority list of tickets] that have been fixed.
-
-== Backwards-incompatible changes ==
-
-This is a (currently incomplete) list of backwards-incompatible changes made in this branch.
-
 === Changed Admin.manager option to more flexible hook ===