Class AdminSite

django.contrib.admin.sites.AdminSite

An AdminSite object encapsulates an instance of the Django admin application, ready

Declaration

class AdminSite

Documentation

to be hooked in to your URLconf. Models are registered with the AdminSite using the
register() method, and the get_urls() method can then be used to access Django view
functions that present a full admin interface for the collection of registered
models.

Methods

▷ def __init__(self, name='admin')
source link
▷ def actions(self) @property
Get all the enabled actions as an iterable of (name, func).
@property
def actions(self)
source link
▷ def add_action(self, action, name=None)
Register an action to be available globally.
source link

▶ def admin_view(self, view, cacheable=False)

Decorator to create an admin view attached to this ``AdminSite``. This wraps the view and provides permission checking by calling ``self.has_permission``.

source link

You'll want to use this from within ``AdminSite.get_urls()``:

    class MyAdminSite(AdminSite):

        def get_urls(self):
            from django.urls import path

            urls = super().get_urls()
            urls += [
                path('my_view/', self.admin_view(some_view))
            ]
            return urls

By default, admin_views are marked non-cacheable using the
``never_cache`` decorator. If the view can be safely cached, set
cacheable=True.

▷ def app_index(self, request, app_label, extra_context=None)
source link
▷ def check(self, app_configs)
Run the system checks on all ModelAdmins, except if they aren't customized at all.
source link
▷ def disable_action(self, name)
Disable a globally-registered action. Raise KeyError for invalid names.
source link
▶ def each_context(self, request)
Return a dictionary of variables to put in the template context for *every* page in the admin site.
source link
```
For sites running on a subpath, use the SCRIPT_NAME value if site_url
hasn't been customized.
```
▷ def get_action(self, name)
Explicitly get a registered global action whether it's enabled or not. Raise KeyError for invalid names.
source link
▷ def get_app_list(self, request)
Return a sorted list of all the installed apps that have been registered in this site.
source link
▷ def get_urls(self)
source link
▷ def has_permission(self, request)
Return True if the given HttpRequest has permission to view *at least one* page in the admin site.
source link
▶ def i18n_javascript(self, request, extra_context=None)
Display the i18n JavaScript that the Django admin requires.
source link
```
`extra_context` is unused but present for consistency with the other
admin views.
```
▷ def index(self, request, extra_context=None) @never_cache
Display the main admin index page, which lists all of the installed apps that have been registered in this site.
@never_cache
def index(
self,
request,
extra_context=None,
)
source link
▷ def is_registered(self, model)
Check if a model class is registered with this `AdminSite`.
source link
▷ def login(self, request, extra_context=None) @never_cache
Display the login form for the given HttpRequest.
@never_cache
def login(
self,
request,
extra_context=None,
)
source link
▶ def logout(self, request, extra_context=None) @never_cache
Log out the user for the given HttpRequest.
@never_cache
def logout(
self,
request,
extra_context=None,
)
source link
```
This should *not* assume the user is already logged in.
```
▷ def password_change(self, request, extra_context=None)
Handle the "change password" task -- both form display and validation.
source link
▷ def password_change_done(self, request, extra_context=None)
Display the "success" page after a password change.
source link

▶ def register(self, model_or_iterable, admin_class=None, **options)

source link

The model(s) should be Model classes, not instances.

If an admin class isn't given, use ModelAdmin (the default admin
options). If keyword arguments are given -- e.g., list_display --
apply them as options to the admin class.

If a model is already registered, raise AlreadyRegistered.

If a model is abstract, raise ImproperlyConfigured.

▶ def unregister(self, model_or_iterable)
Unregister the given model(s).
source link
```
If a model isn't already registered, raise NotRegistered.
```
▷ def urls(self) @property
@property
def urls(self)
source link

Reexports

Imported in django.contrib.gis.admin.
Imported in django.contrib.admin.