Changes between Version 46 and Version 47 of NewformsAdminBranch

Timestamp:

May 16, 2008, 2:25:24 PM (16 years ago)

Author:

Brian Rosner

Comment:

Fixed up some style and wording. Improved a couple of examples.

NewformsAdminBranch

@@ -102 +102 @@
     author = models.ForeignKey(Author)
 
-class BookOptions(admin.ModelAdmin):
+class BookAdmin(admin.ModelAdmin):
     list_display = ('title', 'author')
     ordering = ('title',)
@@ -108 +108 @@
 # Make sure the following are executed exactly once (i.e., watch your imports), or you'll see AlreadyRegistered exceptions.
 admin.site.register(Author)
-admin.site.register(Book, BookOptions)
-}}}
-
-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 {{{BookOptions}}} class and pass that class as a second argument to {{{admin.site.register()}}}.
+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()}}}.
 
 In this example, the admin options still live in the {{{models.py}}} file. But there's nothing that requires them to do so. The only requirement is that the {{{register()}}} calls are executed at some point, and putting them in the {{{models.py}}} is an easy way to ensure that. We'll likely come up with a nice convention for this.[[BR]]
@@ -117 +117 @@
 '''A proposal convention''': Specifying all admin options in a file called {{{admin.py}}}, and import it in the {{{__init__.py}}} file of your application module to do the registering during the initialization.
 
-You'll notice the {{{BookOptions}}} 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 BookOptions(admin.ModelAdmin):
+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',)
@@ -132 +132 @@
         if obj and request.user.username == 'john':
             return obj.author.last_name == 'Dahl'
-        return super(BookOptions, self).has_change_permission(request, obj)
+        return super(BookAdmin, self).has_change_permission(request, obj)
 }}}
 
@@ -149 +149 @@
 === Changed Admin.manager option to more flexible hook ===
 
-As of [4342], the {{{manager}}} option to {{{class Admin}}} no longer exists. This option was undocumented, but we're mentioning the change here in case you used it. In favor of this option, {{{class Admin}}} may now define one of these methods:
-
-  * {{{queryset()}}}
-  * {{{queryset_add()}}}
-  * {{{queryset_change()}}}
-
-These give you much more flexibility.
-
-(We initially called the new method {{{change_list_queryset}}}, but this was changed in [4584] to be more flexible.)
+As of [4342], the {{{manager}}} option to {{{class Admin}}} no longer exists. This option was undocumented, but we're mentioning the change here in case you used it. In favor of this option, {{{class Admin}}} may now define a ```queryset``` method:
+
+{{{
+#!python
+
+class BookAdmin(admin.ModelAdmin):
+    def queryset(self, request):
+        """
+        Filter based on the current user.
+        """
+        return self.model._default_manager.filter(user=request.user)
+}}}
 
 === Changed prepopulate_from to be defined in the Admin class, not database field classes ===
@@ -183 +186 @@
 from django.contrib import admin
 
-class MyModelOptions(admin.ModelAdmin):
+class MyModelAdmin(admin.ModelAdmin):
     prepopulated_fields = {'slug': ('first_name', 'last_name')}
 
-admin.site.register(MyModel, MyModelOptions)
+admin.site.register(MyModel, MyModelAdmin)
 }}}
 
@@ -223 +226 @@
    class Admin:
      fields = (
-       ('group1', {'fields': ('field1','field2'), 'classes': 'collapse'}),
-       ('group2', {'fields': ('field3','field4'), 'classes': 'collapse wide'}),
-       )
-
-# NEW:
-class MyModelA_Options(admin.ModelAdmin):
-    fields = ('field1','field2','field3','field4')  # Renaming is optional 
-
-class MyModelB_Options(admin.ModelAdmin):
+         ('group1', {'fields': ('field1','field2'), 'classes': 'collapse'}),
+         ('group2', {'fields': ('field3','field4'), 'classes': 'collapse wide'}),
+     )
+
+# NEW:
+class MyModelAdmin(admin.ModelAdmin):
+    fields = ('field1', 'field2', 'field3', 'field4')  # Renaming is optional 
+
+class AnotherModelAdmin(admin.ModelAdmin):
      fieldsets = (
-       ('group1', {'fields': ('field1','field2'), 'classes': ('collapse',)}),
-       ('group2', {'fields': ('field3','field4'), 'classes': ('collapse', 'wide')}),
-       )
+         ('group1', {'fields': ('field1','field2'), 'classes': ('collapse',)}),
+         ('group2', {'fields': ('field3','field4'), 'classes': ('collapse', 'wide')}),
+     )
 }}}
 
@@ -246 +249 @@
 #!python
 from django.contrib import admin 
-class Child_Inline(admin.TabularInline): 
+
+class ChildInline(admin.TabularInline): 
     model = Child 
     extra = 3 
 
-class Parent_admin(admin.ModelAdmin): 
+class ParentAdmin(admin.ModelAdmin):
     model = Parent
-    inlines = [Child_Inline] 
+    inlines = [ChildInline]
 }}}
 
@@ -262 +266 @@
 {{{
 #!python
+
 # OLD:
 class MyModel(models.Model): 
     field1 = models.ForeignKey(AnotherModel, raw_id_admin=True)
+    
     class Admin:
         pass
 
 # NEW:
-class MyModel_Options(admin.ModelAdmin): 
+class MyModelAdmin(admin.ModelAdmin):
     model = MyModel
     raw_id_fields = ('field1',) 
@@ -279 +285 @@
 opposed to using oldforms. If you are relying on the oldforms, you will need
 to modify your code/templates to work with newforms.
+