doc_content stringlengths 1 386k | doc_id stringlengths 5 188 |
|---|---|
month
Optional The value for the month, as a string. By default, set to None, which means the month will be determined using other means. | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.MonthMixin.month |
month_format
The strftime() format to use when parsing the month. By default, this is '%b'. | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.MonthMixin.month_format |
class TodayArchiveView
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. Ancestors (MRO) django.views.generic.list.MultipleObjectTemplateResponseMixin django.views.generic.base.... | django.ref.class-based-views.generic-date-based#django.views.generic.dates.TodayArchiveView |
class WeekArchiveView
A weekly archive page showing all objects in a given week. Objects with a date in the future are not displayed unless you set allow_future to True. Ancestors (MRO) django.views.generic.list.MultipleObjectTemplateResponseMixin django.views.generic.base.TemplateResponseMixin django.views.generic.... | django.ref.class-based-views.generic-date-based#django.views.generic.dates.WeekArchiveView |
class WeekMixin
A mixin that can be used to retrieve and provide parsing information for a week component of a date. Methods and Attributes
week_format
The strftime() format to use when parsing the week. By default, this is '%U', which means the week starts on Sunday. Set it to '%W' or '%V' (ISO 8601 week) if you... | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.WeekMixin |
get_next_week(date)
Returns a date object containing the first day of the week after the date provided. This function can also return None or raise an Http404 exception, depending on the values of allow_empty and allow_future. | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.WeekMixin.get_next_week |
get_prev_week(date)
Returns a date object containing the first day of the week before the date provided. This function can also return None or raise an Http404 exception, depending on the values of allow_empty and allow_future. | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.WeekMixin.get_prev_week |
get_week()
Returns the week for which this view will display data, as a string. Tries the following sources, in order: The value of the WeekMixin.week attribute. The value of the week argument captured in the URL pattern The value of the week GET query argument. Raises a 404 if no valid week specification can be fo... | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.WeekMixin.get_week |
get_week_format()
Returns the strftime() format to use when parsing the week. Returns week_format by default. | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.WeekMixin.get_week_format |
week
Optional The value for the week, as a string. By default, set to None, which means the week will be determined using other means. | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.WeekMixin.week |
week_format
The strftime() format to use when parsing the week. By default, this is '%U', which means the week starts on Sunday. Set it to '%W' or '%V' (ISO 8601 week) if your week starts on Monday. New in Django 3.2: Support for the '%V' week format was added. | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.WeekMixin.week_format |
class YearArchiveView
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. Ancestors (MRO) django.views.generic.list.MultipleObjectTemplateResponseMixin django.views.generic.base.TemplateResponseMixin django.views... | django.ref.class-based-views.generic-date-based#django.views.generic.dates.YearArchiveView |
get_make_object_list()
Determine if an object list will be returned as part of the context. Returns make_object_list by default. | django.ref.class-based-views.generic-date-based#django.views.generic.dates.YearArchiveView.get_make_object_list |
make_object_list
A boolean specifying whether to retrieve the full list of objects for this year and pass those to the template. If True, the list of objects will be made available to the context. If False, the None queryset will be used as the object list. By default, this is False. | django.ref.class-based-views.generic-date-based#django.views.generic.dates.YearArchiveView.make_object_list |
class YearMixin
A mixin that can be used to retrieve and provide parsing information for a year component of a date. Methods and Attributes
year_format
The strftime() format to use when parsing the year. By default, this is '%Y'.
year
Optional The value for the year, as a string. By default, set to None, wh... | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.YearMixin |
get_next_year(date)
Returns a date object containing the first day of the year after the date provided. This function can also return None or raise an Http404 exception, depending on the values of allow_empty and allow_future. | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.YearMixin.get_next_year |
get_previous_year(date)
Returns a date object containing the first day of the year before the date provided. This function can also return None or raise an Http404 exception, depending on the values of allow_empty and allow_future. | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.YearMixin.get_previous_year |
get_year()
Returns the year for which this view will display data, as a string. Tries the following sources, in order: The value of the YearMixin.year attribute. The value of the year argument captured in the URL pattern. The value of the year GET query argument. Raises a 404 if no valid year specification can be f... | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.YearMixin.get_year |
get_year_format()
Returns the strftime() format to use when parsing the year. Returns year_format by default. | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.YearMixin.get_year_format |
year
Optional The value for the year, as a string. By default, set to None, which means the year will be determined using other means. | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.YearMixin.year |
year_format
The strftime() format to use when parsing the year. By default, this is '%Y'. | django.ref.class-based-views.mixins-date-based#django.views.generic.dates.YearMixin.year_format |
class django.views.generic.detail.BaseDetailView
A base view for displaying a single object. It is not intended to be used directly, but rather as a parent class of the django.views.generic.detail.DetailView or other views representing details of a single object. Ancestors (MRO) This view inherits methods and attribu... | django.ref.class-based-views.generic-display#django.views.generic.detail.BaseDetailView |
get(request, *args, **kwargs)
Adds object to the context. | django.ref.class-based-views.generic-display#django.views.generic.detail.BaseDetailView.get |
class django.views.generic.detail.DetailView
While this view is executing, self.object will contain the object that the view is operating upon. Ancestors (MRO) This view inherits methods and attributes from the following views: django.views.generic.detail.SingleObjectTemplateResponseMixin django.views.generic.base.T... | django.ref.class-based-views.generic-display#django.views.generic.detail.DetailView |
class django.views.generic.detail.SingleObjectMixin
Provides a mechanism for looking up an object associated with the current HTTP request. Methods and Attributes
model
The model that this view will display data for. Specifying model
= Foo is effectively the same as specifying queryset =
Foo.objects.all(), where ... | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectMixin |
context_object_name
Designates the name of the variable to use in the context. | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectMixin.context_object_name |
get_context_data(**kwargs)
Returns context data for displaying the object. The base implementation of this method requires that the self.object attribute be set by the view (even if None). Be sure to do this if you are using this mixin without one of the built-in views that does so. It returns a dictionary with these... | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectMixin.get_context_data |
get_context_object_name(obj)
Return the context variable name that will be used to contain the data that this view is manipulating. If 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 con... | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectMixin.get_context_object_name |
get_object(queryset=None)
Returns the single object that this view will display. If queryset is provided, that queryset will be used as the source of objects; otherwise, get_queryset() will be used. get_object() looks for a pk_url_kwarg argument in the arguments to the view; if this argument is found, this method per... | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectMixin.get_object |
get_queryset()
Returns the queryset that will be used to retrieve the object that this view will display. By default, get_queryset() returns the value of the queryset attribute if it is set, otherwise it constructs a QuerySet by calling the all() method on the model attribute’s default manager. | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectMixin.get_queryset |
get_slug_field()
Returns the name of a slug field to be used to look up by slug. By default this returns the value of slug_field. | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectMixin.get_slug_field |
model
The model that this view will display data for. Specifying model
= Foo is effectively the same as specifying queryset =
Foo.objects.all(), where objects stands for Foo’s default manager. | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectMixin.model |
pk_url_kwarg
The name of the URLConf keyword argument that contains the primary key. By default, pk_url_kwarg is 'pk'. | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectMixin.pk_url_kwarg |
query_pk_and_slug
If True, causes get_object() to perform its lookup using both the primary key and the slug. Defaults to False. This attribute can help mitigate insecure direct object reference attacks. When applications allow access to individual objects by a sequential primary key, an attacker could brute-force gu... | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectMixin.query_pk_and_slug |
queryset
A QuerySet that represents the objects. If provided, the value of queryset supersedes the value provided for model. Warning queryset is a class attribute with a mutable value so care must be taken when using it directly. Before using it, either call its all() method or retrieve it with get_queryset() which ... | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectMixin.queryset |
slug_field
The name of the field on the model that contains the slug. By default, slug_field is 'slug'. | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectMixin.slug_field |
slug_url_kwarg
The name of the URLConf keyword argument that contains the slug. By default, slug_url_kwarg is 'slug'. | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectMixin.slug_url_kwarg |
class django.views.generic.detail.SingleObjectTemplateResponseMixin
A mixin class that performs template-based response rendering for views that operate upon a single object instance. Requires that the view it is mixed with provides self.object, the object instance that the view is operating on. self.object will usua... | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectTemplateResponseMixin |
get_template_names()
Returns a list of candidate template names. Returns the following list: the value of template_name on the view (if provided) the contents of the template_name_field field on the object instance that the view is operating upon (if available) <app_label>/<model_name><template_name_suffix>.html | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectTemplateResponseMixin.get_template_names |
template_name_field
The field on the current object instance that can be used to determine the name of a candidate template. If either template_name_field itself or the value of the template_name_field on the current object instance is None, the object will not be used for a candidate template name. | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_field |
template_name_suffix
The suffix to append to the auto-generated candidate template name. Default suffix is _detail. | django.ref.class-based-views.mixins-single-object#django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_suffix |
class django.views.generic.edit.BaseCreateView
A base view for creating a new object instance. It is not intended to be used directly, but rather as a parent class of the django.views.generic.edit.CreateView. Ancestors (MRO) This view inherits methods and attributes from the following views: django.views.generic.edi... | django.ref.class-based-views.generic-editing#django.views.generic.edit.BaseCreateView |
get(request, *args, **kwargs)
Sets the current object instance (self.object) to None. | django.ref.class-based-views.generic-editing#django.views.generic.edit.BaseCreateView.get |
post(request, *args, **kwargs)
Sets the current object instance (self.object) to None. | django.ref.class-based-views.generic-editing#django.views.generic.edit.BaseCreateView.post |
class django.views.generic.edit.BaseDeleteView
A base view for deleting an object instance. It is not intended to be used directly, but rather as a parent class of the django.views.generic.edit.DeleteView. Ancestors (MRO) This view inherits methods and attributes from the following views: django.views.generic.edit.D... | django.ref.class-based-views.generic-editing#django.views.generic.edit.BaseDeleteView |
class django.views.generic.edit.BaseFormView
A base view for displaying a form. It is not intended to be used directly, but rather as a parent class of the django.views.generic.edit.FormView or other views displaying a form. Ancestors (MRO) This view inherits methods and attributes from the following views: django.v... | django.ref.class-based-views.generic-editing#django.views.generic.edit.BaseFormView |
class django.views.generic.edit.BaseUpdateView
A base view for updating an existing object instance. It is not intended to be used directly, but rather as a parent class of the django.views.generic.edit.UpdateView. Ancestors (MRO) This view inherits methods and attributes from the following views: django.views.gener... | django.ref.class-based-views.generic-editing#django.views.generic.edit.BaseUpdateView |
get(request, *args, **kwargs)
Sets the current object instance (self.object). | django.ref.class-based-views.generic-editing#django.views.generic.edit.BaseUpdateView.get |
post(request, *args, **kwargs)
Sets the current object instance (self.object). | django.ref.class-based-views.generic-editing#django.views.generic.edit.BaseUpdateView.post |
class django.views.generic.edit.CreateView
A view that displays a form for creating an object, redisplaying the form with validation errors (if there are any) and saving the object. Ancestors (MRO) This view inherits methods and attributes from the following views: django.views.generic.detail.SingleObjectTemplateRes... | django.ref.class-based-views.generic-editing#django.views.generic.edit.CreateView |
object
When using CreateView you have access to self.object, which is the object being created. If the object hasn’t been created yet, the value will be None. | django.ref.class-based-views.generic-editing#django.views.generic.edit.CreateView.object |
template_name_suffix
The CreateView page displayed to a GET request uses a template_name_suffix of '_form'. For example, changing this attribute to '_create_form' for a view creating objects for the example Author model would cause the default template_name to be 'myapp/author_create_form.html'. | django.ref.class-based-views.generic-editing#django.views.generic.edit.CreateView.template_name_suffix |
class django.views.generic.edit.DeleteView
A view that displays a confirmation page and deletes an existing object. The given object will only be deleted if the request method is POST. If this view is fetched via GET, it will display a confirmation page that should contain a form that POSTs to the same URL. Ancestors... | django.ref.class-based-views.generic-editing#django.views.generic.edit.DeleteView |
form_class
New in Django 4.0. Inherited from BaseDeleteView. The form class that will be used to confirm the request. By default django.forms.Form, resulting in an empty form that is always valid. By providing your own Form subclass, you can add additional requirements, such as a confirmation checkbox, for example. | django.ref.class-based-views.generic-editing#django.views.generic.edit.DeleteView.form_class |
template_name_suffix
The DeleteView page displayed to a GET request uses a template_name_suffix of '_confirm_delete'. For example, changing this attribute to '_check_delete' for a view deleting objects for the example Author model would cause the default template_name to be 'myapp/author_check_delete.html'. | django.ref.class-based-views.generic-editing#django.views.generic.edit.DeleteView.template_name_suffix |
class django.views.generic.edit.DeletionMixin
Enables handling of the DELETE HTTP action. Methods and Attributes
success_url
The url to redirect to when the nominated object has been successfully deleted. success_url may contain dictionary string formatting, which will be interpolated against the object’s field a... | django.ref.class-based-views.mixins-editing#django.views.generic.edit.DeletionMixin |
delete(request, *args, **kwargs)
Retrieves the target object and calls its delete() method, then redirects to the success URL. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.DeletionMixin.delete |
get_success_url()
Returns the url to redirect to when the nominated object has been successfully deleted. Returns success_url by default. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.DeletionMixin.get_success_url |
success_url
The url to redirect to when the nominated object has been successfully deleted. success_url may contain dictionary string formatting, which will be interpolated against the object’s field attributes. For example, you could use success_url="/parent/{parent_id}/" to redirect to a URL composed out of the par... | django.ref.class-based-views.mixins-editing#django.views.generic.edit.DeletionMixin.success_url |
class django.views.generic.edit.FormMixin
A mixin class that provides facilities for creating and displaying forms. Mixins django.views.generic.base.ContextMixin Methods and Attributes
initial
A dictionary containing initial data for the form.
form_class
The form class to instantiate.
success_url
Th... | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin |
form_class
The form class to instantiate. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin.form_class |
form_invalid(form)
Renders a response, providing the invalid form as context. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin.form_invalid |
form_valid(form)
Redirects to get_success_url(). | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin.form_valid |
get_context_data(**kwargs)
Calls get_form() and adds the result to the context data with the name ‘form’. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin.get_context_data |
get_form(form_class=None)
Instantiate an instance of form_class using get_form_kwargs(). If form_class isn’t provided get_form_class() will be used. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin.get_form |
get_form_class()
Retrieve the form class to instantiate. By default form_class. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin.get_form_class |
get_form_kwargs()
Build the keyword arguments required to instantiate the form. The initial argument is set to get_initial(). If the request is a POST or PUT, the request data (request.POST and request.FILES) will also be provided. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin.get_form_kwargs |
get_initial()
Retrieve initial data for the form. By default, returns a copy of initial. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin.get_initial |
get_prefix()
Determine the prefix for the generated form. Returns prefix by default. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin.get_prefix |
get_success_url()
Determine the URL to redirect to when the form is successfully validated. Returns success_url by default. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin.get_success_url |
initial
A dictionary containing initial data for the form. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin.initial |
prefix
The prefix for the generated form. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin.prefix |
success_url
The URL to redirect to when the form is successfully processed. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.FormMixin.success_url |
class django.views.generic.edit.FormView
A view that displays a form. On error, redisplays the form with validation errors; on success, redirects to a new URL. Ancestors (MRO) This view inherits methods and attributes from the following views: django.views.generic.base.TemplateResponseMixin django.views.generic.edit... | django.ref.class-based-views.generic-editing#django.views.generic.edit.FormView |
class django.views.generic.edit.ModelFormMixin
A form mixin that works on ModelForms, rather than a standalone form. Since this is a subclass of SingleObjectMixin, instances of this mixin have access to the model and queryset attributes, describing the type of object that the ModelForm is manipulating. If you specify... | django.ref.class-based-views.mixins-editing#django.views.generic.edit.ModelFormMixin |
fields
A list of names of fields. This is interpreted the same way as the Meta.fields attribute of ModelForm. This is a required attribute if you are generating the form class automatically (e.g. using model). Omitting this attribute will result in an ImproperlyConfigured exception. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.ModelFormMixin.fields |
form_invalid(form)
Renders a response, providing the invalid form as context. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.ModelFormMixin.form_invalid |
form_valid(form)
Saves the form instance, sets the current object for the view, and redirects to get_success_url(). | django.ref.class-based-views.mixins-editing#django.views.generic.edit.ModelFormMixin.form_valid |
get_form_class()
Retrieve the form class to instantiate. If form_class is provided, that class will be used. Otherwise, a ModelForm will be instantiated using the model associated with the queryset, or with the model, depending on which attribute is provided. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.ModelFormMixin.get_form_class |
get_form_kwargs()
Add the current instance (self.object) to the standard get_form_kwargs(). | django.ref.class-based-views.mixins-editing#django.views.generic.edit.ModelFormMixin.get_form_kwargs |
get_success_url()
Determine the URL to redirect to when the form is successfully validated. Returns django.views.generic.edit.ModelFormMixin.success_url if it is provided; otherwise, attempts to use the get_absolute_url() of the object. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.ModelFormMixin.get_success_url |
model
A model class. Can be explicitly provided, otherwise will be determined by examining self.object or queryset. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.ModelFormMixin.model |
success_url
The URL to redirect to when the form is successfully processed. success_url may contain dictionary string formatting, which will be interpolated against the object’s field attributes. For example, you could use success_url="/polls/{slug}/" to redirect to a URL composed out of the slug field on a model. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.ModelFormMixin.success_url |
class django.views.generic.edit.ProcessFormView
A mixin that provides basic HTTP GET and POST workflow. Note This is named ‘ProcessFormView’ and inherits directly from django.views.generic.base.View, but breaks if used independently, so it is more of a mixin. Extends django.views.generic.base.View Methods and Att... | django.ref.class-based-views.mixins-editing#django.views.generic.edit.ProcessFormView |
get(request, *args, **kwargs)
Renders a response using a context created with get_context_data(). | django.ref.class-based-views.mixins-editing#django.views.generic.edit.ProcessFormView.get |
post(request, *args, **kwargs)
Constructs a form, checks the form for validity, and handles it accordingly. | django.ref.class-based-views.mixins-editing#django.views.generic.edit.ProcessFormView.post |
put(*args, **kwargs)
The PUT action is also handled and passes all parameters through to post(). | django.ref.class-based-views.mixins-editing#django.views.generic.edit.ProcessFormView.put |
class django.views.generic.edit.UpdateView
A view that displays a form for editing an existing object, redisplaying the form with validation errors (if there are any) and saving changes to the object. This uses a form automatically generated from the object’s model class (unless a form class is manually specified). A... | django.ref.class-based-views.generic-editing#django.views.generic.edit.UpdateView |
object
When using UpdateView you have access to self.object, which is the object being updated. | django.ref.class-based-views.generic-editing#django.views.generic.edit.UpdateView.object |
template_name_suffix
The UpdateView page displayed to a GET request uses a template_name_suffix of '_form'. For example, changing this attribute to '_update_form' for a view updating objects for the example Author model would cause the default template_name to be 'myapp/author_update_form.html'. | django.ref.class-based-views.generic-editing#django.views.generic.edit.UpdateView.template_name_suffix |
class django.views.generic.list.BaseListView
A base view for displaying a list of objects. It is not intended to be used directly, but rather as a parent class of the django.views.generic.list.ListView or other views representing lists of objects. Ancestors (MRO) This view inherits methods and attributes from the fol... | django.ref.class-based-views.generic-display#django.views.generic.list.BaseListView |
get(request, *args, **kwargs)
Adds object_list to the context. If allow_empty is True then display an empty list. If allow_empty is False then raise a 404 error. | django.ref.class-based-views.generic-display#django.views.generic.list.BaseListView.get |
class django.views.generic.list.ListView
A page representing a list of objects. While this view is executing, self.object_list will contain the list of objects (usually, but not necessarily a queryset) that the view is operating upon. Ancestors (MRO) This view inherits methods and attributes from the following views:... | django.ref.class-based-views.generic-display#django.views.generic.list.ListView |
class django.views.generic.list.MultipleObjectMixin
A mixin that can be used to display a list of objects. If paginate_by is specified, Django will paginate the results returned by this. You can specify the page number in the URL in one of two ways:
Use the page parameter in the URLconf. For example, this is what y... | django.ref.class-based-views.mixins-multiple-object#django.views.generic.list.MultipleObjectMixin |
allow_empty
A boolean specifying whether to display the page if no objects are available. If this is False and no objects are available, the view will raise a 404 instead of displaying an empty page. By default, this is True. | django.ref.class-based-views.mixins-multiple-object#django.views.generic.list.MultipleObjectMixin.allow_empty |
context_object_name
Designates the name of the variable to use in the context. | django.ref.class-based-views.mixins-multiple-object#django.views.generic.list.MultipleObjectMixin.context_object_name |
get_allow_empty()
Return a boolean specifying whether to display the page if no objects are available. If this method returns False and no objects are available, the view will raise a 404 instead of displaying an empty page. By default, this is True. | django.ref.class-based-views.mixins-multiple-object#django.views.generic.list.MultipleObjectMixin.get_allow_empty |
get_context_data(**kwargs)
Returns context data for displaying the list of objects. | django.ref.class-based-views.mixins-multiple-object#django.views.generic.list.MultipleObjectMixin.get_context_data |
get_context_object_name(object_list)
Return the context variable name that will be used to contain the list of data that this view is manipulating. If object_list is a queryset of Django objects and context_object_name is not set, the context name will be the model_name of the model that the queryset is composed from... | django.ref.class-based-views.mixins-multiple-object#django.views.generic.list.MultipleObjectMixin.get_context_object_name |
get_ordering()
Returns a string (or iterable of strings) that defines the ordering that will be applied to the queryset. Returns ordering by default. | django.ref.class-based-views.mixins-multiple-object#django.views.generic.list.MultipleObjectMixin.get_ordering |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.