staticfiles)Lien vers cette rubrique#django.contrib.staticfiles recueille les fichiers statiques à partir de chacune des applications (et de tous les autres endroits que vous spécifiez) en un seul endroit qui peut facilement être utilisé en production.
Voir réglages de staticfiles pour plus de détails sur les réglages suivants :
\n\ndjango.contrib.staticfiles propose trois commandes d’administration.
collectstaticLien vers cette rubrique#Recueille les fichiers statiques dans le répertoire STATIC_ROOT.
Lorsque deux fichiers ont le même nom, le problème est résolu par défaut d’une façon similaire à la façon dont fonctionne la résolution des gabarits : le premier fichier trouvé est utilisé. En cas d’incertitude, la commande findstatic peut vous montrer quels sont les fichiers trouvés.
Lors des prochains lancements de collectstatic (si STATIC_ROOT n’est pas vide), les fichiers ne sont copiés que si leur date de modification est plus récente que la date de modification du fichier dans STATIC_ROOT. Ainsi, si vous supprimez une application de INSTALLED_APPS, il est recommandé d’utiliser l’option collectstatic --clear afin de supprimer les fichiers statiques obsolètes.
La recherche des fichiers utilise le réglage STATICFILES_FINDERS. Par défaut, Django parcourt tous les emplacements définis dans STATICFILES_DIRS et dans le répertoire 'static' des applications figurant dans le réglage INSTALLED_APPS .
La commande d’administration collectstatic appelle la méthode post_process() du système de stockage STATICFILES_STORAGE après chacune de ses exécutions et lui passe une liste des chemins qu’elle a trouvés. La méthode reçoit également toutes les options de ligne de commande de collectstatic. C’est utilisé par la classe ManifestStaticFilesStorage par défaut.
Par défaut, les fichiers collectés reçoivent les autorisations du réglage FILE_UPLOAD_PERMISSIONS et les répertoires reçoivent les autorisations de FILE_UPLOAD_DIRECTORY_PERMISSIONS. Si vous souhaitez des autorisations différentes pour ces fichiers ou répertoires, vous pouvez créer une sous-classe des classes de stockage des fichiers statiques et spécifier les paramètres file_permissions_mode ou directory_permissions_mode. Par exemple :
from django.contrib.staticfiles import storage\n\nclass MyStaticFilesStorage(storage.StaticFilesStorage):\n def __init__(self, *args, **kwargs):\n kwargs['file_permissions_mode'] = 0o640\n kwargs['directory_permissions_mode'] = 0o760\n super().__init__(*args, **kwargs)\nDéfinissez ensuite le réglage STATICFILES_STORAGE à 'chemin.vers.MyStaticFilesStorage'.
Certaines options couramment utilisées sont :
\nNe pose AUCUNE question à l’utilisateur.
\nIgnore les fichiers, les répertoires ou les chemins correspondant à ce motif de style « glob ». Peut être utilisé plusieurs fois pour ignorer plusieurs chemins. Si vous indiquez un chemin, utilisez toujours des barres obliques normales, même sur Windows.
\nExécute la commande normalement, mais sans toucher réellement au système de fichiers.
\nEfface les fichiers existants avant d’essayer de copier ou de lier le fichier d’origine.
\nCrée un lien symbolique vers chaque fichier au lieu de copier.
\nN’appelle pas la méthode post_process() du moteur de stockage configuré dans STATICFILES_STORAGE.
N’ignore pas les motifs de style « glob » `` “CVS”, ``'.*' et '*~' qui sont normalement toujours ignorés.
Pour une liste complète des options, reportez-vous à l’aide des commandes elles-mêmes en exécutant :
\nLinux / macOS
$ python manage.py collectstatic --help\nWindows
...\\> py manage.py collectstatic --help\nLa liste des motifs ignorés par défaut, ['CVS', '.*', '*~'], peut être personnalisée de manière plus permanente que de fournir l’option en ligne de commande --ignore lors de chaque invocation de collectstatic. Ajoutez une classe AppConfig personnalisée, surchargez l’attribut ignore_patterns de la classe et remplacez 'django.contrib.staticfiles' dans le réglage INSTALLED_APPS par le chemin de cette classe :
from django.contrib.staticfiles.apps import StaticFilesConfig\n\nclass MyStaticFilesConfig(StaticFilesConfig):\n ignore_patterns = [...] # your custom ignore list\nfindstaticLien vers cette rubrique#Recherche un ou plusieurs chemins relatifs en fonction des chercheurs activés.
\nPar exemple :
\nLinux / macOS
$ python manage.py findstatic css/base.css admin/js/core.js\nFound 'css/base.css' here:\n /home/special.polls.com/core/static/css/base.css\n /home/polls.com/core/static/css/base.css\nFound 'admin/js/core.js' here:\n /home/polls.com/src/django/contrib/admin/media/js/core.js\nWindows
...\\> py manage.py findstatic css\\base.css admin\\js\\core.js\nFound 'css/base.css' here:\n /home/special.polls.com/core/static/css/base.css\n /home/polls.com/core/static/css/base.css\nFound 'admin/js/core.js' here:\n /home/polls.com/src/django/contrib/admin/media/js/core.js\nPar défaut, tous les emplacements trouvés sont utilisés. Pour ne renvoyer que le premier chemin relatif trouvé, utilisez l’option --first:
Linux / macOS
$ python manage.py findstatic css/base.css --first\nFound 'css/base.css' here:\n /home/special.polls.com/core/static/css/base.css\nWindows
...\\> py manage.py findstatic css\\base.css --first\nFound 'css/base.css' here:\n /home/special.polls.com/core/static/css/base.css\nIl s’agit d’une outil de débogage ; vous verrez exactement quel fichier statique sera trouvé pour un chemin donné.
\nEn mettant le drapeau --verbosity à 0, vous pouvez supprimer les explications complémentaires et obtenir uniquement les noms de chemins :
Linux / macOS
$ python manage.py findstatic css/base.css --verbosity 0\n/home/special.polls.com/core/static/css/base.css\n/home/polls.com/core/static/css/base.css\nWindows
...\\> py manage.py findstatic css\\base.css --verbosity 0\n/home/special.polls.com/core/static/css/base.css\n/home/polls.com/core/static/css/base.css\nD’autre part, en mettant l’option --verbosity à 2, vous pouvez obtenir la liste de tous les répertoires qui ont été recherchés :
Linux / macOS
$ python manage.py findstatic css/base.css --verbosity 2\nFound 'css/base.css' here:\n /home/special.polls.com/core/static/css/base.css\n /home/polls.com/core/static/css/base.css\nLooking in the following locations:\n /home/special.polls.com/core/static\n /home/polls.com/core/static\n /some/other/path/static\nWindows
...\\> py manage.py findstatic css\\base.css --verbosity 2\nFound 'css/base.css' here:\n /home/special.polls.com/core/static/css/base.css\n /home/polls.com/core/static/css/base.css\nLooking in the following locations:\n /home/special.polls.com/core/static\n /home/polls.com/core/static\n /some/other/path/static\nrunserverLien vers cette rubrique#Remplace la commande de base runserver si l’application staticfiles est installée, et ajoute automatiquement le service des fichiers statiques. Le service des fichiers n’utilise pas le réglage MIDDLEWARE.
La commande ajoute ces options :
\nUtilisez l’option --nostatic pour désactiver entièrement le service des fichiers statiques avec l’application staticfiles. Cette option n’est disponible que si l’application staticfiles fait partie du réglage INSTALLED_APPS de votre projet.
Exemple d’utilisation :
\nLinux / macOS
$ django-admin runserver --nostatic\nWindows
...\\> django-admin runserver --nostatic\nUtilisez l’option --insecure pour forcer le service des fichiers statiques avec l’application staticfiles même quand le réglage DEBUG est à False. En utilisant cette option, vous reconnaissez le fait que c’est totalement inefficace et très probablement non sécurisé. Cette option est uniquement destinée au développement en local et ne devrait jamais être utilisée en production. Elle n’est disponible que si l’application staticfiles se trouve dans le réglage INSTALLED_APPS de votre projet.
--insecure ne fonctionne pas avec ManifestStaticFilesStorage.
Exemple d’utilisation :
\nLinux / macOS
$ django-admin runserver --insecure\nWindows
...\\> django-admin runserver --insecure\nStaticFilesStorageLien vers cette rubrique#Une sous-classe du moteur de stockage FileSystemStorage qui utilise le réglage STATIC_ROOT comme emplacement de base dans le système de fichiers et le réglage STATIC_URL comme URL de base.
Si cette méthode est définie pour un stockage, elle est appelée par la commande de gestion collectstatic après chaque exécution et reçoit les stockages locaux et les chemins des fichiers trouvés sous forme de dictionnaire, de même que les options de la ligne de commande. Elle renvoie des tuples de trois valeurs : chemin_original, chemin_traité, traité. Les valeurs de chemins sont des chaînes et traité est un booléen indiquant si la valeur a reçu un post-traitement, ou une exception si le post-traitement a échoué.
Le stockage ManifestStaticFilesStorage utilise cette classe en coulisses pour remplacer les chemins par leur équivalent « haché » et mettre à jour le cache de manière appropriée.
ManifestStaticFilesStorageLien vers cette rubrique#Une sous-classe du moteur de stockage StaticFilesStorage qui modifie les noms des fichiers qu’elle traite en ajoutant le hachage MD5 du contenu du fichier au nom de fichier. Par exemple, le fichier css/styles.css serait également enregistré en tant que css/styles.55e7cbb9ba48.css.
Le but de ce stockage est de continuer à servir les anciens fichiers au cas où certaines pages se réfèrent encore à ces fichiers, par exemple parce qu’elles sont mises en cache par vous-même ou un serveur mandataire externe. En outre, cela est très utile si vous souhaitez appliquer des en-têtes à date d’expiration très lointaine aux fichiers déployés pour accélérer le temps de chargement des pages lors des visites ultérieures.
\nLe moteur de stockage remplace automatiquement dans les fichiers enregistrés les chemins qui correspondent aux autres fichiers enregistrés par les chemins des copies en cache (en utilisant la méthode post_process()). Les expressions régulières utilisées pour rechercher ces chemins (django.contrib.staticfiles.storage.HashedFilesMixin.patterns) couvrent :
La règle @import et l’instruction url() des feuilles de style CSS.
Le commentaire source map dans JavaScript.
Par exemple, le fichier 'css/styles.css' avec ce contenu :
@import url("../admin/css/base.css");\n…serait remplacé par l’appel de la méthode url() du moteur de stockage ManifestStaticFilesStorage, enregistrant finalement un fichier 'css/styles.55e7cbb9ba48.css' avec le contenu suivant :
@import url("../admin/css/base.27e20196a850.css");\nVous pouvez modifier l’emplacement du fichier manifeste en utilisant une sous-classe personnalisée de ManifestStaticFilesStorage qui définit l’argument manifest_storage. Par exemple
from django.conf import settings\nfrom django.contrib.staticfiles.storage import (\n ManifestStaticFilesStorage, StaticFilesStorage,\n)\n\nclass MyManifestStaticFilesStorage(ManifestStaticFilesStorage):\n def __init__(self, *args, **kwargs):\n manifest_storage = StaticFilesStorage(location=settings.BASE_DIR)\n super().__init__(*args, manifest_storage=manifest_storage, **kwargs)\nComme les fichiers statiques peuvent se référer à d’autres fichiers statiques qui ont besoin d’un remplacement de chemins, plusieurs passes de remplacements de chemins peuvent être nécessaires jusqu’à ce que les hachages de fichier convergent. Pour éviter une boucle sans fin en raison de hachages non convergeant (par exemple, si 'foo.css' se réfère à 'bar.css' qui référence 'foo.css'), un nombre maximum de passes est défini avant qu’un post-traitement soit abandonné. Dans le cas d’un nombre de références élevé, il pourrait être nécessaire d’augmenter ce nombre de passes. Ceci peut se faire en créant une sous-classe de ManifestStaticFilesStorage et en définissant l’attribut max_post_process_passes. Sa valeur par défaut est 5.
Pour activer le stockage ManifestStaticFilesStorage, vous devez vous assurer que les conditions suivantes sont remplies :
le réglage STATICFILES_STORAGE contient 'django.contrib.staticfiles.storage.ManifestStaticFilesStorage'
le réglage DEBUG contient False
vous avez recueilli tous les fichiers statiques en utilisant la commande d’administration collectstatic
Comme la création du hachage MD5 peut diminuer la performance de votre site Web, staticfiles stocke automatiquement la correspondance des noms hachés pour chaque fichier traité dans un fichier nommé staticfiles.json. Cela se produit une seule fois au moment où vous exécutez la commande collectstatic.
Si un fichier n’est pas trouvé dans le manifeste staticfiles.json lors de l’exécution, une exception ValueError est générée. Ce comportement peut être désactivé en créant une sous-classe de ManifestStaticFilesStorage et en définissant l’attribut manifest_strict à False – les chemins non existants seront laissés inchangés.
Comme il faut que la commande collectstatic ait été lancée, ce stockage ne doit normalement pas être utilisé lors de l’exécution des tests car collectstatic n’est pas exécutée dans une configuration de test normale. Lors des tests, vérifiez que le réglage STATICFILES_STORAGE est défini sur autre chose, comme par exemple la valeur par défaut 'django.contrib.staticfiles.storage.StaticFilesStorage'.
La méthode utilisée lors de la création du nom haché d’un fichier. Doit renvoyer une empreinte de hachage pour le nom de fichier donné et son contenu. Par défaut, on calcule un hachage MD5 à partir du contenu comme mentionné ci-dessus. N’hésitez pas à redéfinir cette méthode pour utiliser votre propre algorithme de hachage.
\nManifestFilesMixinLien vers cette rubrique#Utilisez cette classe mixin avec un stockage personnalisé pour ajouter au nom de fichier une empreinte MD5 du contenu du fichier, comme le fait ManifestStaticFilesStorage.
findersLien vers cette rubrique#Le module finders (découverte des fichiers statiques) de staticfiles possède un attribut searched_locations qui est une liste de chemins de répertoires dans lesquels des fichiers statiques ont été recherchés. Exemple d’utilisation :
from django.contrib.staticfiles import finders\n\nresult = finders.find('css/base.css')\nsearched_locations = finders.searched_locations\nIl existe quelques autres utilitaires en plus de l’application staticfiles pour gérer les fichiers statiques :
Le processeur de contexte django.template.context_processors.static() qui ajoute STATIC_URL au contexte de chaque gabarit rendu avec RequestContext.
La balise de gabarit static de base qui prend un chemin et le combine avec le préfixe statique STATIC_URL. Si django.contrib.staticfiles est installée, la balise utilise plutôt la méthode url() de STATICFILES_STORAGE.
La balise de gabarit get_static_prefix qui renseigne une variable de gabarit avec le préfixe statique STATIC_URL pour utilisation immédiate ou stockée dans une variable.
La balise de gabarit similaire get_media_prefix qui fonctionne comme get_static_prefix mais utilise MEDIA_URL.
Les outils concernant les fichiers statiques sont principalement conçus pour aider à déployer correctement les fichiers statiques en production. Cela implique généralement de dédier un serveur distinct pour les fichiers statiques, ce qui induit de trop nombreuses actions supplémentaires lorsque l’on développe en local sur un environnement de développement. Ainsi, l’application staticfiles est fournie avec une vue à la va-vite que vous pouvez utiliser pour s’occuper du service des fichiers lors du développement local.
Cette fonction de vue sert les fichiers statiques lors du développement.
\n\n\nCette vue est automatiquement activée par runserver (avec le réglage DEBUG à True). Pour utiliser la vue avec un autre serveur de développement local, ajoutez le code suivant à la fin de la configuration d’URL principale :
from django.conf import settings\nfrom django.contrib.staticfiles import views\nfrom django.urls import re_path\n\nif settings.DEBUG:\n urlpatterns += [\n re_path(r'^static/(?P<path>.*)$', views.serve),\n ]\nRemarque : le début du motif (r'^static/') devrait correspondre au réglage STATIC_URL.
Comme c’est un peu fastidieux, il existe aussi une fonction utilitaire qui fait cela pour vous :
\nCela renvoie le motif d’URL approprié pour servir les fichiers statiques et peut être ajouté à la liste de motifs d’URL déjà définie. Utilisez-la comme ceci :
\nfrom django.contrib.staticfiles.urls import staticfiles_urlpatterns\n\n# ... the rest of your URLconf here ...\n\nurlpatterns += staticfiles_urlpatterns()\nCette fonction examine le réglage STATIC_URL et connecte la vue de service des fichiers statiques en conséquence. N’oubliez pas de définir le réglage STATICFILES_DIRS approprié pour faire savoir à django.contrib.staticfiles où rechercher les fichiers en plus des fichiers dans les répertoires des applications.
Cette sous-classe de test unitaire TestCase hérite de django.test.LiveServerTestCase.
Tout comme sa classe parente, vous pouvez l’utiliser pour écrire des tests qui impliquent le fonctionnement du code testé et de son exploitation par des outils de test à travers HTTP (par ex. Selenium, PhantomJS, etc.), et pour lesquels il est nécessaire que les fichiers statiques soient également disponibles.
\nMais étant donné qu’elle fait appel à la vue django.contrib.staticfiles.views.serve() présentée plus haut, elle peut servir de manière transparente au moment de l’exécution des tests les ressources statiques mises à disposition par le moteur de découverte de staticfiles. Cela signifie que vous n’avez pas besoin de lancer collectstatic préalablement ou dans le cadre de la configuration des tests.