djangodocs.org

674 sections in Django 4.2 Search all versions →

in operator

Reference Built-in template tags and filters Built-in tag referenceifBoolean operators

Contained within. This operator is supported by many Python containers to test whether the given value is in the container. The following are some examples of how x in y will be interpreted:

Queries & the ORM

Topic guide Asynchronous support Async views

With some exceptions, Django can run ORM queries asynchronously as well: Detailed notes can be found in Asynchronous queries, but in short: All QuerySet methods that cause an SQL query to occur have an a-prefixed asynchronous variant.

Adding extra context

Topic guide Built-in class-based generic views Generic views of objects

Often you need to present some extra information beyond that provided by the generic view. For example, think of showing a list of all the books on each publisher detail page.

Topic guide Built-in class-based generic views Generic views of objects

… specify the objects that the view will operate upon – you can also specify the list of objects using the queryset argument: Specifying model = Publisher is shorthand for saying queryset = Publisher.objects.all(). However, by using queryset to define a …

Dynamic filtering

Topic guide Built-in class-based generic views Generic views of objects

Handily, the ListView has a get_queryset() method we can override. By default, it returns the value of the queryset attribute, but we can use it to add more logic.

Performing extra work

Topic guide Built-in class-based generic views Generic views of objects

… is the default > name that DetailView uses to find the value of the primary key used to > filter the queryset. If you want to call the group something else, you can set > pk_url_kwarg > on the view.

Model forms

Topic guide Form handling with class-based views

If a queryset is given, the model for that queryset will be used. Model form views provide a form_valid() implementation that saves the model automatically. You can override this if you have any special requirements; see below for examples.

Topic guide Class-based views Subclassing generic views

Suppose somebody wants to access our book library over HTTP using the views as an API. The API client would connect every now and then and download book data for the books published since last visit.

Topic guide Using mixins with class-based views Building up Django’s generic class-based views

… as declared in the URLConf, and looks the object up either from the model attribute on the view, or the queryset attribute if that’s provided). SingleObjectMixin also overrides get_context_data(), which is used across all Django’s built in class-based views to …

Topic guide Aggregation Joins and aggregates

… (note how we use 'book' to specify the Publisher -> Book reverse foreign key hop): (Every Publisher in the resulting QuerySet will have an extra attribute called book__count.) We can also ask for the oldest book of any of those …

Topic guide Managers Custom managers

… Manager methods.) For example, this custom Manager adds a method with_counts(): With this example, you’d use OpinionPoll.objects.with_counts() to get a QuerySet of OpinionPoll objects with the extra num_responses attribute attached. A custom Manager method can return anything you want. It …

Default managers

Topic guide Managers Custom managers

As a result, it’s a good idea to be careful in your choice of default manager in order to avoid a situation where overriding get_queryset() results in an inability to retrieve objects you’d like to work with.

Topic guide Managers Custom managersBase managers

For example, if the Question model from the tutorial had a deleted field and a base manager that filters out instances with deleted=True, a queryset like Choice.objects.filter(question__name__startswith='What') would include choices related to deleted questions.

Topic guide Models

NOTE: The Models Reference Covers all the model related APIs including model fields, related > objects, and QuerySet.

Topic guide Multiple databases Manually selecting a database

For example, say you have a custom manager method that touches the database – User.objects.create_user(). Because create_user() is a manager method, not a QuerySet method, you can’t do User.objects.using('new_users').create_user().