summaryrefslogtreecommitdiff
path: root/django/contrib/admin
diff options
context:
space:
mode:
authorBrian Holdefehr <bhold45@gmail.com>2012-12-17 19:04:10 -0500
committerTim Graham <timograham@gmail.com>2013-09-18 11:44:10 -0400
commit98514849dce07acfaa224a90a784bba9d97249e5 (patch)
treea15ade3b3380f171a9ba17e3979606e0d688b738 /django/contrib/admin
parentd1c9802811b5c3f5abd3defcfecac160135fa6e7 (diff)
Fixed #19414 -- Added admin registration decorator
Thanks stavros for the suggestion.
Diffstat (limited to 'django/contrib/admin')
-rw-r--r--django/contrib/admin/__init__.py1
-rw-r--r--django/contrib/admin/decorators.py28
2 files changed, 29 insertions, 0 deletions
diff --git a/django/contrib/admin/__init__.py b/django/contrib/admin/__init__.py
index 3975993679..cba84cf807 100644
--- a/django/contrib/admin/__init__.py
+++ b/django/contrib/admin/__init__.py
@@ -1,5 +1,6 @@
# ACTION_CHECKBOX_NAME is unused, but should stay since its import from here
# has been referenced in documentation.
+from django.contrib.admin.decorators import register
from django.contrib.admin.helpers import ACTION_CHECKBOX_NAME
from django.contrib.admin.options import ModelAdmin, HORIZONTAL, VERTICAL
from django.contrib.admin.options import StackedInline, TabularInline
diff --git a/django/contrib/admin/decorators.py b/django/contrib/admin/decorators.py
new file mode 100644
index 0000000000..cc6943dbdd
--- /dev/null
+++ b/django/contrib/admin/decorators.py
@@ -0,0 +1,28 @@
+def register(*models, **kwargs):
+ """
+ Registers the given model(s) classes and wrapped ModelAdmin class with
+ admin site:
+
+ @register(Author)
+ class AuthorAdmin(admin.ModelAdmin):
+ pass
+
+ A kwarg of `site` can be passed as the admin site, otherwise the default
+ admin site will be used.
+ """
+ from django.contrib.admin import ModelAdmin
+ from django.contrib.admin.sites import site, AdminSite
+
+ def _model_admin_wrapper(admin_class):
+ admin_site = kwargs.pop('site', site)
+
+ if not isinstance(admin_site, AdminSite):
+ raise ValueError('site must subclass AdminSite')
+
+ if not issubclass(admin_class, ModelAdmin):
+ raise ValueError('Wrapped class must sublcass ModelAdmin.')
+
+ admin_site.register(models, admin_class=admin_class)
+
+ return admin_class
+ return _model_admin_wrapper