Métodos mixtos de objetos múltiples

MultipleObjectMixin

class django.views.generic.list.MultipleObjectMixin

Un mixin que se puede utilizar para mostrar una lista de objetos.

Si se especifica paginate_by, Django paginará los resultados devueltos por este. Puedes especificar el número de página en la URL de una de dos maneras:

  • Utiliza el parámetro page en la URLconf. Por ejemplo, esto es lo que podría ser su URLconf:

    path("objects/page<int:page>/", PaginatedView.as_view()),

  • Pasa el número de página a través del parámetro de consulta page. Por ejemplo, una URL tendría este aspecto:

    /objects/?page=3

Estos valores y listas son 1-based, no 0-based, por lo que la primera página se representaría como página 1.

Para más información sobre la paginación, lee la documentación de paginación.

Como caso especial, también estás permitido utilizar last como valor para page:

/objects/?page=last

Esto te permite acceder a la última página de resultados sin tener que determinar primero cuántas páginas hay.

Ten en cuenta que page debe ser o un número de página válido o el valor last; cualquier otro valor para page dará como resultado un error 404.

Extiende

Métodos y Atributos

allow_empty

Un booleano que especifica si se debe mostrar la página si no hay objetos disponibles. Si este es False y no hay objetos disponibles, la vista levantará un 404 en lugar de mostrar una página vacía. Por defecto, esto es True.

model

El modelo para el cual esta vista mostrará datos. Especificar model = Foo es efectivamente lo mismo que especificar queryset = Foo.objects.all(), donde objects representa el administrador predeterminado de Foo.

queryset

Un conjunto de consultas que representa los objetos. Si se proporciona, el valor de queryset prevalece sobre el proporcionado para model.

Advertencia

queryset es un atributo de clase con un valor mutable, por lo que debe tener cuidado al usarlo directamente. Antes de usarlo, llame a su método all() o recupere el conjunto de consultas con get_queryset(), que se encarga del clonado detrás de escena.

ordering

Una cadena o lista de cadenas que especifican la ordenación a aplicar al queryset. Los valores válidos son los mismos que para order_by().

paginate_by

Un entero que especifica el número de objetos que se deben mostrar por página. Si se proporciona, la vista paginará objetos con paginate_by objetos por página. La vista espera que esté disponible un parámetro de consulta page (a través de request.GET) o una variable page especificada en el URLconf.

paginate_orphans

Un entero que especifica el número de «sobrantes» de objetos que la última página puede contener. Esto extiende el límite de paginate_by para la última página hasta paginate_orphans, con el fin de mantener la última página desde tener un pequeño número de objetos.

page_kwarg

Una cadena que especifica el nombre a usar para el parámetro de página. La vista espera que este parámetro esté disponible como un parámetro de consulta (a través de request.GET) o como una variable kwarg especificada en el URLconf. Por defecto, es page.

paginator_class

La clase del paginador a usar para la paginación. Por defecto, se utiliza django.core.paginator.Paginator. Si la clase personalizada de paginador no tiene la misma interfaz de constructor que django.core.paginator.Paginator, también debe proporcionar una implementación para get_paginator().

context_object_name

Designa el nombre de la variable a usar en el contexto.

get_queryset()

Obtén la lista de elementos para esta vista. Esta debe ser una iterable y puede ser un conjunto de consultas (en cuyo caso se habilitarán comportamientos específicos del conjunto de consultas).

get_ordering()

Devuelve una cadena (o iterable de cadenas) que define el ordenamiento que se aplicará al queryset.

Devuelve ordering por defecto.

paginate_queryset(queryset, page_size)

Devuelve un 4-tuple conteniendo (paginator, page, object_list, is_paginated).

Construido mediante la paginación de queryset en páginas de tamaño page_size. Si el pedido contiene un argumento page, ya sea como un argumento de URL capturado o como un argumento GET, object_list corresponderá a los objetos de esa página.

get_paginate_by(queryset)

Devuelve el número de elementos para paginar por, o None para no paginar. Por defecto, devuelve el valor de paginate_by.

get_paginator(queryset, per_page, orphans=0, allow_empty_first_page=True)

Devuelve una instancia del paginador para utilizar en esta vista. Por defecto, instancia una instancia de paginator_class.

get_paginate_orphans()

Un entero que especifica el número de «objetos de rebasamiento» que la última página puede contener. Por defecto devuelve el valor de paginate_orphans.

get_allow_empty()

Devuelve un booleano que especifica si se debe mostrar la página si no hay objetos disponibles. Si este método devuelve False y no hay objetos disponibles, la vista levantará una 404 en lugar de mostrar una página vacía. Por defecto, esto es True.

get_context_object_name(object_list)

Devuelve el nombre de variable del contexto que se utilizará para contener la lista de datos que esta vista está manipulando. Si object_list es un conjunto de consultas de objetos Django y context_object_name no está configurado, el nombre del contexto será el model_name del modelo que el conjunto de consultas está compuesto a partir de, con la postfix '_list' agregada. Por ejemplo, el modelo Article tendría un objeto de contexto llamado article_list.

get_context_data(**kwargs)

Regresa la lista de objetos para mostrar la lista de objetos.

Contexto

  • object_list: La lista de objetos que esta vista está mostrando. Si se especifica context_object_name, también se establecerá en el contexto, con el mismo valor que object_list.

  • is_paginated: Un booleano que representa si los resultados están paginados. Específicamente, esto se establece en False si no se ha especificado un tamaño de página, o si los objetos disponibles no abarcan varias páginas.

  • paginator: Una instancia de django.core.paginator.Paginator. Si la página no está paginada, esta variable del contexto será None.

  • page_obj: Una instancia de django.core.paginator.Page. Si la página no está paginada, esta variable del contexto será None.

MultipleObjectTemplateResponseMixin

class django.views.generic.list.MultipleObjectTemplateResponseMixin

Una clase mixin que realiza la renderización de respuesta basada en plantillas para vistas que operan sobre una lista de instancias de objetos. Requiere que la vista con la que se mezcla proporcione self.object_list, la lista de instancias de objeto que la vista está operando. self.object_list puede ser, pero no es necesario que sea, un QuerySet.

Extiende

Métodos y Atributos

template_name_suffix

El sufijo a agregar al nombre de plantilla candidato generado automáticamente. El sufijo por defecto es _list.

get_template_names()

Devuelve una lista de nombres de plantilla candidatos. Devuelve la siguiente lista:

  • Los textos traducidos son:

  • <app_label>/<model_name><template_name_suffix>.html

« previous | up | next »