djangodocs.org

728 sections in Django 5.2 Search all versions →

YearArchiveView

Reference Generic date views

classYearArchiveView[source] : A yearly archive page showing all available months in a given year. Objects with a date in the future are not displayed unless you set allow_future to True.

MonthArchiveView

Reference Generic date views

classMonthArchiveView[source] : A monthly archive page showing all objects in a given month. Objects with a date in the future are not displayed unless you set allow_future to True.

TodayArchiveView

Reference Generic date views

classTodayArchiveView[source] : A day archive page showing all objects for today. This is exactly the same as django.views.generic.dates.DayArchiveView, except today’s date is used instead of the year/month/day arguments.

DetailView

Reference Generic display views

classdjango.views.generic.detail.DetailView : While this view is executing, self.object will contain the object that the view is operating upon. classdjango.views.generic.detail.BaseDetailView : A base view for displaying a single object.

ModelFormMixin

Reference Editing mixins

classdjango.views.generic.edit.ModelFormMixin : A form mixin that provides facilities for working with a ModelForm, rather than a standalone form.

MultipleObjectMixin

Reference Multiple object mixins

`context_object_name` : Designates the name of the variable to use in the context. `get_queryset()` : Get the list of items for this view. This must be an iterable and may be a queryset (in which queryset-specific behavior will be enabled).

SingleObjectMixin

Reference Single object mixins

If [`context_object_name`](#django.views.generic.detail.SingleObjectMixin.context_object_name) is not set, the context name will be constructed from the `model_name` of the model that the queryset is composed from. For example, the model `Article` would have context object named `'article'`.

Admin actions

Reference

For example, here’s the user module from Django’s built-in django.contrib.auth app: WARNING: The “delete selected objects” action uses QuerySet.delete() for efficiency reasons, which > has an important caveat: your model’s delete() method will not be > called.

Writing action functions

Reference Admin actions Writing actions

Action functions are regular functions that take three arguments: The current ModelAdmin An HttpRequest representing the current request, A QuerySet containing the set of objects selected by the user.

Reference Admin actions Advanced action techniques

By default, after an action is performed the user is redirected back to the original change list page. However, some actions, especially more complex ones, will need to return intermediate pages.

The action decorator

Reference Admin actions

action(*,permissions=None,description=None)[source] : This decorator can be used for setting specific attributes on custom action functions that can be used with actions:

ModelAdmin options

Reference The Django admin site ModelAdmin objects

ModelAdmin.list_filter : Set list_filter to activate filters in the right sidebar of the change list page of the admin. ModelAdmin.list_max_show_all : Set list_max_show_all to control how many items can appear on a “Show all” admin change list page.

ModelAdmin options

Reference The Django admin site ModelAdmin objects

ModelAdmin.raw_id_fields : By default, Django’s admin uses a select-box interface (<select>) for fields that are ForeignKey. Sometimes you don’t want to incur the overhead of having to select all the related instances to display in the drop-down.

ModelAdmin methods

Reference The Django admin site ModelAdmin objects

For example: ModelAdmin.get_search_results(request,queryset,search_term)[source] : The get_search_results method modifies the list of objects displayed into those that match the provided search term. It accepts the request, a queryset that applies the current filters, and the user-provided search term.

ModelAdmin methods

Reference The Django admin site ModelAdmin objects

This is how list_filter works, for example. The lookups are similar to what’s used in QuerySet.filter() (e.g. [email protected]). Since the lookups in the query string can be manipulated by the user, they must be sanitized to prevent unauthorized data exposure.

InlineModelAdmin options

Reference The Django admin site InlineModelAdmin objects

The shared features are: form fieldsets fields formfield_overrides exclude filter_horizontal filter_vertical ordering prepopulated_fields get_fieldsets() get_queryset() radio_fields readonly_fields raw_id_fields formfield_for_choice_field() formfield_for_foreignkey() formfield_for_manytomany() has_module_permission() The InlineModelAdmin class adds or customizes: InlineModelAdmin.model : The model which the inline is using. This is required.