django.contrib.staticfiles samlar statiska filer från alla dina applikationer (och alla andra platser du anger) till en enda plats som enkelt kan användas i produktionen.
Se staticfiles settings för information om följande inställningar:
\n\ndjango.contrib.staticfiles exponerar tre hanteringskommandon.
samla statisktLink to this heading#Samlar de statiska filerna i STATIC_ROOT.
Duplicerade filnamn löses som standard på ett liknande sätt som mallupplösning fungerar: den fil som först hittas på en av de angivna platserna kommer att användas. Om du är förvirrad kan kommandot findstatic hjälpa dig att visa vilka filer som hittas.
Vid efterföljande körningar av collectstatic (om STATIC_ROOT inte är tom) kopieras filer endast om de har en ändrad tidsstämpel som är större än tidsstämpeln för filen i STATIC_ROOT. Om du tar bort ett program från INSTALLED_APPS är det därför en god idé att använda alternativet collectstatic --clear för att ta bort inaktuella statiska filer.
Filer söks med hjälp av enabled finders. Standardinställningen är att leta på alla platser som definieras i STATICFILES_DIRS och i katalogen 'static' för appar som anges i INSTALLED_APPS.
Hanteringskommandot collectstatic anropar metoden post_process() för lagringsbackend staticfiles från STORAGES efter varje körning och skickar en lista över sökvägar som har hittats av hanteringskommandot. Den tar också emot alla kommandoradsalternativ för collectstatic. Detta används av ManifestStaticFilesStorage som standard.
Som standard får insamlade filer behörigheter från FILE_UPLOAD_PERMISSIONS och insamlade kataloger får behörigheter från FILE_UPLOAD_DIRECTORY_PERMISSIONS. Om du vill ha olika behörigheter för dessa filer och/eller kataloger kan du underklassa någon av static files storage classes och ange parametrarna file_permissions_mode respektive directory_permissions_mode. Till exempel:
from django.contrib.staticfiles import storage\n\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)\nStäll sedan in lagringsbackend för staticfiles i STORAGES till 'path.to.MyStaticFilesStorage'.
Några vanligt förekommande alternativ är:
\nBe INTE användaren om någon form av inmatning.
\nIgnorera filer, kataloger eller sökvägar som matchar detta glob-liknande mönster. Använd flera gånger för att ignorera fler. När du anger en sökväg ska du alltid använda snedstreck, även i Windows.
\nGör allt utom att modifiera filsystemet.
\nRensa de befintliga filerna innan du försöker kopiera eller länka originalfilen.
\nSkapa en symbolisk länk till varje fil i stället för att kopiera.
\nAnropa inte post_process()-metoden för den konfigurerade staticfiles-lagringsbackend från STORAGES.
Ignorera inte de vanliga privata glob-stilmönstren 'CVS', '.*' och '*~'.
En fullständig lista över alternativ finns i kommandots egen hjälpfunktion genom att köra:
\nLinux / macOS
$ python manage.py collectstatic --help\nWindows
...\\> py manage.py collectstatic --help\nStandardlistan över ignorerade mönster, ['CVS', '.*', '*~'], kan anpassas på ett mer beständigt sätt än att tillhandahålla kommandoposten --ignore vid varje collectstatic-inkallelse. Tillhandahåll en anpassad AppConfig-klass, åsidosätt attributet ignore_patterns för denna klass och ersätt 'django.contrib.staticfiles' med klassens sökväg i din INSTALLED_APPS-inställning:
from django.contrib.staticfiles.apps import StaticFilesConfig\n\n\nclass MyStaticFilesConfig(StaticFilesConfig):\n ignore_patterns = [...] # your custom ignore list\nfindstaticLink to this heading#Söker efter en eller flera relativa sökvägar med de aktiverade sökarna.
\nTill exempel:
\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\nSom standard hittas alla matchande platser. Om du bara vill returnera den första matchningen för varje relativ sökväg använder du alternativet --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\nDetta är ett hjälpmedel för felsökning; det visar exakt vilken statisk fil som kommer att samlas in för en viss sökväg.
\nGenom att ställa in flaggan --verbosity till 0 kan du undertrycka den extra utmatningen och bara få sökvägsnamnen:
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\nOm du däremot sätter flaggan --verbosity till 2 kan du få fram alla kataloger som genomsöktes:
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\nrunserverLink to this heading#Åsidosätter kärnkommandot runserver om appen staticfiles är installed och lägger till automatisk servering av statiska filer. Filservering körs inte genom MIDDLEWARE.
Kommandot lägger till dessa alternativ:
\nAnvänd alternativet --nostatic för att inaktivera servering av statiska filer med appen staticfiles helt och hållet. Det här alternativet är endast tillgängligt om appen staticfiles finns i projektets inställning INSTALLED_APPS.
Exempel på användning:
\nLinux / macOS
$ django-admin runserver --nostatic\nWindows
...\\> django-admin runserver --nostatic\nAnvänd alternativet --insecure för att tvinga fram servering av statiska filer med appen staticfiles även om inställningen DEBUG` är False. Genom att använda detta godkänner du det faktum att det är grovt ineffektivt och förmodligen osäkert. Detta är endast avsett för lokal utveckling, bör aldrig användas i produktion och är endast tillgängligt om staticfiles-appen finns i ditt projekts INSTALLED_APPS-inställning.
--insecure fungerar inte med ManifestStaticFilesStorage.
Exempel på användning:
\nLinux / macOS
$ django-admin runserver --insecure\nWindows
...\\> django-admin runserver --insecure\nStaticFilesStorageLink to this heading#En underklass av lagringsbackend FileSystemStorage som använder inställningen STATIC_ROOT som basplats för filsystemet och inställningen STATIC_URL som bas-URL.
Om den här metoden är definierad på en lagringsplats anropas den av kommandot collectstatic efter varje körning och får de lokala lagringsplatserna och sökvägarna till de filer som hittats som en ordbok, samt kommandoradsalternativen. Den ger tupler med tre värden: original_path, processed_path, processed. Sökvägsvärdena är strängar och processed är en boolean som anger om värdet har efterbearbetats eller inte, eller ett undantag om efterbearbetningen misslyckades.
Klassen:~django.contrib.staticfiles.storage.ManifestStaticFilesStorage använder detta bakom kulisserna för att ersätta sökvägarna med deras hashade motsvarigheter och uppdatera cacheminnet på lämpligt sätt.
\nManifestStaticFilesStorageLink to this heading#En underklass av StaticFilesStorage lagringsbackend som lagrar filnamnen som den hanterar genom att lägga till MD5-hashen av filens innehåll till filnamnet. Till exempel: skulle filen css/styles.css också sparas som css/styles.55e7cbb9ba48.css.
Syftet med denna lagring är att fortsätta servera de gamla filerna om vissa sidor fortfarande hänvisar till dessa filer, t.ex. för att de är cachade av dig eller en proxyserver från tredje part. Dessutom är det mycket användbart om du vill tillämpa far future Expires headers på de distribuerade filerna för att påskynda laddningstiden för efterföljande sidbesök.
\nLagringsbackenden ersätter automatiskt sökvägarna som finns i de sparade filer som matchar andra sparade filer med sökvägen till den cachade kopian (med metoden post_process()). De reguljära uttryck som används för att hitta dessa sökvägar (django.contrib.staticfiles.storage.HashedFilesMixin.patterns) täcker:
Regeln @import och uttalandet url() i Cascading Style Sheets.
Source map-kommentarer i CSS- och JavaScript-filer.
Subclass ManifestStaticFilesStorage och sätt attributet upport_js_module_import_aggregation till True, om du vill använda de experimentella reguljära uttrycken för att täcka:
modules import i JavaScript.
Aggregatet modules aggregation i JavaScript.
Till exempel: filen 'css/styles.css' med detta innehåll:
@import url("../admin/css/base.css");\n…skulle ersättas genom att anropa url()-metoden för lagringsbackend ManifestStaticFilesStorage, vilket i slutändan sparar en 'css/styles.55e7cbb9ba48.css'-fil med följande innehåll:
@import url("../admin/css/base.27e20196a850.css");\nDu kan ändra platsen för manifestfilen genom att använda en anpassad underklass till ManifestStaticFilesStorage som anger argumentet manifest_storage. Till exempel:
from django.conf import settings\nfrom django.contrib.staticfiles.storage import (\n ManifestStaticFilesStorage,\n StaticFilesStorage,\n)\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)\nDet här attributet ger en enda hash som ändras när en fil i manifestet ändras. Detta kan vara användbart för att kommunicera till SPA:er att tillgångarna på servern har ändrats (på grund av en ny distribution).
\nEftersom statiska filer kan referera till andra statiska filer som behöver få sina sökvägar ersatta, kan det behövas flera omgångar för att ersätta sökvägar tills filhasharna konvergerar. För att förhindra en oändlig loop på grund av att hasharna inte konvergerar (t.ex. om 'foo.css'' refererar till ``'bar.css'' som refererar till ``'foo.css'') finns det ett maximalt antal genomgångar innan efterbehandlingen avbryts. I fall med ett stort antal referenser kan ett högre antal passeringar behövas. Öka det maximala antalet passeringar genom att underklassa ``ManifestStaticFilesStorage och ställa in attributet max_post_process_passes. Standardvärdet är 5.
För att aktivera ManifestStaticFilesStorage måste du se till att följande krav är uppfyllda:
lagringsbackend för staticfiles i STORAGES inställningen är inställd på 'django.contrib.staticfiles.storage.ManifestStaticFilesStorage'
inställningen DEBUG är satt till False
du har samlat in alla dina statiska filer med hjälp av hanteringskommandot collectstatic
Eftersom skapandet av MD5-hashen kan vara en prestandabörda för din webbplats under körning, kommer staticfiles automatiskt att lagra mappningen med hashade namn för alla bearbetade filer i en fil som heter staticfiles.json. Detta sker en gång när du kör hanteringskommandot collectstatic.
Om en fil inte hittas i manifestet staticfiles.json vid körning, uppstår ett ValueError. Detta beteende kan inaktiveras genom att underklassa ManifestStaticFilesStorage och ställa in attributet manifest_strict till False - icke-existerande sökvägar kommer att förbli oförändrade.
På grund av kravet på att köra collectstatic, bör denna lagring vanligtvis inte användas när du kör tester eftersom collectstatic inte körs som en del av den normala testinställningen. Under testning, se till att staticfiles lagringsbackend i STORAGES-inställningen är inställd på något annat som 'django.contrib.staticfiles.storage.StaticFilesStorage' (standard).
Den metod som används när man skapar det hashade namnet på en fil. Måste returnera en hash för det angivna filnamnet och innehållet. Som standard beräknas en MD5-hash från innehållets chunks som nämnts ovan. Du får gärna åsidosätta den här metoden för att använda din egen hashalgoritm.
\nManifestFilesMixinLink to this heading#Använd denna mixin med en anpassad lagring för att lägga till MD5-hashen för filens innehåll till filnamnet på samma sätt som ManifestStaticFilesStorage gör.
staticfiles finders har ett searched_locations attribut som är en lista över katalogsökvägar som finders sökte i. Exempel på användning:
from django.contrib.staticfiles import finders\n\nresult = finders.find("css/base.css")\nsearched_locations = finders.searched_locations\nDet finns några andra hjälpmedel utanför staticfiles-appen för att arbeta med statiska filer:
Kontextprocessorn django.template.context_processors.static() som lägger till STATIC_URL till varje mallkontext som återges med RequestContext-kontexter.
Den inbyggda malltaggen static som tar en sökväg och url-joinar den med det statiska prefixet STATIC_URL. Om django.contrib.staticfiles är installerat, använder taggen url() metoden för staticfiles lagringsbackend från STORAGES istället.
Den inbyggda malltaggen get_static_prefix som fyller en mallvariabel med det statiska prefixet STATIC_URL som kan användas som en variabel eller direkt.
Den liknande malltaggen get_media_prefix som fungerar som get_static_prefix men använder MEDIA_URL.
Nyckeln staticfiles i django.core.files.storage.storages innehåller en färdiginstallerad instans av lagringsbackend för staticfiles.
Verktygen för statiska filer är främst utformade för att hjälpa till med att få statiska filer framgångsrikt distribuerade i produktion. Detta innebär vanligtvis en separat, dedikerad statisk filserver, vilket är en hel del overhead att röra med när man utvecklar lokalt. Således levereras appen staticfiles med en snabb och smutsig hjälpvy som du kan använda för att servera filer lokalt under utveckling.
Denna vyfunktion serverar statiska filer under utveckling.
\n\n\nDen här vyn aktiveras automatiskt av runserver (med inställningen DEBUG inställd på True). Om du vill använda vyn med en annan lokal utvecklingsserver lägger du till följande stycke i slutet av konfigurationen för den primära URL:en:
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 ]\nObservera att början av mönstret (r'^static/') ska vara din STATIC_URL-inställning.
Eftersom det här är lite krångligt finns det också en hjälpfunktion som gör det åt dig:
\nDetta returnerar rätt URL-mönster för servering av statiska filer till din redan definierade mönsterlista. Använd det så här:
\nfrom django.contrib.staticfiles.urls import staticfiles_urlpatterns\n\n# ... the rest of your URLconf here ...\n\nurlpatterns += staticfiles_urlpatterns()\nDetta kommer att inspektera din STATIC_URL-inställning och koppla upp vyn för att servera statiska filer i enlighet därmed. Glöm inte att ställa in STATICFILES_DIRS på rätt sätt för att låta django.contrib.staticfiles veta var de ska leta efter filer utöver filer i appkataloger.
Denna unittest TestCase-underklass utökar django.test.LiveServerTestCase.
Precis som sin förälder kan du använda den för att skriva tester som innebär att du kör koden under test och konsumerar den med testverktyg via HTTP (t.ex. Selenium, PhantomJS, etc.), varför det behövs att de statiska tillgångarna också publiceras.
\nMen med tanke på att den använder django.contrib.staticfiles.views.serve()-vyn som beskrivs ovan, kan den på ett transparent sätt lägga över de tillgångar som tillhandahålls av staticfiles-sökarna vid testkörningstiden. Detta innebär att du inte behöver köra collectstatic före eller som en del av din testkonfiguration.