{"title":"Actions d’administration","version":"4.0","locale":"fr","docname":"ref/contrib/admin/actions","url":"/fr/4.0/ref/contrib/admin/actions/","canonical":"https://djangodocs.dev/fr/4.0/ref/contrib/admin/actions/","summary":"Le mode de travail de base de l’administration de Django est en résumé : « sélectionner un objet, puis le changer ».","html":"

Actions d’administrationLien vers cette rubrique#

\n

Le mode de travail de base de l’administration de Django est en résumé : « sélectionner un objet, puis le changer ». Cela fonctionne bien pour la majorité des cas d’utilisation. Toutefois, si vous devez effectuer la même modification à plusieurs objets à la fois, ce mode de travail peut être assez fastidieux.

\n

Dans ces cas, l’administration de Django vous permet d’écrire et d’inscrire des « actions » – des fonctions appelées avec une liste d’objets sélectionnés depuis la page de liste pour modification.

\n

Si vous examinez n’importe quelle liste d’objets à modifier dans l’administration, vous verrez cette fonctionnalité en action ; Django est livré avec une action « supprimer les objets sélectionnés » disponible pour tous les modèles. Par exemple, voici le module utilisateur de l’application django.contrib.auth intégrée dans Django :

\n\"/fr/4.0/_images/admin-actions.png\"\n\n

Lisez la suite pour savoir comment ajouter vos propres actions à cette liste.

\n
\n

Écriture d’actionsLien vers cette rubrique#

\n

La meilleure façon d’expliquer les actions est de montrer un exemple. Allons-y !

\n

Un cas d’utilisation courant pour les actions d’administration est la mise à jour en vrac d’un modèle. Imaginez une application de nouvelles avec un modèle Article:

\n
Code
from django.db import models\n\nSTATUS_CHOICES = [\n    ('d', 'Draft'),\n    ('p', 'Published'),\n    ('w', 'Withdrawn'),\n]\n\nclass Article(models.Model):\n    title = models.CharField(max_length=100)\n    body = models.TextField()\n    status = models.CharField(max_length=1, choices=STATUS_CHOICES)\n\n    def __str__(self):\n        return self.title\n
\n

Une tâche courante que nous pourrions réaliser avec un tel modèle est de mettre à jour l’état d’un article de « brouillon » à « publié ». Nous pourrions facilement le faire dans l’administration un article à la fois, mais si nous voulions publier en vrac une série d’articles, ce serait fastidieux. Écrivons donc une action qui nous permet de modifier l’état d’un article à « publié ».

\n
\n

Écriture des fonctions d’actionLien vers cette rubrique#

\n

Tout d’abord, nous devons écrire une fonction qui est appelée quand l’action est déclenchée depuis l’administration. Les fonctions d’action sont des fonctions ordinaires qui acceptent trois paramètres :

\n\n

Notre fonction de publication d’articles n’aura pas besoin de la classe ModelAdmin ni de l’objet requête, mais nous allons utiliser le jeu de requête :

\n
Code
def make_published(modeladmin, request, queryset):\n    queryset.update(status='p')\n
\n\n

C’est en fait tout ce qu’il y a besoin d’écrire pour une action ! Toutefois, nous allons effectuer une étape supplémentaire facultative mais utile et donner un « joli » titre à l’action dans l’interface d’administration. Par défaut, cette action apparaît dans la liste d’actions comme « Make published » – le nom de la fonction avec les soulignements remplacés par des espaces. C’est bien, mais nous pouvons fournir un nom meilleur et plus convivial en utilisant le décorateur action() sur la fonction make_published:

\n
Code
from django.contrib import admin\n\n...\n\n@admin.action(description='Mark selected stories as published')\ndef make_published(modeladmin, request, queryset):\n    queryset.update(status='p')\n
\n\n\n
\n
\n

Ajout d’actions à la classe ModelAdminLien vers cette rubrique#

\n

Ensuite, il faudra informer la ModelAdmin de l’action. Cela fonctionne comme n’importe quelle autre option de configuration. Ainsi, le fichier admin.py complet avec l’action et son inscription ressemblerait à :

\n
Code
from django.contrib import admin\nfrom myapp.models import Article\n\n@admin.action(description='Mark selected stories as published')\ndef make_published(modeladmin, request, queryset):\n    queryset.update(status='p')\n\nclass ArticleAdmin(admin.ModelAdmin):\n    list_display = ['title', 'status']\n    ordering = ['title']\n    actions = [make_published]\n\nadmin.site.register(Article, ArticleAdmin)\n
\n

Avec ce code, la liste d’objets à modifier dans l’interface d’administration ressemble à ceci :

\n\"/fr/4.0/_images/adding-actions-to-the-modeladmin.png\"\n

C’est vraiment tout ce qu’il y a à faire ! Si vous brûlez d’écrire vos propres actions, vous en savez maintenant assez pour débuter. Le reste de ce document couvre des techniques plus avancées.

\n
\n
\n

Gestion des erreurs dans les actionsLien vers cette rubrique#

\n

S’il y a des conditions d’erreur prévisibles qui peuvent survenir lors de l’exécution de votre action, vous devriez faire amende honorable en informant l’utilisateur du problème. Cela signifie gérer les exceptions et utiliser django.contrib.admin.ModelAdmin.message_user() pour afficher une description conviviale du problème dans la réponse.

\n
\n
\n
\n

Techniques d’action avancéesLien vers cette rubrique#

\n

Il y a quelques options et possibilités supplémentaires que vous pouvez exploiter pour des options plus avancées.

\n
\n

Actions en tant que méthodes de ModelAdminLien vers cette rubrique#

\n

L’exemple ci-dessus montre l’action make_published définie comme une fonction. C’est tout à fait correct, mais ce n’est pas parfait d’un point de vue conception de code : comme l’action est étroitement couplée à l’objet Article, il paraît logique de fusionner l’action dans l’objet ArticleAdmin même.

\n

Vous pouvez le faire comme ceci

\n
Code
class ArticleAdmin(admin.ModelAdmin):\n    ...\n\n    actions = ['make_published']\n\n    @admin.action(description='Mark selected stories as published')\n    def make_published(self, request, queryset):\n        queryset.update(status='p')\n
\n

Remarquez d’abord que nous avons transformé make_published en une méthode et renommé le paramètre modeladmin à self, puis que nous avons placé la chaîne make_published dans actions à la place d’une référence de fonction directe. Cela indique à ModelAdmin de rechercher l’action en tant que méthode.

\n

Définir les actions en tant que méthodes donne à l’action un accès plus idiomatique à la classe ModelAdmin elle-même, permettant à l’action d’appeler l’une des méthodes définies par l’application d’administration.

\n

Par exemple, nous pouvons utiliser self pour afficher un message à l’utilisateur l’informant que l’action a réussi :

\n
Code
from django.contrib import messages\nfrom django.utils.translation import ngettext\n\nclass ArticleAdmin(admin.ModelAdmin):\n    ...\n\n    def make_published(self, request, queryset):\n        updated = queryset.update(status='p')\n        self.message_user(request, ngettext(\n            '%d story was successfully marked as published.',\n            '%d stories were successfully marked as published.',\n            updated,\n        ) % updated, messages.SUCCESS)\n
\n

Cela fait ressembler l’action à ce que l’administration elle-même réalise après avoir réussi à effectuer une action :

\n\"/fr/4.0/_images/actions-as-modeladmin-methods.png\"\n
\n
\n

Actions qui fournissent des pages intermédiairesLien vers cette rubrique#

\n

Par défaut, après qu’une action a été effectuée, l’utilisateur est redirigé vers la page d’origine de la liste d’édition. Cependant, certaines actions, en particulier les plus complexes, pourraient devoir renvoyer à des pages intermédiaires. Par exemple, l’action de suppression intégrée demande confirmation avant de supprimer les objets sélectionnés.

\n

Pour fournir une page intermédiaire, renvoyez une réponse HttpResponse (ou une sous-classe) depuis votre action. Par exemple, vous pourriez écrire une fonction d’exportation qui utilise les fonctions de sérialisation de Django pour exporter certains objets sélectionnés en JSON :

\n
Code
from django.core import serializers\nfrom django.http import HttpResponse\n\ndef export_as_json(modeladmin, request, queryset):\n    response = HttpResponse(content_type="application/json")\n    serializers.serialize("json", queryset, stream=response)\n    return response\n
\n

En général, l’exemple ci-dessus n’est pas considéré comme une bonne idée. La plupart du temps, la pratique conseillée est de renvoyer une réponse HttpResponseRedirect et de rediriger l’utilisateur vers une vue que vous avez écrite, en passant la liste des objets sélectionnés dans la chaîne de requête GET. Cela vous permet de fournir une logique d’interaction complexe sur les pages intermédiaires. Par exemple, si vous vouliez fournir une fonction d’exportation plus complète, vous voudriez que l’utilisateur puisse choisir un format et peut-être une liste de champs à inclure dans l’exportation. La meilleure chose à faire serait d’écrire une petite action qui redirige vers la vue d’exportation personnalisée :

\n
Code
from django.contrib.contenttypes.models import ContentType\nfrom django.http import HttpResponseRedirect\n\ndef export_selected_objects(modeladmin, request, queryset):\n    selected = queryset.values_list('pk', flat=True)\n    ct = ContentType.objects.get_for_model(queryset.model)\n    return HttpResponseRedirect('/export/?ct=%s&ids=%s' % (\n        ct.pk,\n        ','.join(str(pk) for pk in selected),\n    ))\n
\n

Comme vous pouvez le voir, l’action est plutôt succinte ; toute la logique complexe est déléguée à la vue d’exportation. Celle-ci doit se charger de traiter des objets de tout type, d’où la présence du modèle ContentType.

\n

La rédaction de cette vue est laissée en exercice au lecteur.

\n
\n
\n

Actions disponibles pour l’ensemble d’un siteLien vers cette rubrique#

\n
\n
\nAdminSite.add_action(action, name=None)Lien vers cette définition#
\n

Certaines actions sont plus efficaces lorsqu’elles sont mises à la disposition de tous les objets dans le site d’administration – l’action d’exportation définie ci-dessus serait un bon candidat. Vous pouvez rendre une action globalement disponible en utilisant AdminSite.add_action(). Par exemple :

\n
Code
from django.contrib import admin\n\nadmin.site.add_action(export_selected_objects)\n
\n

Cela rend l’action export_selected_objects globalement disponible en tant qu’action nommée « export_selected_objects ». Vous pouvez explicitement donner un nom à l’action – utile si vous souhaitez plus tard programmatiquement supprimer l’action – en passant un second argument à AdminSite.add_action()

\n
Code
admin.site.add_action(export_selected_objects, 'export_selected')\n
\n
\n\n
\n
\n

Désactivation des actionsLien vers cette rubrique#

\n

Parfois, vous devez désactiver certaines actions – en particulier celles enregistrées globalement – pour des objets particuliers. Il y a plusieurs façons dont vous pouvez désactiver les actions :

\n
\n

Désactivation d’une action à l’échelle du siteLien vers cette rubrique#

\n
\n
\nAdminSite.disable_action(name)Lien vers cette définition#
\n

Si vous avez besoin de désactiver une action à l’échelle du site vous pouvez appeler AdminSite.disable_action().

\n

Par exemple, vous pouvez utiliser cette méthode pour supprimer l’action intégrée « supprimer les objets sélectionnés » :

\n
Code
admin.site.disable_action('delete_selected')\n
\n

Une fois que vous avez fait ce qui précède, cette action ne sera plus disponible à l’ensemble du site.

\n

Si toutefois vous avez besoin de réactiver une action globalement désactivée pour un modèle en particulier, il suffit de l’indiquer explicitement dans la liste ModelAdmin.actions:

\n
Code
# Globally disable delete selected\nadmin.site.disable_action('delete_selected')\n\n# This ModelAdmin will not have delete_selected available\nclass SomeModelAdmin(admin.ModelAdmin):\n    actions = ['some_other_action']\n    ...\n\n# This one will\nclass AnotherModelAdmin(admin.ModelAdmin):\n    actions = ['delete_selected', 'a_third_action']\n    ...\n
\n
\n\n
\n
\n

Désactivation de toutes les actions pour une classe ModelAdmin particulièreLien vers cette rubrique#

\n

Si vous ne voulez aucune action en vrac disponible pour une classe ModelAdmin donnée, définissez ModelAdmin.actions à None:

\n
Code
class MyModelAdmin(admin.ModelAdmin):\n    actions = None\n
\n

Cela indique à la classe ModelAdmin de n’afficher ni d’autoriser aucune des actions, y compris les actions globales au site.

\n
\n
\n

Activation ou désactivation conditionnelle des actionsLien vers cette rubrique#

\n
\n
\nModelAdmin.get_actions(request)Lien vers cette définition#
\n

Enfin, vous pouvez activer ou désactiver conditionnellement les actions selon la requête (et donc par utilisateur) en redéfinissant ModelAdmin.get_actions().

\n

Cela renvoie un dictionnaire d’actions autorisées. Les clés sont des noms d’action, et les valeurs sont des tuples (fonction, nom, description courte).

\n

Par exemple, si vous souhaitez que seuls les utilisateurs dont le nom commence par « J » puissent supprimer des objets en masse

\n
Code
class MyModelAdmin(admin.ModelAdmin):\n    ...\n\n    def get_actions(self, request):\n        actions = super().get_actions(request)\n        if request.user.username[0].upper() != 'J':\n            if 'delete_selected' in actions:\n                del actions['delete_selected']\n        return actions\n
\n
\n\n
\n
\n
\n

Définition de permissions pour les actionsLien vers cette rubrique#

\n

Les actions peuvent restreindre leur accès aux utilisateurs ayant des permissions particulières en enveloppant leur fonction d’action dans le décorateur action() et en lui passant l’argument permissions:

\n
Code
@admin.action(permissions=['change'])\ndef make_published(modeladmin, request, queryset):\n    queryset.update(status='p')\n
\n

L’action make_published() ne sera disponible que pour les utilisateurs qui passent le contrôle ModelAdmin.has_change_permission().

\n

Si permissions possède plus d’une permission, l’action sera disponible si l’utilisateur passe au moins l’un des contrôles.

\n

Les valeurs disponibles pour permissions et leur méthodes de contrôle correspondantes sont :

\n\n

Vous pouvez indiquer d’autres valeurs pour autant que vous implémentiez une méthode correspondante has_<valeur>_permission(self, request) pour la classe ModelAdmin concernée.

\n

Par exemple :

\n
Code
from django.contrib import admin\nfrom django.contrib.auth import get_permission_codename\n\nclass ArticleAdmin(admin.ModelAdmin):\n    actions = ['make_published']\n\n    @admin.action(permissions=['publish'])\n    def make_published(self, request, queryset):\n        queryset.update(status='p')\n\n    def has_publish_permission(self, request):\n        """Does the user have the publish permission?"""\n        opts = self.opts\n        codename = get_permission_codename('publish', opts)\n        return request.user.has_perm('%s.%s' % (opts.app_label, codename))\n
\n\n
\n
\n
\n

Le décorateur actionLien vers cette rubrique#

\n
\n
\naction(*, permissions=None, description=None)Lien vers cette définition#
\n
\n

Ce décorateur permet de définir des attributs spécifiques sur les fonctions d’action personnalisées pouvant être utilisée dans actions:

\n
Code
@admin.action(\n    permissions=['publish'],\n    description='Mark selected stories as published',\n)\ndef make_published(self, request, queryset):\n    queryset.update(status='p')\n
\n

Ceci équivaut à définir certains attributs directement sur la fonction (avec les noms originaux, plus longs)

\n
Code
def make_published(self, request, queryset):\n    queryset.update(status='p')\nmake_published.allowed_permissions = ['publish']\nmake_published.short_description = 'Mark selected stories as published'\n
\n

L’utilisation de ce décorateur n’est pas obligatoire pour créer une fonction d’action, mais il peut être utile de l’utiliser sans argument dans votre code source comme marqueur de mise en évidence du but de la fonction

\n
Code
@admin.action\ndef make_inactive(self, request, queryset):\n    queryset.update(is_active=False)\n
\n

Dans cas, aucun attribut ne sera ajouté à la fonction.

\n
\n\n
","rootId":"admin-actions","toc":[{"title":"Écriture d’actions","anchor":"writing-actions","children":[{"title":"Écriture des fonctions d’action","anchor":"writing-action-functions","children":[]},{"title":"Ajout d’actions à la classe ModelAdmin","anchor":"adding-actions-to-the-modeladmin","children":[]},{"title":"Gestion des erreurs dans les actions","anchor":"handling-errors-in-actions","children":[]}]},{"title":"Techniques d’action avancées","anchor":"advanced-action-techniques","children":[{"title":"Actions en tant que méthodes de ModelAdmin","anchor":"actions-as-modeladmin-methods","children":[]},{"title":"Actions qui fournissent des pages intermédiaires","anchor":"actions-that-provide-intermediate-pages","children":[]},{"title":"Actions disponibles pour l’ensemble d’un site","anchor":"making-actions-available-site-wide","children":[]},{"title":"Désactivation des actions","anchor":"disabling-actions","children":[{"title":"Désactivation d’une action à l’échelle du site","anchor":"disabling-a-site-wide-action","children":[]},{"title":"Désactivation de toutes les actions pour une classe ModelAdmin particulière","anchor":"disabling-all-actions-for-a-particular-modeladmin","children":[]},{"title":"Activation ou désactivation conditionnelle des actions","anchor":"conditionally-enabling-or-disabling-actions","children":[]}]},{"title":"Définition de permissions pour les actions","anchor":"setting-permissions-for-actions","children":[]}]},{"title":"Le décorateur action","anchor":"the-action-decorator","children":[]}],"breadcrumbs":[{"docname":"ref/index","title":"Référence de l’API","url":"/fr/4.0/ref/"},{"docname":"ref/contrib/index","title":"Paquets contrib","url":"/fr/4.0/ref/contrib/"},{"docname":"ref/contrib/admin/index","title":"Le site d’administration de Django","url":"/fr/4.0/ref/contrib/admin/"}],"prev":{"docname":"ref/contrib/admin/index","title":"Le site d’administration de Django","url":"/fr/4.0/ref/contrib/admin/"},"next":{"docname":"ref/contrib/admin/admindocs","title":"Le générateur de documentation de l’administration de Django","url":"/fr/4.0/ref/contrib/admin/admindocs/"},"formats":{"html":"/fr/4.0/ref/contrib/admin/actions/","markdown":"/fr/4.0/ref/contrib/admin/actions.md","json":"/fr/4.0/ref/contrib/admin/actions.json"},"source":"https://github.com/django/django/blob/stable/4.0.x/docs/ref/contrib/admin/actions.txt","official":"https://docs.djangoproject.com/fr/4.0/ref/contrib/admin/actions/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","zh-hans","fr","ja","id","it","pt-br","ko","es","el","pl"]}