Appen ”statiska filer¶

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 även

För en introduktion till appen för statiska filer och några användningsexempel, se Hur man hanterar statiska filer (t.ex. bilder, JavaScript, CSS). För riktlinjer om hur du distribuerar statiska filer, se Så här distribuerar du statiska filer.

Inställningar¶

Se staticfiles settings för information om följande inställningar:

:inställning:`STORAGES`
:inställning:`STATIC_ROOT`
:inställning:`STATIC_URL`
:inställning:`STATICFILES_DIRS`
:inställning:`STATICFILES_FINDERS`

Förråd¶

`StaticFilesStorage`¶

class storage.StaticFilesStorage¶

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.

storage.StaticFilesStorage.post_process(paths, **options)¶

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.

`ManifestStaticFilesStorage`¶

class storage.ManifestStaticFilesStorage¶

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.

Lagringsbackenden 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");

…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");

Användning av HTML-attributet integrity med lokala filer

När du använder det valfria attributet integrity inom taggar som <script> eller <link>, bör dess värde beräknas baserat på filerna när de serveras, inte som lagrade i filsystemet. Detta är särskilt viktigt eftersom deras kontrollsumma kan ha ändrats beroende på hur statiska filer samlas in (t.ex. när collectstatic används). För närvarande finns det inga färdiga verktyg tillgängliga för detta.

Du 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
from django.contrib.staticfiles.storage import (
    ManifestStaticFilesStorage,
    StaticFilesStorage,
)


class MyManifestStaticFilesStorage(ManifestStaticFilesStorage):
    def __init__(self, *args, **kwargs):
        manifest_storage = StaticFilesStorage(location=settings.BASE_DIR)
        super().__init__(*args, manifest_storage=manifest_storage, **kwargs)

Referenser i kommentarer

ManifestStaticFilesStorage ignorerar inte sökvägar i uttalanden som är kommenterade. Denna kan krascha på de icke-existerande sökvägarna. Du bör kontrollera och eventuellt ta bort kommentarer.

storage.ManifestStaticFilesStorage.manifest_hash¶

Det 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).

storage.ManifestStaticFilesStorage.max_post_process_passes¶

Eftersom 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.

storage.ManifestStaticFilesStorage.manifest_strict¶

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).

storage.ManifestStaticFilesStorage.file_hash(name, content=None)¶

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.

`ManifestFilesMixin`¶

class storage.ManifestFilesMixin¶

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.

Finders Modul¶

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

result = finders.find("css/base.css")
searched_locations = finders.searched_locations

Andra hjälpare¶

Det 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.

Vy för utveckling av statiska filer¶

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.

views.serve(request, path)¶

Denna vyfunktion serverar statiska filer under utveckling.

Varning

Denna vy fungerar endast om DEBUG är True.

Det beror på att den här vyn är grovt ineffektiv och förmodligen osäker. Den här vyn är endast avsedd för lokal utveckling och ska aldrig användas i produktion.

Observera

För att gissa de serverade filernas innehållstyper förlitar sig denna vy på modulen mimetypes från Pythons standardbibliotek, som i sin tur förlitar sig på den underliggande plattformens kartfiler. Om du upptäcker att den här vyn inte returnerar korrekta innehållstyper för vissa filer, är det troligt att plattformens kartfiler är felaktiga eller behöver uppdateras. Detta kan till exempel göras genom att installera eller uppdatera paketet mailcap på en Red Hat-distribution, mime-support på en Debian-distribution eller genom att redigera nycklarna under HKEY_CLASSES_ROOT i Windows-registret.

Den 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
from django.contrib.staticfiles import views
from django.urls import re_path

if settings.DEBUG:
    urlpatterns += [
        re_path(r"^static/(?P<path>.*)$", views.serve),
    ]

Observera 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:

urls.staticfiles_urlpatterns()¶

Detta returnerar rätt URL-mönster för servering av statiska filer till din redan definierade mönsterlista. Använd det så här:

from django.contrib.staticfiles.urls import staticfiles_urlpatterns

# ... the rest of your URLconf here ...

urlpatterns += staticfiles_urlpatterns()

Detta 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.

Varning

Denna hjälpfunktion fungerar endast om DEBUG är True och din STATIC_URL-inställning varken är tom eller en fullständig URL som http://static.example.com/.

Det beror på att den här vyn är grovt ineffektiv och förmodligen osäker. Den här vyn är endast avsedd för lokal utveckling och ska aldrig användas i produktion.

Specialiserat testfall för att stödja ”live-testning¶

class testing.StaticLiveServerTestCase¶

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.

Men 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.

Appen ”statiska filer¶

Inställningar¶

Kommandon för hantering¶

`samla statiskt`¶

Anpassa listan över ignorerade mönster¶

`findstatic`¶

`runserver`¶

Förråd¶

`StaticFilesStorage`¶

`ManifestStaticFilesStorage`¶

`ManifestFilesMixin`¶

Finders Modul¶

Andra hjälpare¶

Vy för utveckling av statiska filer¶

Specialiserat testfall för att stödja ”live-testning¶

Additional Information

Support Django!

Contents

Getting help

Download:

Appen ”statiska filer¶

Inställningar¶

Kommandon för hantering¶

samla statiskt¶

Anpassa listan över ignorerade mönster¶

findstatic¶

runserver¶

Förråd¶

StaticFilesStorage¶

ManifestStaticFilesStorage¶

ManifestFilesMixin¶

Finders Modul¶

Andra hjälpare¶

Vy för utveckling av statiska filer¶

Specialiserat testfall för att stödja ”live-testning¶

Additional Information

Support Django!

Contents

Getting help

Download:

`samla statiskt`¶

`findstatic`¶

`runserver`¶

`StaticFilesStorage`¶

`ManifestStaticFilesStorage`¶

`ManifestFilesMixin`¶