`staticfiles` アプリ¶

django.contrib.staticfiles は、各アプリケーション（と、あらかじめ指定した他の場所）から静的ファイルを収集し、本番環境で簡単に提供できるように一か所にまとめます。

参考

静的ファイルアプリの導入と活用例については、静的ファイル (画像、JavaScript、CSS など) を管理するを参照してください。静的ファイルのデプロイに関するガイドラインについては、静的ファイルをデプロイするを参照してください。

設定¶

次の設定に関する詳細については、静的ファイルの設定を参照してください。

ストレージ¶

`StaticFilesStorage`¶

class storage.StaticFilesStorage¶

FileSystemStorage ストレージバックエンドのサブクラスです。 STATIC_ROOT 設定を基本ファイルシステムの場所として、STATIC_URL 設定を基本URLとして使用します。

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

このメソッドがストレージ上で定義されている場合は、 collectstatic 管理コマンドが実行されるたびに呼び出され、見つかったファイルのローカルストレージとパス、およびコマンドラインオプションが辞書として渡されます。この処理は original_path 、 processed_path 、 processed の3つの値のタプルを生成します。パスの値は文字列であり、 processed は値が事後処理されたかどうかを示すブール値であり、事後処理が失敗した場合は例外が格納されます。

ManifestStaticFilesStorage は、これを裏で使用してパスをハッシュ化された対応するパスに置き換え、キャッシュを適切に更新します。

`ManifestStaticFilesStorage`¶

class storage.ManifestStaticFilesStorage¶

StaticFilesStorage のストレージバックエンドのサブクラスです。ファイル名を処理する際に、ファイルの内容のMD5ハッシュをファイル名に追加して保存します。たとえば、ファイル css/styles.css は css/styles.55e7cbb9ba48.css として保存されます。

このストレージの目的は、古いファイルを提供し続けることです。なぜなら、古いファイルはあなたや第三者のプロキシサーバによってキャッシュされており、いくつかのページがまだそれらのファイルを参照することがあるからです。また、展開されたファイルに far future Expires headers を適用して、次回のページ訪問の読み込み時間を高速化する場合にも非常に役立ちます。

保存されたファイル内のパスが他の保存されたファイルと一致する場合、ストレージバックエンドは自動的にキャッシュされたコピーのパスでそれらのパスを置き換えます（このとき、 post_process() メソッドを使用）。これらのパスを検索するために使用される正規表現（ django.contrib.staticfiles.storage.HashedFilesMixin.patterns ）は以下に対応しています。

@import ルールと url() ステートメントの Cascading Style Sheets
CSS および JavaScript ファイル内の Source map コメント

ManifestStaticFilesStorage のサブクラスを作成し、 support_js_module_import_aggregation 属性を True に設定すると、実験的な正規表現を使用して以下にも対応できます。

JavaScript の modules import
JavaScriptの modules aggregation

たとえば、以下のような 'css/styles.css' を定義します。

@import url("../admin/css/base.css");

...これは ManifestStaticFilesStorage ストレージバックエンドの url() メソッドを呼び出すことで置換され、最終的に 'css/styles.55e7cbb9ba48.css' というファイルが以下の内容で保存されます。

@import url("../admin/css/base.27e20196a850.css");

ローカルファイルに対する integrity HTML属性の使用方法

<script> や <link> のようなタグ内で任意の integrity 属性を使用する場合、その値はファイルシステムに保存されている状態ではなく、提供されるファイルに基づいて計算されるべきです。これは、静的ファイルがどのように収集されるかによって、そのチェックサムが変更され得るため、特に重要です（例えば、collectstatic を使用した場合）。現時点では、このための既製のツールは用意されていません。

マニフェストファイルの場所は、manifest_storage 引数を設定するカスタムの ManifestStaticFilesStorage サブクラスを使用することで変更できます。たとえば:

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)

コメント内の参照

ManifestStaticFilesStorage は、コメントアウトされた文内のパスを無視しません。これにより、存在しないパスでクラッシュする可能性があります。コメントをチェックし、必要に応じて削除するべきです。

storage.ManifestStaticFilesStorage.manifest_hash¶

この属性は、マニフェスト内のファイルが変更されるたびに変わる単一のハッシュを提供します。これは、サーバー上のアセットが変更されたこと（新しいデプロイメントが原因）をSPAに通知するのに役立つことがあります。

storage.ManifestStaticFilesStorage.max_post_process_passes¶

静的ファイルは他の静的ファイルを参照することがあるため、パスを置き換える処理を複数回行う必要があります。ファイルのハッシュが収束するまでこの処理を繰り返します。無限ループを防ぐため('foo.css' が 'bar.css' を参照し、その 'bar.css' が再び 'foo.css' を参照する例のように、ハッシュが収束しない場合)、ポストプロセッシングを中止する前に最大で何回のパスが可能かを設定しています。多くの参照があるケースでは、より多くのパスが必要になることがあります。最大パス数を増やすには、ManifestStaticFilesStorage をサブクラス化し、max_post_process_passes 属性を設定します。デフォルトは5です。

ManifestStaticFilesStorage を有効にするには、以下の要件を満たしていることを確認してください:

STORAGES 設定の staticfiles ストレージバックエンドが 'django.contrib.staticfiles.storage.ManifestStaticFilesStorage' に設定されていること
DEBUG 設定が False に設定されていること
collectstatic 管理コマンドを使用して、全ての静的ファイルを収集したこと

MD5ハッシュを作成することは、実行時にウェブサイトにとってパフォーマンス上の負担となる可能性があるため、 staticfiles は自動的に staticfiles.json というファイルに、処理されたすべてのファイルのハッシュ名とマッピングを保存します。これは collectstatic 管理コマンドを実行したときに一度だけ起こります。

storage.ManifestStaticFilesStorage.manifest_strict¶

実行時に staticfiles.json マニフェストでファイルが見つからない場合、ValueError が発生します。この動作は、ManifestStaticFilesStorage をサブクラス化し、manifest_strict 属性を False に設定することで無効にできます(存在しないパスはそのままになります)。

collectstatic を実行する必要があるため、このストレージは通常、テストの実行時には使用しないでください。テスト中は、 STORAGES 設定にある staticfiles ストレージバックエンドが 'django.contrib.staticfiles.storage.StaticFilesStorage' (デフォルト) のように他のものに設定されていることを確認してください。

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

ファイルのハッシュ化された名前を作成する際に使用されるメソッドです。与えられたファイル名と内容に対するハッシュを返す必要があります。デフォルトでは、上述のように、内容のチャンクからMD5ハッシュを計算します。このメソッドをオーバーライドして、独自のハッシュアルゴリズムを使用することもできます。

`ManifestFilesMixin`¶

class storage.ManifestFilesMixin¶

カスタムストレージでこのミックスインを使用すると、 ManifestStaticFilesStorage が行うように、ファイルの内容の MD5 ハッシュをファイル名に追加します。

ファインダー・モジュール¶

staticfiles ファインダーには、ファインダーが検索したディレクトリパスのリストである searched_locations 属性があります。使用例:

from django.contrib.staticfiles import finders

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

その他のヘルパー¶

staticfiles アプリ以外にも、静的ファイルを扱うためのいくつかの他のヘルパーがあります。

django.template.context_processors.static() コンテキストプロセッサは、 RequestContext コンテキストでレンダリングされたすべてのテンプレートコンテキストに STATIC_URL を追加します。
組み込みのテンプレートタグ static はパスを受け取り、静的なプレフィックス STATIC_URL と urljoin します。もし django.contrib.staticfiles がインストールされていれば、代わりに STORAGES にある staticfiles ストレージバックエンドの url() メソッドを使用します。
組み込みのテンプレートタグ get_static_prefix は、テンプレート変数に静的プレフィックス STATIC_URL を代入し、変数として、または直接使用します。
同様のテンプレートタグ get_media_prefix は get_static_prefix のように動作しますが、 MEDIA_URL を使用します。
staticfiles キーは django.core.files.storage.storages に含まれており、 staticfiles ストレージバックエンドの使用準備が整ったインスタンスが格納されています。

静的ファイル開発ビュー¶

静的ファイルツールは、主に静的ファイルを本番環境にうまくデプロイするために設計されています。これは通常、開発時には扱いが大変な専用の静的ファイルサーバーを意味します。そのため、staticfiles アプリには、開発中にローカルでファイルを提供するために使用できる 素早くて簡易なヘルパービュー が同梱されています。

views.serve(request, path)¶

このビュー関数は、開発中に静的ファイルを配信します。

警告

このビューは DEBUG が True の場合にのみ機能します。

このビューは 極めて非効率的 であり、おそらく セキュリティ上の問題 も抱えています。このビューは、 ローカル開発向け であり、 本番環境で使用するべきではありません 。

注釈

To guess the served files' content types, this view relies on the mimetypes module from the Python standard library, which itself relies on the underlying platform's map files. If you find that this view doesn't return proper content types for certain files, it is most likely that the platform's map files are incorrect or need to be updated. This can be achieved, for example, by installing or updating the mailcap package on a Red Hat distribution, mime-support on a Debian distribution, or by editing the keys under HKEY_CLASSES_ROOT in the Windows registry.

このビューは、 runserver (および DEBUG 設定が True に設定されている場合) によって自動的に有効になります。異なるローカル開発サーバーでこのビューを使用するには、主要なURL設定の末尾に以下のコードを追加してください:

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),
    ]

注意: パターンの先頭 (r'^static/') はあなたの設定 (STATIC_URL) であるべきです。

これは少し厄介なので、これを代行してくれるヘルパー関数もあります:

urls.staticfiles_urlpatterns()¶

これは、すでに定義されているパターンリストに静的ファイルを提供するための適切なURLパターンを返します。次のように使います:

from django.contrib.staticfiles.urls import staticfiles_urlpatterns

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

urlpatterns += staticfiles_urlpatterns()

これにより、STATIC_URL 設定が検査され、静的ファイルを適切に提供するためのビューが設定されます。 django.contrib.staticfiles がアプリディレクトリ内のファイルに加えて、どこでファイルを探せばよいかを知るために、 STATICFILES_DIRS 設定を適切に設定することを忘れないでください。

警告

このヘルパー関数は、 DEBUG が True であり、かつ STATIC_URL の設定が空でも完全なURL (例: http://static.example.com/) でもない場合にのみ動作します。

「ライブテスト」をサポートするための特別なテストケース¶

class testing.StaticLiveServerTestCase¶

この unittest の TestCase サブクラスは django.test.LiveServerTestCase を拡張しています。

親と同様に、テスト対象のコードを実行し、HTTP を介してテストツール(例: Selenium、PhantomJS など)で使用するテストを記述するために使用できます。そのため、静的アセットも公開する必要があります。

しかし、上記で説明した django.contrib.staticfiles.views.serve() ビューを利用しているため、テスト実行時に staticfiles ファインダーによって配信されたアセットを透過的に上書きできます。つまり、テストのセットアップの前やその一部として collectstatic を実行する必要はありません。

`staticfiles` アプリ¶

設定¶

管理コマンド¶

`collectstatic`¶

無視パターンリストをカスタマイズする¶

`findstatic`¶

`runserver`¶

ストレージ¶

`StaticFilesStorage`¶

`ManifestStaticFilesStorage`¶

`ManifestFilesMixin`¶

ファインダー・モジュール¶

その他のヘルパー¶

静的ファイル開発ビュー¶

「ライブテスト」をサポートするための特別なテストケース¶

追加的な情報

Support Django!

コンテンツ

助けを求める

ダウンロード:

Diamond and Platinum Members

staticfiles アプリ¶

設定¶

管理コマンド¶

collectstatic¶

無視パターンリストをカスタマイズする¶

findstatic¶

runserver¶

ストレージ¶

StaticFilesStorage¶

ManifestStaticFilesStorage¶

ManifestFilesMixin¶

ファインダー・モジュール¶

その他のヘルパー¶

静的ファイル開発ビュー¶

「ライブテスト」をサポートするための特別なテストケース¶

追加的な情報

Support Django!

コンテンツ

助けを求める

ダウンロード:

Diamond and Platinum Members

`staticfiles` アプリ¶

`collectstatic`¶

`findstatic`¶

`runserver`¶

`StaticFilesStorage`¶

`ManifestStaticFilesStorage`¶

`ManifestFilesMixin`¶