Classes mixins pour objet unique

SingleObjectMixin

class django.views.generic.detail.SingleObjectMixin

Fournit un mécanisme pour rechercher un objet associé à la requête HTTP en cours.

Méthodes et attributs

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.

queryset

Un objet QuerySet représentant les objets. Lorsqu’elle est renseignée, la valeur de queryset écrase la valeur fournie pour model.

slug_field

Le nom du champ de modèle qui contient le slug. Par défaut, slug_field est 'slug'.

slug_url_kwarg

Le nom du paramètre nommé dans l’URL contenant le slug. Par défaut, slug_url_kwarg est 'slug'.

pk_url_kwarg

Le nom du paramètre nommé dans l’URL contenant la clé primaire. Par défaut, pk_url_kwarg est 'pk'.

context_object_name

Désigne le nom de la variable à utiliser dans le contexte.

get_object(queryset=None)

Renvoie l’objet unique que cette vue va afficher. Si queryset est indiqué, ce jeu de requête est utilisé comme source des objets ; sinon, get_queryset() est appelée. get_object() recherche un paramètre pk_url_kwarg dans les paramètres de la vue ; si ce paramètre est trouvé, cette méthode effectue une sélection basée sur la clé primaire avec cette valeur. Dans le cas contraire, elle consulte le paramètre slug_url_kwarg et effectue une sélection basée sur le slug avec la valeur slug_field.

get_queryset()

Renvoie le jeu de requête qui sera utilisé pour récupérer l’objet que cette vue va afficher. Par défaut, get_queryset() renvoie la valeur de l’attribut queryset s’il est défini, sinon elle construit un objet QuerySet en appelant la méthode all() sur le gestionnaire par défaut de l’attribut model.

get_context_object_name(obj)

Renvoie le nom de la variable de contexte utilisée pour contenir les données que cette vue manipule. Si context_object_name n’est pas défini, le nom du contexte correspondra au nom de modèle des objets contenus dans le jeu de requête. Par exemple, pour le modèle Article, la variable de contexte sera nommée 'article'.

get_context_data(**kwargs)

Renvoie les données du contexte pour afficher la liste des objets.

The base implementation of this method requires that the 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.

get_slug_field()

Renvoie le nom d’un champ de type slug à utiliser lors de la sélection par slug. Par défaut, cette méthode renvoie simplement la valeur de slug_field.

Contexte

  • object: l’objet que cette vue va afficher. Si context_object_name est renseigné, cette variable sera également définie dans le contexte, avec le même contenu que object.

SingleObjectTemplateResponseMixin

class django.views.generic.detail.SingleObjectTemplateResponseMixin

Une classe mixin produisant une réponse basée sur un gabarit pour les vues opérant sur une seule instance d’objet. Exige que la vue dans laquelle elle est intégrée fournisse self.object, l’instance d’objet sur laquelle la vue opère. self.object est généralement une instance d’un modèle Django, mais ce n’est pas une règle absolue. Elle peut valoir None si la vue est en cours de construction d’une nouvelle instance.

Étend

Méthodes et attributs

template_name_field

Le champ de l’instance d’objet actuelle pouvant être utilisé pour déterminer le nom d’un gabarit potentiel. Si template_name_field lui-même ou la valeur de template_name_field pour l’instance d’objet actuelle vaut None, l’objet ne sera pas utilisé pour trouver un nom de gabarit potentiel.

template_name_suffix

Le suffixe à ajouter au nom de gabarit auto-généré. Le suffixe par défaut est _detail.

get_template_names()

Renvoie une liste de noms de gabarits potentiels. Cette liste contient :

  • la valeur de template_name de la vue (s’il est défini)

  • le contenu du champ template_name_field de l’instance d’objet sur laquelle la vue opère (si disponible)

  • <nom_app>/<nom_modèle><suffixe_gabarit>.html