Obtention d’aide¶

django-admin help¶

Lancez django-admin help pour afficher des informations d’utilisation et une liste des commandes fournies par chaque application.

Lancez django-admin help --commands pour afficher une liste des commandes disponibles.

Lancez django-admin help <command> pour afficher une description de la commande concernée et une liste de ses options disponibles.

Noms d’applications¶

Plusieurs commandes acceptent une liste de « noms d’applications ». Un nom d’application est le nom de base du paquet contenant les modèles. Par exemple, si votre réglage INSTALLED_APPS contient la chaîne 'mysite.blog', le nom d’application est blog.

Détermination de la version¶

django-admin version¶

Lancez django-admin version pour afficher la version actuelle de Django.

L’affichage correspond au schéma décrit dans la PEP 440:

1.4.dev17026
1.4a1
1.4

Affichage du contenu de débogage¶

Utilisez --verbosity, le cas échéant, pour indiquer la quantité d’informations indicatives et de débogage que django-admin affiche dans la console.

check¶

django-admin check [app_label [app_label ...]]¶

Utilise l’infrastructure de contrôle système pour inspecter le projet Django dans son intégralité à la recherche de problèmes courants.

Par défaut, toutes les applications sont contrôlées. Vous pouvez vérifier un sous-ensemble d’applications en fournissant une liste d’étiquettes d’application en paramètres :

django-admin check auth admin myapp

--tag TAGS, -t TAGS¶

L’infrastructure de contrôle système effectue de nombreux types de contrôles qui sont catégorisés par des étiquettes. Celles-ci permettent de limiter les contrôles effectués à ceux d’une catégorie particulière. Par exemple, pour n’effectuer que les contrôles de modèles et de compatibilité, exécutez :

django-admin check --tag models --tag compatibility

--database DATABASE¶

Indique la base de données pour laquelle effectuer les contrôles qui nécessitent un accès à une base de données

django-admin check --database default --database other

Par défaut, ces contrôles ne sont pas effectués.

--list-tags¶

Affiche la liste de toutes les étiquettes disponibles.

--deploy¶

Active certains contrôles supplémentaires qui ne sont valables que pour des réglages de déploiement.

Vous pouvez utiliser cette option dans votre environnement local de développement, mais comme vos réglages de développement local ne contiennent pas forcément beaucoup de réglages de production, il est généralement souhaitable de faire pointer la commande check vers un autre module de réglages, soit en définissant la variable d’environnement DJANGO_SETTINGS_MODULE, soit en passant l’option --settings:

django-admin check --deploy --settings=production_settings

Ou vous pouvez la lancer directement dans un système en production ou préproduction pour vérifier que les bons réglages sont définis (en omettant --settings). Il est même possible d’intégrer la commande dans votre suite de tests d’intégration.

--fail-level {CRITICAL,ERROR,WARNING,INFO,DEBUG}¶

Définit le niveau de message qui produira la sortie de la commande avec un code d’état différent de zéro. La valeur par défaut est ERROR.

compilemessages¶

django-admin compilemessages¶

Compile les fichiers .po créés par makemessages en fichiers .mo utilisables par l’outil intégré gettext. Voir Internationalisation et régionalisation.

--locale LOCALE, -l LOCALE¶

Indique la ou les langues à traiter. Sans information, toutes les langues sont traitées.

--exclude EXCLUDE, -x EXCLUDE¶

Indique les langues à exclure du traitement de la commande. Sans autre information, aucune langue n’est exclue.

--use-fuzzy, -f¶

Inclut les traductions approximatives (« fuzzy ») dans les fichiers compilés.

Exemple d’utilisation :

django-admin compilemessages --locale=pt_BR
django-admin compilemessages --locale=pt_BR --locale=fr -f
django-admin compilemessages -l pt_BR
django-admin compilemessages -l pt_BR -l fr --use-fuzzy
django-admin compilemessages --exclude=pt_BR
django-admin compilemessages --exclude=pt_BR --exclude=fr
django-admin compilemessages -x pt_BR
django-admin compilemessages -x pt_BR -x fr

--ignore PATTERN, -i PATTERN¶

Ignore répertoires correspondant au motif de type glob donné. L’option peut être indiquée plusieurs fois pour des motifs différents.

Exemple d’utilisation :

django-admin compilemessages --ignore=cache --ignore=outdated/*/locale

createcachetable¶

django-admin createcachetable¶

Crée les tables de cache à l’usage du moteur de cache en base de données en utilisant les informations du fichier des réglages. Voir L’infrastructure de cache dans Django pour plus d’informations.

--database DATABASE¶

Indique la base de données dans laquelle la table de cache sera créée. La valeur par défaut est default.

--dry-run¶

Affiche le code SQL qui sera exécuté sans réellement l’exécuter, de sorte que vous pouvez le personnaliser ou utiliser le système des migrations.

dbshell¶

django-admin dbshell¶

Lance le client en ligne de commande correspondant au moteur de base de données défini dans le réglage ENGINE, en respectant les paramètres de connexion définis dans les réglages USER, PASSWORD, etc.

• Pour PostgreSQL, cette commande lance le client en ligne de commande psql.
• Pour MySQL, cette commande lance le client en ligne de commande mysql.
• Pour SQLite, cette commande lance le client en ligne de commande sqlite3.
• Pour Oracle, cette commande lance le client en ligne de commande sqlplus.

Cette commande compte sur le fait que les programmes sont accessibles dans le chemin d’exécution afin qu’en appelant leur nom (psql, mysql, sqlite3, sqlplus), le bon programme est lancé. Il n’y a pas d’astuce pour indiquer manuellement le chemin du programme de base de données.

--database DATABASE¶

Indique la base de données pour laquelle le shell doit être ouvert. La valeur par défaut est 'default'.

-- ARGUMENTS¶

Tout paramètre suivant le séparateur -- sera transmis au client de ligne de commande sous-jacent. Par exemple, avec PostgreSQL, il est possible d’utiliser l’option -c de la commande psql pour exécuter une requête SQL brute directement :

$ django-admin dbshell -- -c 'select current_user'
 current_user
--------------
 postgres
(1 row)

...\> django-admin dbshell -- -c 'select current_user'
 current_user
--------------
 postgres
(1 row)

Avec MySQL/MariaDB, il est possible de faire de même avec l’option -e de la commande mysql:

$ django-admin dbshell -- -e "select user()"
+----------------------+
| user()               |
+----------------------+
| djangonaut@localhost |
+----------------------+

...\> django-admin dbshell -- -e "select user()"
+----------------------+
| user()               |
+----------------------+
| djangonaut@localhost |
+----------------------+

diffsettings¶

django-admin diffsettings¶

Affiche les différences entre le fichier de réglages actuel et les réglages par défaut de Django (ou un autre fichier de réglages indiqué par --default).

Les réglages qui ne figurent pas dans les réglages par défaut sont suivis par "###". Par exemple, les réglages par défaut ne définissent pas ROOT_URLCONF, donc ROOT_URLCONF est suivi par "###" dans l’affichage que produit diffsettings.

--all¶

Affiche tous les réglages, même s’ils contiennent la valeur par défaut de Django. Ces réglages sont alors préfixés par "###".

--default MODULE¶

Le module de réglages avec lequel comparer les réglages en cours. Laissez vide pour comparer avec les réglages par défaut de Django.

--output {hash,unified}¶

Définit le format de sortie. Les valeurs disponibles sont hash et unified. hash est le mode par défaut qui produit le résultat décrit ci-dessus. unified affiche le résultat de manière semblable à diff -u. Les réglages par défaut sont préfixés par un signe moins, suivis par le réglage modifié préfixé par un signe plus.

dumpdata¶

django-admin dumpdata [app_label[.ModelName] [app_label[.ModelName] ...]]¶

Affiche dans la sortie standard toutes les données de la base de données associée à ou aux applications nommées.

Si aucun nom d’application n’est indiqué, le contenu de toutes les applications installées est affiché.

La sortie de dumpdata peut être utilisée comme source d’entrée pour loaddata.

Notez que dumpdata utilise le gestionnaire par défaut des modèles lors de la sélection des enregistrements à afficher. Si vous avez configuré un gestionnaire personnalisé comme gestionnaire par défaut et qu’il exclut certains des enregistrements existants, vous n’obtiendrez alors pas l’ensemble des objets dans l’affichage.

--all, -a¶

Utilise le gestionnaire de base de Django, affichant ainsi des enregistrements qui ne seraient pas visibles ou qui seraient modifiés en raison d’un gestionnaire personnalisé.

--format FORMAT¶

Indique le format de sérialisation du résultat. Par défaut, il s’agit de JSON. Les formats pris en charge sont énumérés dans Formats de sérialisation.

--indent INDENT¶

Indique le nombre d’espaces d’indentation à utiliser pour le résultat. Par défaut, il n’y en a aucun, ce qui fait que toutes les données s’affichent sur une seule ligne.

--exclude EXCLUDE, -e EXCLUDE¶

Empêche certaines applications ou modèles (désignés sous la forme étiquette_app.NomModèle) d’être affichés. Si vous indiquez un nom de modèle, seul ce modèle sera exclu, et non pas toute l’application. Il est aussi possible de mélanger des noms d’applications et des noms de modèles.

Pour exclure plusieurs applications, indiquez plusieurs fois --exclude:

django-admin dumpdata --exclude=auth --exclude=contenttypes

--database DATABASE¶

Indique la base de données à partir de laquelle les données seront produites. La valeur par défaut est 'default'.

--natural-foreign¶

Utilise la méthode de modèle natural_key() pour sérialiser d’éventuelles relations de clé étrangères ou plusieurs-à-plusieurs vers des objets du type que définit la méthode. Si vous exportez des objets Permission de contrib.auth ou des objets ContentType de contrib.contenttypes, il est recommandé d’utiliser cette option. Consultez la documentation sur les clés naturelles pour plus de détails sur cette option et la suivante.

--natural-primary¶

Omet la clé primaire dans les données sérialisées de cet objet dans la mesure où elle peut être calculée durant la désérialisation.

--pks PRIMARY_KEYS¶

N’affiche que les objets désignés par une liste de clés primaires séparées par des virgules. Cette option n’est valable que lorsque l’exportation concerne un seul modèle. Par défaut, touts les enregistrements du modèle sont exportés.

--output OUTPUT, -o OUTPUT¶

Indique le fichier dans lequel les données sérialisées doivent être écrites. Par défaut, les données s’affichent sur la sortie standard.

Lorsque cette option est définie et que --verbosity est plus grande que 0 (par défaut), une barre de progression s’affiche dans le terminal.

django-admin dumpdata -o mydata.json.gz

flush¶

django-admin flush¶

Supprime toutes les données de la base de données et réexécute tout gestionnaire de post-synchronisation. La table contenant les informations d’application des migrations n’est pas effacée.

If you would rather start from an empty database and rerun all migrations, you should drop and recreate the database and then run migrate instead.

--noinput, --no-input¶

Évite toute demande interactive à l’utilisateur.

--database DATABASE¶

Indique la base de données qu’il s’agit de réinitialiser. La valeur par défaut est default.

inspectdb¶

django-admin inspectdb [table [table ...]]¶

Introspecte les tables de base de données de la base désignée dans le réglage NAME et affiche un module de modèle Django (un fichier models.py) vers la sortie standard.

Vous pouvez choisir quelles tables ou vues inspecter en passant leur nom en paramètre. Si aucun paramètre n’est indiqué, les modèles pour les vues ne sont créés que si l’option --include-views est indiquée. Des modèles pour les tables de partition sont créées avec PostgreSQL si l’option --include-partitions est indiquée.

Cette commande est utile dans le cas d’une base de données existante que vous aimeriez utilisez avec Django. Le script inspecte la base de données et crée un modèle pour chacune de ses tables.

Comme l’on peut s’y attendre, les modèles créés possèdent un attribut pour chaque champ de table. Notez que inspectdb gère quelques cas particuliers dans sa manière de nommer les champs :

• Si inspectdb ne peut pas faire correspondre un type de colonne à un type de champ de modèle, il utilise TextField et ajoute le commentaire 'This field type is a guess.' (ce type de champ est approximatif) à côté de la définition du champ dans le modèle généré. Les champs reconnus peuvent dépendre des applications figurant dans INSTALLED_APPS. Par exemple, django.contrib.postgres ajoute la reconnaissance de plusieurs types de champs spécifiques à PostgreSQL.
• Si le nom de colonne de base de données est un mot Python réservé (comme 'pass', 'class' ou 'for'), inspectdb ajoute '_field' au nom d’attribut. Par exemple, si une table possède une colonne``”for”, le modèle généré contiendra un champ  ``'for_field' dont l’attribut db_column sera 'for'. inspectdb ajoute le commentaire Python 'Field renamed because it was a Python reserved word.' (champ renommé car il s’agit d’un mot Python réservé) après le champ.

Cette fonctionnalité doit être comprise comme un raccourci, pas comme une génération de modèle définitive. Après l’exécution de la commande, il est nécessaire de réviser vous-même les modèles générés pour faire les adaptations nécessaires. En particulier, il est généralement utile de réarranger l’ordre des modèles afin que les modèles se référant à d’autres modèles apparaissent dans le bon ordre.

Django ne crée pas de valeur par défaut en base de données lorsqu’un paramètre default est défini pour un champ de modèle. Inversement, les valeurs par défaut en base de données ne sont pas traduites en valeurs par défaut de champ de modèle, ni détecté d’aucune autre façon par

Par défaut, inspectdb crée des modèles non pilotés. C’est-à-dire que la présence de managed = False dans la classe Meta des modèles indique à Django de ne pas piloter la création de la table correspondante, ni sa modification ou sa destruction. Si vous voulez autoriser Django à piloter le cycle de vie des tables, il est nécessaire de modifier l’option managed pour lui donner la valeur True (ou carrément l’enlever, car True est sa valeur par défaut).

loaddata¶

django-admin loaddata fixture [fixture ...]¶

Recherche et charge le contenu de l’instantané indiqué dans la base de données.

--database DATABASE¶

Indique la base de données dans laquelle les données seront chargées. La valeur par défaut est default.

--ignorenonexistent, -i¶

Ignore les champs et les modèles qui pourraient avoir été enlevés depuis que l’instantané a été initialement produit.

--app APP_LABEL¶

Désigne une seule application dans laquelle rechercher des instantanés au lieu de chercher dans toutes les applications.

--format FORMAT¶

Indique le format de sérialisation (e.g., json ou xml) pour les instantanés lus à partir de l’entrée standard stdin.

--exclude EXCLUDE, -e EXCLUDE¶

Exclut le chargement des instantanés des applications et modèles indiqués (sous la forme étiquette_app ou `` étiquette_app.NomModèle``). L’option peut être indiquée plusieurs fois pour exclure plus d’une application ou modèle.

django-admin loaddata mydata.json

django-admin loaddata mydata

django-admin loaddata foo/bar/mydata.json

from django.db.models.signals import post_save
from .models import MyModel

def my_handler(**kwargs):
    # disable the handler during fixture loading
    if kwargs['raw']:
        return
    ...

post_save.connect(my_handler, sender=MyModel)

from functools import wraps

def disable_for_loaddata(signal_handler):
    """
    Decorator that turns off signal handlers when loading fixture data.
    """
    @wraps(signal_handler)
    def wrapper(*args, **kwargs):
        if kwargs['raw']:
            return
        signal_handler(*args, **kwargs)
    return wrapper

@disable_for_loaddata
def my_handler(**kwargs):
    ...

django-admin loaddata mydata.json

django-admin loaddata --format=json -

django-admin dumpdata --format=json --database=test app_label.ModelName | django-admin loaddata --format=json --database=prod -

makemessages¶

django-admin makemessages¶

Parcourt l’entier de l’arborescence de code source à partir du répertoire actuel et extrait toutes les chaînes marquées pour la traduction. Elle crée (ou met à jour) un fichier de messages dans le répertoire conf/locale (pour l’arborescence Django) ou locale (pour les projets et applications). Après la mise à jour des fichiers de messages, il est encore nécessaire de les compiler par compilemessages pour qu’ils soient utilisables par l’outil intégré gettext. Voir la documentation d’internationalisation pour plus de détails.

Cette commande ne demande pas de réglages configurés. Cependant, lorsque les réglages ne sont pas configurés, la commande ne peut pas ignorer les répertoires MEDIA_ROOT et STATIC_ROOT, ni inclure LOCALE_PATHS.

--all, -a¶

Met à jour les fichiers de messages pour toutes les langues disponibles.

--extension EXTENSIONS, -e EXTENSIONS¶

Indique une liste d’extensions de fichiers à examiner (par défaut : html, txt, py ou js si --domain vaut js).

Exemple d’utilisation :

django-admin makemessages --locale=de --extension xhtml

Séparez plusieurs extensions par une virgule ou utilisez plusieurs occurrences de -e ou --extension:

django-admin makemessages --locale=de --extension=html,txt --extension xml

--locale LOCALE, -l LOCALE¶

Indique les langues à traiter.

--exclude EXCLUDE, -x EXCLUDE¶

Indique les langues à exclure du traitement de la commande. Sans autre information, aucune langue n’est exclue.

Exemple d’utilisation :

django-admin makemessages --locale=pt_BR
django-admin makemessages --locale=pt_BR --locale=fr
django-admin makemessages -l pt_BR
django-admin makemessages -l pt_BR -l fr
django-admin makemessages --exclude=pt_BR
django-admin makemessages --exclude=pt_BR --exclude=fr
django-admin makemessages -x pt_BR
django-admin makemessages -x pt_BR -x fr

--domain DOMAIN, -d DOMAIN¶

Indique le domaine des fichiers de messages. Les options acceptées sont :

• django pour tous les fichiers *.py, *.html et *.txt (par défaut)
• djangojs pour les fichiers *.js

--symlinks, -s¶

Suit les liens symboliques vers les répertoires lors de la recherche de nouvelles chaînes à traduire.

Exemple d’utilisation :

django-admin makemessages --locale=de --symlinks

--ignore PATTERN, -i PATTERN¶

Ignore les fichiers ou répertoires correspondant au motif de type glob donné. L’option peut être indiquée plusieurs fois pour des motifs différents.

Ces motifs sont utilisés par défaut : 'CVS', '.*', '*~', '*.pyc'.

Exemple d’utilisation :

django-admin makemessages --locale=en_US --ignore=apps/* --ignore=secret/*.html

--no-default-ignore¶

Désactive les valeurs par défaut de --ignore.

--no-wrap¶

Désactive la segmentation des longues lignes de messages sur plusieurs lignes dans les fichiers de langues.

--no-location¶

Supprime l’écriture des lignes de commentaire #: filename:line dans les fichiers de langues. Avec cette option, les traducteurs ayant de bonnes notions techniques auront plus de peine à saisir le contexte de chaque message.

--add-location [{full,file,never}]¶

Contrôle les lignes de commentaires #: nom_fichier:ligne dans les fichiers de langue. Si l’option est :

• full (par défaut) : les lignes contiennent à la fois les noms de fichiers et les numéros de lignes.
• file: le numéro de ligne est omis.
• never: les lignes sont supprimées (effet identique à --no-location).

Nécessite gettext 0.19 ou plus récent.

--keep-pot¶

Empêche la suppression des fichiers .pot temporaires générés avant de créer le ou les fichiers .po. Cela peut être utile pour déboguer d’éventuelles erreurs empêchant la création des fichiers de langues finaux.

makemigrations¶

django-admin makemigrations [app_label [app_label ...]]¶

Crée de nouvelles migrations sur la base des modifications détectées dans les modèles. Les migrations, leurs relations avec les applications et d’autre sujets encore sont abordés en détails dans la documentation sur les migrations.

En indiquant un ou plusieurs noms d’applications en paramètre limite la création de migrations aux applications désignées ainsi qu’à leurs dépendances (la table à l’autre bout d’une clé ForeignKey, par exemple).

Pour ajouter des migrations à une application qui n’a pas de répertoire migrations, lancez makemigrations avec l’étiquette de l’application en paramètre.

--noinput, --no-input¶

Supprime toute demande à l’utilisateur. SI une demande supprimée ne peut pas être résolue automatiquement, la commande se termine avec le code d’erreur 3.

--empty¶

Produit une migration vide pour les applications données, en vue d’une modification manuelle. Cette option est réservée aux utilisateurs avancés et ne devrait pas être utilisée sans être familier du format des migrations, des opérations de migration et des dépendances entre les migrations.

--dry-run¶

Montre les migrations qui seraient produites mais sans écrire réellement de fichier de migration sur le disque. L’emploi de cette option accompagnée de --verbosity 3 montre également les fichiers de migrations complets tels qu’ils seraient écrits.

--merge¶

Active la résolution des conflits de migration.

--name NAME, -n NAME¶

Permet de donner aux migrations un nom de votre choix au lieu de celui qui est généré automatiquement. Le nom doit être un identifiant Python valable.

--no-header¶

Génère des fichiers de migration sans l’en-tête d’horodatage et de version Django.

--check¶

Fait quitter makemigrations avec un statut différent de 0 lorsque des modifications de modèles sans migration correspondante sont détectés.

--scriptable¶

Diverts log output and input prompts to stderr, writing only paths of generated migration files to stdout.

migrate¶

django-admin migrate [app_label] [migration_name]¶

Actualise l’état de la base de données en accord avec l’ensemble des modèles et des migrations actuels. Les migrations, leurs relations avec les applications et d’autre sujets encore sont abordés en détails dans la documentation sur les migrations.

Le comportement de cette commande change en fonction des paramètres fournis :

• Pas de paramètre : toutes les applications appliquent toutes leurs migrations.
• <étiquette_app>: les migrations de l’application indiquée sont appliquées jusqu’à la migration la plus récente. Cela peut aussi provoquer l’application des migrations d’autres applications, en fonction des dépendances.
• <étiquette_app> <nom_migration>: fait passer le schéma de base de données à l’état où la migration indiquée est appliquée, mais sans que les migrations ultérieures de la même application ne soient appliquées ; ceci peut conduire à défaire certaines migrations si les migrations postérieures à la migration nommée ont déjà été appliquées. Vous pouvez utiliser un préfixe du nom de migration, par ex. 0001, pour autant qu’il soit unique pour le nom d’application indiqué. Utilisez le nom zero pour tout migrer à l’envers, c’est-à-dire défaire toutes les migrations d’une application.

--database DATABASE¶

Désigne la base de données à migrer. La valeur par défaut est 'default'.

--fake¶

Marque les migrations comme appliquées jusqu’à la migration cible (en suivant les règles ci-dessus), mais sans lancer réellement d’instructions SQL pour modifier le schéma de base de données.

Ceci est destiné aux utilisateurs avancés pour manipuler directement l’état actuel des migrations dans le cas où ils appliquent manuellement certains changements ; soyez conscient que l’emploi de --fake crée le risque de placer la table des états de migration dans un état où une intervention manuelle deviendra indispensable pour que les migrations puissent de nouveau fonctionner correctement.

--fake-initial¶

Permet à Django de sauter la migration initiale d’une application si toutes les tables de base de données avec les noms de tous les modèles créés par toutes les opérations CreateModel de cette migration existent déjà. Cette option est prévue pour le premier lancement des migrations sur une base de données qui existait déjà avant l’utilisation des migrations. Cependant, à part le nom des tables, cette option ne vérifie pas que le schéma de base de données corresponde exactement aux modèles, ce qui signifie qu’elle ne doit être utilisée que si vous savez pertinemment que le schéma actuel correspond bel et bien à ce qui est enregistré dans la migration initiale.

--plan¶

Montre les opérations de migration qui seront effectuées pour la commande migrate indiquée.

--run-syncdb¶

Permet de créer les tables des applications sans migrations. Bien que ce ne soit pas recommandé, le système des migrations est parfois trop lent avec de grands projets qui ont des centaines de modèles.

--noinput, --no-input¶

Supprime toute demande interactive à l’utilisateur. Un exemple de demande pourrait concerner la suppression des types de contenus obsolètes.

--check¶

Fait quitter migrate avec un statut différent de 0 lorsque des migrations non appliquées sont détectées.

--prune¶

Deletes nonexistent migrations from the django_migrations table. This is useful when migration files replaced by a squashed migration have been removed. See Fusion de migrations for more details.

optimizemigration¶

django-admin optimizemigration app_label migration_name¶

Optimizes the operations for the named migration and overrides the existing file. If the migration contains functions that must be manually copied, the command creates a new migration file suffixed with _optimized that is meant to replace the named migration.

--check¶

Makes optimizemigration exit with a non-zero status when a migration can be optimized.

runserver¶

django-admin runserver [addrport]¶

Démarre un serveur web de développement léger sur la machine locale. Par défaut, le serveur fonctionne sur le port 8000 à l’adresse IP 127.0.0.1. Vous pouvez lui transmettre explicitement une adresse IP et un numéro de port.

Si vous lancez ce script avec un utilisateur ayant des privilèges normaux (ce qui est recommandé), il se peut que vous n’ayez pas les permissions d’utiliser un petit numéro de port. Les petits numéros de port sont réservés au super-utilisateur (root).

Ce serveur utilise l’objet application WSGI désigné par le réglage WSGI_APPLICATION.

N’UTILISEZ PAS CE SERVEUR DANS UN ENVIRONNEMENT DE PRODUCTION. Il n’a pas fait l’objet d’audits de sécurité ni de tests de performance. (Et cela n’est pas prévu de changer. Notre métier est de nous occuper de cadriciel web, pas de serveur web, et l’amélioration de ce serveur pour pouvoir gérer un environnement de production dépasse les objectifs de Django).

Le serveur de développement recharge automatiquement le code Python lors de chaque requête si nécessaire. Vous ne devez pas redémarrer le serveur pour que les changements de code soient pris en compte. Cependant, certaines actions comme l’ajout de fichiers ne provoquent pas de redémarrage, il est donc nécessaire de redémarrer manuellement le serveur dans ces cas.

Si vous utilisez Linux ou MacOS et que vous installez à la fois pywatchman et le service Watchman, ce sont des signaux du noyau qui permettent de recharger automatiquement le serveur (au lieu de consulter chaque seconde les dates de modification des fichiers). Cela améliore donc les performances pour les gros projets, ainsi qu’un temps de réponse réduit après les modifications de code, une détection des changements plus robuste et une réduction de consommation d’énergie. Django prend en charge pywatchman 1.2.0 ou plus récent.

Au démarrage du serveur et lors de chaque modification de code Python durant le fonctionnement du serveur, l’infrastructure de contrôle système recherche d’éventuelles erreurs courantes dans tout le projet Django (voir la commande check). Si des erreurs sont détectées, celles-ci sont affichées dans la sortie standard. Vous pouvez utiliser l’option --skip-checks pour omettre l’exécution des contrôles système.

Vous pouvez lancer autant de serveurs en parallèle que nécessaire, pour autant que ce soit sur des ports séparés, en exécutant plusieurs fois django-admin runserver.

Note that the default IP address, 127.0.0.1, is not accessible from other machines on your network. To make your development server viewable to other machines on the network, use its own IP address (e.g. 192.168.2.1), 0 (shortcut for 0.0.0.0), 0.0.0.0, or :: (with IPv6 enabled).

Vous pouvez indiquer une adresse IPv6 entourée par des crochets (par ex. [200a::1]:8000). Cela active automatiquement la prise en charge de IPv6.

Il est aussi possible d’indiquer un nom d’hôte uniquement formé de caractères ASCII.

Si l’application complémentaire staticfiles est activée (c’est le cas par défaut dans les nouveaux projets), la commande runserver est surchargée par sa propre commande runserver.

La journalisation de chaque requête et réponse du serveur est envoyée au journaliseur django.server.

--noreload¶

Désactive le recours au relanceur automatique. Cela signifie que toute modification de code Python effectuée pendant que le serveur tourne ne sera pas prise en compte si le module Python concerné a déjà été chargé en mémoire.

--nothreading¶

Désactive l’utilisation des fils d’exécution avec le serveur de développement. Par défaut, le serveur utilise plusieurs fils d’exécution (multithread).

--ipv6, -6¶

Utilise IPv6 pour le serveur de développement. L’adresse IP par défaut passe alors de 127.0.0.1 à ::1.

django-admin runserver

django-admin runserver 1.2.3.4:8000

django-admin runserver 7000

django-admin runserver 1.2.3.4:7000

django-admin runserver -6

django-admin runserver -6 7000

django-admin runserver [2001:0db8:1234:5678::9]:7000

django-admin runserver localhost:8000

django-admin runserver -6 localhost:8000

sendtestemail¶

django-admin sendtestemail [email [email ...]]¶

Envoie un courriel de test (pour confirmer le bon fonctionnement de l’envoi de messages avec Django) aux destinataires indiqués. Par exemple :

django-admin sendtestemail foo@example.com bar@example.com

Il y a plusieurs options possibles, et vous pouvez combiner ces options sans problème :

--managers¶

Envoie le courriel aux adresses électroniques figurant dans MANAGERS avec mail_managers().

--admins¶

Envoie le courriel aux adresses électroniques figurant dans ADMINS avec mail_admins().

shell¶

django-admin shell¶

Lance l’interpréteur interactif Python.

--interface {ipython,bpython,python}, -i {ipython,bpython,python}¶

Indique le shell à utiliser. Par défaut, Django utilise IPython ou bpython s’ils sont installés. Si les deux sont installés, vous pouvez indiquer l’interpréteur souhaité comme ceci :

IPython :

django-admin shell -i ipython

bpython :

django-admin shell -i bpython

Si vous avez l’un de ces shells « enrichis » installé mais que vous aimeriez lancer l’interpréteur « brut » de Python, utilisez python comme nom d’interface, comme ceci :

django-admin shell -i python

--nostartup¶

Désactive la lecture du script de démarrage pour l’interpréteur Python « simple ». Par défaut, le script lu est celui qui est désigné par la variable d’environnement PYTHONSTARTUP ou le script ~/.pythonrc.py.

--command COMMAND, -c COMMAND¶

Permet de transmettre une commande sous forme de texte à exécuter par Django, comme ceci :

django-admin shell --command="import django; print(django.__version__)"

Vous pouvez aussi passer du code par l’entrée standard afin de l’exécuter. Par exemple :

$ django-admin shell <<EOF
> import django
> print(django.__version__)
> EOF

Avec Windows, REPL est affiché en raison des limites d’implémentation de select.select() sur cette plateforme.

showmigrations¶

django-admin showmigrations [app_label [app_label ...]]¶

Affiche toutes les migrations d’un projet. Vous pouvez choisir l’un des deux formats suivants :

--list, -l¶

Énumère toutes les applications connues par Django, les migrations disponibles pour chaque application et l’état d’application de chaque migration (marqué par un [X] à côté du nom de la migration). Avec une --verbosity de 2 ou plus, les dates/heures d’application sont aussi montrées.

Les applications sans migration sont également comprises dans la liste, mais le texte (no migrations) s’affiche sous leur nom.

Il s’agit du format d’affichage par défaut.

--plan, -p¶

Montre le plan de migration que Django va suivre pour appliquer les migrations. Comme pour --list, les migrations appliquées sont marquées par une [X]. Quand la verbosité est plus grande que 1, toutes les dépendances d’une migration sont également affichées.

Les paramètres app_label limitent les résultats affichés, mais il est tout de même possible que des dépendances des applications indiquées soient aussi incluses.

--database DATABASE¶

Indique la base de données à examiner. La valeur par défaut est default.

sqlflush¶

django-admin sqlflush¶

Affiche les commandes SQL qui seraient générées si la commande flush était exécutée.

--database DATABASE¶

Indique la base de données pour laquelle les instructions SQL doivent être affichées. La valeur par défaut est default.

sqlmigrate¶

django-admin sqlmigrate app_label migration_name¶

Affiche le code SQL correspondant à la migration nommée. Cela demande une connexion active à la base de données, que la commande utilise pour résoudre les noms de contraintes ; cela signifie que vous devez générer le code SQL par rapport à une copie de la base de données à laquelle vous souhaitez plus tard appliquer le résultat.

Remarquez que sqlmigrate ne colore pas le résultat produit.

--backwards¶

Génère le code SQL servant à défaire la migration. Par défaut, le code SQL créé est celui qui sert à appliquer la migration dans le sens progressif.

--database DATABASE¶

Indique la base de données pour laquelle les instructions SQL doivent être générées. La valeur par défaut est default.

sqlsequencereset¶

django-admin sqlsequencereset app_label [app_label ...]¶

Affiche les instructions SQL de réinitialisation des séquences relatives aux noms d’application donnés.

Les séquences sont des index utilisés par certains moteurs de base de données pour obtenir le prochain nombre disponible pour les champs incrémentés automatiquement.

Utilisez cette commande pour générer le code SQL pouvant servir à corriger les situations où une séquence est désynchronisée par rapport aux données de son champ incrémenté automatiquement.

--database DATABASE¶

Indique la base de données pour laquelle les instructions SQL doivent être affichées. La valeur par défaut est default.

squashmigrations¶

django-admin squashmigrations app_label [start_migration_name] migration_name¶

Fusionne les migrations de étiquette_app jusqu’à et y compris nom_migration en un nombre plus restreint de migrations, si possible. Les migrations fusionnées résultantes peuvent figurer sans problème au côté des migrations non fusionnées. Pour plus d’informations, veuillez lire Fusion de migrations.

Lorsque start_migration_name est indiqué, Django n’inclut que les migrations commençant par cette migration y comprise. Cela aide à relativiser les limites du fusionnement des opérations de migration RunPython et django.db.migrations.operations.RunSQL.

--no-optimize¶

Désactive l’optimiseur lors de la génération d’une migration fusionnée. Par défaut, Django essaie d’optimiser les opérations dans les migrations pour réduire la taille du fichier résultant. Utilisez cette option si ce processus échoue ou qu’il crée des migrations incorrectes. Dans ce cas, Il serait toutefois aussi souhaitable de remplir un rapport d’anomalie pour Django car cette optimisation est censée être sûre.

--noinput, --no-input¶

Évite toute demande interactive à l’utilisateur.

--squashed-name SQUASHED_NAME¶

Définit le nom de la migration fusionnée. Sans cela, le nom automatique se base sur les première et dernière migrations, avec _squashed_ entre deux.

--no-header¶

Génère un fichier de migration fusionné sans l’en-tête d’horodatage et de version Django.

startapp¶

django-admin startapp name [directory]¶

Crée une structure de répertoires d’application Django avec le nom d’application indiqué, dans le répertoire actuel ou dans la destination indiquée.

Par défaut, le nouveau répertoire contient un fichier models.py ainsi que d’autres fichiers modèles d’application. Si seul le nom d’application est indiqué, le répertoire de l’application sera créé dans le répertoire de travail actuel.

Si la destination facultative est indiquée, Django utilise ce répertoire existant plutôt que d’en créer un nouveau. Vous pouvez utiliser « . » pour signifier le répertoire de travail actuel.

Par exemple :

django-admin startapp myapp /Users/jezdez/Code/myapp

--template TEMPLATE¶

Fournit le chemin vers un répertoire contenant un modèle d’application personnalisé, un chemin vers une archive non compressée (.tar) ou une archive compressée (.tar.gz, .tar.bz2, .tar.xz, .tar.lzma, .tgz, .tbz2, .txz, .tlz, .zip) contenant les fichiers du modèle de structure d’application.

Par exemple, cette commande cherche un modèle d’application dans le répertoire indiqué lors de la création de l’application myapp:

django-admin startapp --template=/Users/jezdez/Code/my_app_template myapp

Django accepte également des URL (http, https, ftp) vers des archives compressées contenant les fichiers de modèle d’application, se chargeant de les télécharger et de les décompresser à la volée.

Par exemple, en profitant de la fonctionnalité de GitHub qui expose les dépôts sous forme de fichiers zip, vous pouvez utilisez une URL comme :

django-admin startapp --template=https://github.com/githubuser/django-app-template/archive/main.zip myapp

--extension EXTENSIONS, -e EXTENSIONS¶

Indique les extensions de fichiers dans le modèle d’application qui doivent être produits par le moteur de gabarit. py par défaut.

--name FILES, -n FILES¶

Indique les fichiers du modèle d’application (en plus de ceux correspondant à --extension) qui doivent être produits par le moteur de gabarit. Par défaut, c’est une liste vide.

--exclude DIRECTORIES, -x DIRECTORIES¶

Indique quels répertoires dans le modèle d’application doivent être exclus, en plus de .git and __pycache__. Si cette option n’est pas donnée, les répertoires nommés __pycache__ ou commençant par un . seront exclus.

Le contexte de gabarit utilisé pour tous les fichiers concernés est :

• Toute option transmise à la commande startapp (parmi les options acceptées par la commande)
• app_name – le nom d’application tel que transmis à la commande
• app_directory – le chemin complet de l’application nouvellement créée
• camel_case_app_name – le nom d’application au format CamelCase
• docs_version – la version de la documentation : 'dev' ou '1.x'
• django_version – la version de Django, par ex. '2.0.3'

startproject¶

django-admin startproject name [directory]¶

Crée une structure de répertoires de projet Django avec le nom de projet donné, dans le répertoire actuel ou la destination indiquée.

Par défaut, le nouveau répertoire contient manage.py est un paquet de projet (contenant settings.py et d’autres fichiers).

Si seul le nom de projet est fourni, le répertoire de projet et le paquet de projet seront tous deux nommés <nom_projet> et le répertoire du projet sera créé dans le répertoire de travail actuel.

Si la destination facultative est fournie, Django utilise ce répertoire existant comme répertoire de projet, et crée manage.py ainsi que le paquet de projet à l’intérieur. Vous pouvez utiliser « . » pour signifier le répertoire de travail actuel.

Par exemple :

django-admin startproject myproject /Users/jezdez/Code/myproject_repo

--template TEMPLATE¶

Indique un répertoire, un chemin de fichier ou l’URL d’un modèle de projet personnalisé. Consultez la documentation de startapp --template pour des exemples d’utilisation.

--extension EXTENSIONS, -e EXTENSIONS¶

Indique les extensions de fichiers dans le modèle de projet qui doivent être produits par le moteur de gabarit. py par défaut.

--name FILES, -n FILES¶

Indique les fichiers du modèle de projet (en plus de ceux correspondant à --extension) qui doivent être produits par le moteur de gabarit. Par défaut, c’est une liste vide.

--exclude DIRECTORIES, -x DIRECTORIES¶

Indique quels répertoires dans le modèle de projet doivent être exclus, en plus de .git and __pycache__. Si cette option n’est pas donnée, les répertoires nommés __pycache__ ou commençant par un . seront exclus.

Le contexte de gabarit utilisé est :

• Toute option transmise à la commande startproject (parmi les options acceptées par la commande)
• project_name – le nom du projet tel que transmis à la commande
• project_directory – le chemin complet du projet nouvellement créé
• secret_key – une clé aléatoire pour le réglage SECRET_KEY
• docs_version – la version de la documentation : 'dev' ou '1.x'
• django_version – la version de Django, par ex. '2.0.3'

Veuillez consultez également l’avertissement concernant le rendu mentionné pour la commande startapp.

test¶

django-admin test [test_label [test_label ...]]¶

Lance les tests de toutes les applications installées. Voir Les tests dans Django pour plus d’informations.

--failfast¶

Interrompt l’exécution des tests et affiche le rapport de l’échec immédiatement après l’échec d’un test.

--testrunner TESTRUNNER¶

Indique la classe de lancement de tests utilisée pour exécuter les tests. Cette valeur écrase la valeur contenue dans le réglage TEST_RUNNER.

--noinput, --no-input¶

Supprime toute demande interactive à l’utilisateur. Une demande typique concerne par exemple l’avertissement de suppression d’une base de données de test existante.

$ python -m pip install tblib

testserver¶

django-admin testserver [fixture [fixture ...]]¶

Lance un serveur de développement Django (comme avec runserver) en utilisant les données des instantanés indiqués.

Par exemple, cette commande :

django-admin testserver mydata.json

…effectue les opérations suivantes :

1. Création d’une base de données de test, comme expliqué dans La base de données de test.
2. Remplissage de la base de données de test avec les données d’instantanés à partir des noms d’instantanés indiqués (pour plus de détails sur les instantanés, voir la documentation de loaddata).
3. Lancement du serveur de développement de Django (comme avec runserver), en utilisant la base de données de test venant d’être créée au lien de la base de données de production.

C’est utile dans plusieurs cas de figure :

• Lorsque vous écrivez des tests unitaires sur les interactions entre les vues et certaines données, il est pratique de pouvoir lancer testserver afin d’interagir manuellement avec ces vues dans un navigateur web.
• Admettons que vous développez une application Django et que vous disposez d’une copie « en bon état » de la base de données avec laquelle vous souhaiteriez interagir. Vous pouvez exporter cette base de données dans un instantané (par la commande dumpdata détaillée ci-dessus), puis utiliser testserver pour lancer l’application web avec ces données. Avec ce système, vous êtes libre de manipuler les données comme bon vous semble, sachant que toutes ces modifications ne se font que dans une base de données de test.

Notez que ce serveur ne détecte pas automatiquement les modifications de code source Python (comme le fait runserver). Il prend en compte par contre les modifications de gabarits.

--addrport ADDRPORT¶

Indique un port ou une adresse IP et un port différent de la valeur par défaut 127.0.0.1:8000. Cette valeur respecte exactement le même format et joue exactement le même rôle que le paramètre donné à la commande runserver.

Exemples :

Pour lancer le serveur de test sur le port 7000 avec les données fixture1 et fixture2:

django-admin testserver --addrport 7000 fixture1 fixture2
django-admin testserver fixture1 fixture2 --addrport 7000

(Les commandes ci-dessus sont équivalentes. Nous les avons écrites les deux pour montrer que le placement des options avant ou après les paramètres d’instantanés n’a pas d’importance.)

Pour lancer un serveur sur 1.2.3.4:7000 avec un instantané test:

django-admin testserver --addrport 1.2.3.4:7000 test

--noinput, --no-input¶

Supprime toute demande interactive à l’utilisateur. Une demande typique concerne par exemple l’avertissement de suppression d’une base de données de test existante.

django.contrib.auth¶

django-admin changepassword ringo

django.contrib.contenttypes¶

django.contrib.gis¶

django.contrib.sessions¶

django.contrib.sitemaps¶

django.contrib.staticfiles¶

Syntaxe colorée¶

DJANGO_COLORS¶

Les commandes django-admin / manage.py présentent leur affichage avec un code de couleur visuellement attractif si le terminal prend en charge l’affichage coloré de type ANSI. Les codes de couleur ne sont pas utilisés dans le cas où vous redirigez le résultat d’une commande vers un autre programme, sauf si l’option --force-color est indiquée.

export DJANGO_COLORS="light"

export DJANGO_COLORS="error=yellow/blue,blink;notice=magenta"

export DJANGO_COLORS="light;error=yellow/blue,blink;notice=magenta"

Complétion Bash¶

Si vous utilisez le shell Bash, il est conseillé d’installer le script Django de complétion Bash qui se trouve dans extras/django_bash_completion de la distribution source de Django. Il active la complétion par tabulation des commandes django-admin et manage.py afin de pouvoir, par exemple…

• Saisissez django-admin.
• Appuyer sur [TAB] pour voir toutes les options disponibles.
• Saisir sql, puis [TAB], pour voir toutes les commandes disponibles dont le nom commence par sql.

Voir Écriture de commandes django-admin personnalisées pour savoir comment ajouter des actions personnalisées.

Black formatting¶

The Python files created by startproject, startapp, optimizemigration, makemigrations, and squashmigrations are formatted using the black command if it is present on your PATH.

If you have black globally installed, but do not wish it used for the current project, you can set the PATH explicitly:

PATH=path/to/venv/bin django-admin makemigrations

For commands using stdout you can pipe the output to black if needed:

django-admin inspectdb | black -