Fresh 2 7 4 – File Managing App
django.contrib.staticfiles
collects static files from each of yourapplications (and any other places you specify) into a single location thatcan easily be served in production.
- Fresh 2 7 4 – File Managing App Version
- Fresh 2 7 4 – File Managing Application
- Fresh 2 7 4 – File Managing Apps
See also
For an introduction to the static files app and some usage examples, seeManaging static files (e.g. images, JavaScript, CSS). For guidelines on deploying static files,see Deploying static files.
Settings¶
- Download and install the best free apps for File Management on Windows, Mac, iOS, and Android from CNET Download.com, your trusted source for the top software picks.
- Simply use your phone to snap photos of damage following an accident and upload them using the app so Allstate can start working on your claim. 2; Bill Pay Make a one-time payment, manage automatic payments and review your policy bill and payment history. Roadside Assistance Our on-demand roadside service accessible to any driver, any car, any.
Fresh EBT is the #1 rated EBT App to check your food stamp balance, track your EBT spending, manage WIC benefits, and find ways to save money throughout the month. FEATURES. NEW: Track your Unemployment Benefits in New York. Check your EBT balance instantly - no phone calls or receipts. Track your purchase history to avoid surprises. Get a notification on your regular deposit date. The Windows Device Portal for HoloLens lets you configure and manage your device remotely over Wi-Fi or USB. The Device Portal is a web server on your HoloLens that you can connect to from a web browser on your PC. The Device Portal includes many tools that will help you manage your HoloLens and debug and optimize your apps.
See staticfiles settings for details on thefollowing settings:
Management Commands¶
django.contrib.staticfiles
exposes three management commands.
collectstatic
¶
django-admin collectstatic
¶
Collects the static files into STATIC_ROOT
.
Duplicate file names are by default resolved in a similar way to how templateresolution works: the file that is first found in one of the specifiedlocations will be used. If you’re confused, the findstatic
commandcan help show you which files are found.
On subsequent collectstatic
runs (if STATIC_ROOT
isn’t empty), filesare copied only if they have a modified timestamp greater than the timestamp ofthe file in STATIC_ROOT
. Therefore if you remove an application fromINSTALLED_APPS
, it’s a good idea to use the collectstatic--clear
option in order to remove stale static files.
Files are searched by using the enabledfinders
. The default is to look in all locations defined inSTATICFILES_DIRS
and in the 'static'
directory of appsspecified by the INSTALLED_APPS
setting.
The collectstatic
management command calls thepost_process()
method of the STATICFILES_STORAGE
after each run and passesa list of paths that have been found by the management command. It alsoreceives all command line options of collectstatic
. This is usedby the ManifestStaticFilesStorage
by default.
By default, collected files receive permissions fromFILE_UPLOAD_PERMISSIONS
and collected directories receive permissionsfrom FILE_UPLOAD_DIRECTORY_PERMISSIONS
. If you would like differentpermissions for these files and/or directories, you can subclass either of thestatic files storage classes and specify thefile_permissions_mode
and/or directory_permissions_mode
parameters,respectively. For example:
Then set the STATICFILES_STORAGE
setting to'path.to.MyStaticFilesStorage'
.
Some commonly used options are:
--noinput
,
--no-input
¶Do NOT prompt the user for input of any kind.
--ignore
PATTERN
,
-i
PATTERN
¶Ignore files, directories, or paths matching this glob-style pattern. Usemultiple times to ignore more. When specifying a path, always use forwardslashes, even on Windows.
--dry-run
,
-n
¶Do everything except modify the filesystem.
--clear
,
-c
¶Clear the existing files before trying to copy or link the original file.
--link
,
-l
¶Create a symbolic link to each file instead of copying.
--no-post-process
¶Don’t call thepost_process()
method of the configured STATICFILES_STORAGE
storage backend.
--no-default-ignore
¶Don’t ignore the common private glob-style patterns 'CVS'
, '.*'
and '*~'
.
For a full list of options, refer to the commands own help by running:
Customizing the ignored pattern list¶
The default ignored pattern list, ['CVS','.*','*~']
, can be customized ina more persistent way than providing the --ignore
command option at eachcollectstatic
invocation. Provide a custom AppConfig
class, override the ignore_patterns
attribute of this class and replace'django.contrib.staticfiles'
with that class path in yourINSTALLED_APPS
setting:
findstatic
¶
django-admin findstatic staticfile [staticfile ...]
¶
Searches for one or more relative paths with the enabled finders.
For example:
findstatic
--first
¶
By default, all matching locations are found. To only return the first matchfor each relative path, use the --first
option:
This is a debugging aid; it’ll show you exactly which static file will becollected for a given path.
By setting the --verbosity
flag to 0, you can suppress the extra output andjust get the path names:
On the other hand, by setting the --verbosity
flag to 2, you can get allthe directories which were searched:
runserver
¶
django-admin runserver [addrport]
Overrides the core runserver
command if the staticfiles
appis installed
and adds automatic serving of staticfiles. File serving doesn’t run through MIDDLEWARE
.
The command adds these options:
--nostatic
¶
Use the --nostatic
option to disable serving of static files with thestaticfiles app entirely. This option isonly available if the staticfiles app isin your project’s INSTALLED_APPS
setting.
Example usage:
--insecure
¶
Use the --insecure
option to force serving of static files with thestaticfiles app even if the DEBUG
setting is False
. By using this you acknowledge the fact that it’sgrossly inefficient and probably insecure. This is only intended forlocal development, should never be used in production and is onlyavailable if the staticfiles app isin your project’s INSTALLED_APPS
setting.
--insecure
doesn’t work with ManifestStaticFilesStorage
.
Example usage:
Storages¶
StaticFilesStorage
¶
- class
storage.
StaticFilesStorage
¶
A subclass of the FileSystemStorage
storage backend that uses the STATIC_ROOT
setting as the basefile system location and the STATIC_URL
setting respectivelyas the base URL.
storage.StaticFilesStorage.
post_process
(paths, **options)¶
If this method is defined on a storage, it’s called by thecollectstatic
management command after each run and gets passed thelocal storages and paths of found files as a dictionary, as well as the commandline options. It yields tuples of three values:original_path,processed_path,processed
. The path values are strings andprocessed
is a boolean indicating whether or not the value waspost-processed, or an exception if post-processing failed.
The ManifestStaticFilesStorage
uses this behind the scenes to replace the paths with their hashedcounterparts and update the cache appropriately.
ManifestStaticFilesStorage
¶
- class
storage.
ManifestStaticFilesStorage
¶
A subclass of the StaticFilesStorage
storage backend which stores the file names it handles by appending the MD5hash of the file’s content to the filename. For example, the filecss/styles.css
would also be saved as css/styles.55e7cbb9ba48.css
.
The purpose of this storage is to keep serving the old files in case somepages still refer to those files, e.g. because they are cached by you ora 3rd party proxy server. Additionally, it’s very helpful if you want toapply far future Expires headers to the deployed files to speed up theload time for subsequent page visits.
The storage backend automatically replaces the paths found in the savedfiles matching other saved files with the path of the cached copy (usingthe post_process()
method). The regular expressions used to find those paths(django.contrib.staticfiles.storage.HashedFilesMixin.patterns
)by default covers the @import rule and url() statement of CascadingStyle Sheets. For example, the 'css/styles.css'
file with thecontent
would be replaced by calling the url()
method of the ManifestStaticFilesStorage
storage backend, ultimatelysaving a 'css/styles.55e7cbb9ba48.css'
file with the followingcontent:
storage.ManifestStaticFilesStorage.
max_post_process_passes
¶
Since static files might reference other static files that need to have theirpaths replaced, multiple passes of replacing paths may be needed until the filehashes converge. To prevent an infinite loop due to hashes not converging (forexample, if 'foo.css'
references 'bar.css'
which references'foo.css'
) there is a maximum number of passes before post-processing isabandoned. In cases with a large number of references, a higher number ofpasses might be needed. Increase the maximum number of passes by subclassingManifestStaticFilesStorage
and setting the max_post_process_passes
attribute. It defaults to 5.
To enable the ManifestStaticFilesStorage
you have to make sure thefollowing requirements are met:
- the
STATICFILES_STORAGE
setting is set to'django.contrib.staticfiles.storage.ManifestStaticFilesStorage'
- the
DEBUG
setting is set toFalse
- you’ve collected all your static files by using the
collectstatic
management command
Since creating the MD5 hash can be a performance burden to your websiteduring runtime, staticfiles
will automatically store the mapping withhashed names for all processed files in a file called staticfiles.json
.This happens once when you run the collectstatic
managementcommand.
storage.ManifestStaticFilesStorage.
manifest_strict
¶
If a file isn’t found in the staticfiles.json
manifest at runtime, aValueError
is raised. This behavior can be disabled by subclassingManifestStaticFilesStorage
and setting the manifest_strict
attribute toFalse
– nonexistent paths will remain unchanged.
Due to the requirement of running collectstatic
, this storagetypically shouldn’t be used when running tests as collectstatic
isn’t runas part of the normal test setup. During testing, ensure that theSTATICFILES_STORAGE
setting is set to something else like'django.contrib.staticfiles.storage.StaticFilesStorage'
(the default).
storage.ManifestStaticFilesStorage.
file_hash
(name, content=None)¶
The method that is used when creating the hashed name of a file.Needs to return a hash for the given file name and content.By default it calculates a MD5 hash from the content’s chunks asmentioned above. Feel free to override this method to use your ownhashing algorithm.
ManifestFilesMixin
¶
- class
storage.
ManifestFilesMixin
¶
Fresh 2 7 4 – File Managing App Version
Use this mixin with a custom storage to append the MD5 hash of the file’scontent to the filename as ManifestStaticFilesStorage
does.
Finders Module¶
staticfiles
finders has a searched_locations
attribute which is a listof directory paths in which the finders searched. Example usage:
Other Helpers¶
There are a few other helpers outside of thestaticfiles
app to work with staticfiles:
- The
django.template.context_processors.static()
context processorwhich addsSTATIC_URL
to every template context renderedwithRequestContext
contexts. - The builtin template tag
static
which takes a path and urljoins itwith the static prefixSTATIC_URL
. Ifdjango.contrib.staticfiles
is installed, the tag uses theurl()
method of theSTATICFILES_STORAGE
instead. - The builtin template tag
get_static_prefix
which populates atemplate variable with the static prefixSTATIC_URL
to beused as a variable or directly. - The similar template tag
get_media_prefix
which works likeget_static_prefix
but usesMEDIA_URL
.
Static file development view¶
The static files tools are mostly designed to help with getting static filessuccessfully deployed into production. This usually means a separate,dedicated static file server, which is a lot of overhead to mess with whendeveloping locally. Thus, the staticfiles
app ships with aquick and dirty helper view that you can use to serve files locally indevelopment.
views.
serve
(request, path)¶
This view function serves static files in development.
Warning
This view will only work if DEBUG
is True
.
That’s because this view is grossly inefficient and probablyinsecure. This is only intended for local development, and shouldnever be used in production.
Note
To guess the served files’ content types, this view relies on themimetypes
module from the Python standard library, which itselfrelies on the underlying platform’s map files. If you find that this viewdoesn’t return proper content types for certain files, it is most likelythat the platform’s map files are incorrect or need to be updated. This canbe achieved, for example, by installing or updating the mailcap
packageon a Red Hat distribution, mime-support
on a Debian distribution, or byediting the keys under HKEY_CLASSES_ROOT
in the Windows registry.
This view is automatically enabled by runserver
(with aDEBUG
setting set to True
). To use the view with a differentlocal development server, add the following snippet to the end of yourprimary URL configuration:
Note, the beginning of the pattern (r'^static/'
) should be yourSTATIC_URL
setting.
Since this is a bit finicky, there’s also a helper function that’ll do this foryou:
urls.
staticfiles_urlpatterns
()¶
This will return the proper URL pattern for serving static files to youralready defined pattern list. Use it like this:
Fresh 2 7 4 – File Managing Application
This will inspect your STATIC_URL
setting and wire up the viewto serve static files accordingly. Don’t forget to set theSTATICFILES_DIRS
setting appropriately to letdjango.contrib.staticfiles
know where to look for files in addition tofiles in app directories.
Warning
This helper function will only work if DEBUG
is True
and your STATIC_URL
setting is neither empty nor a fullURL such as http://static.example.com/
.
That’s because this view is grossly inefficient and probablyinsecure. This is only intended for local development, and shouldnever be used in production.
Specialized test case to support ‘live testing’¶
- class
testing.
StaticLiveServerTestCase
¶
This unittest TestCase subclass extends django.test.LiveServerTestCase
.
Just like its parent, you can use it to write tests that involve running thecode under test and consuming it with testing tools through HTTP (e.g. Selenium,PhantomJS, etc.), because of which it’s needed that the static assets are alsopublished.
Fresh 2 7 4 – File Managing Apps
But given the fact that it makes use of thedjango.contrib.staticfiles.views.serve()
view described above, it cantransparently overlay at test execution-time the assets provided by thestaticfiles
finders. This means you don’t need to runcollectstatic
before or as a part of your tests setup.