Django won't refresh staticfiles

DjangoDjango Staticfiles

Django Problem Overview


I have a JavaScript file referenced on a django template:

 <script src="{% static 'js/login.js' %} "></script>

I made some changes to that js file. Then, I refresh the page and I can't see the changes happen.

If I remove the JavaScript from the file and put it in the HTML, it works correctly, but if I try to do it using the external js file then it doesn't. I have tried closing the server and running runserver several times, I've also tried changing from Firefox to Chrome. It makes no sense at all. Please help me understand, I can get away with including all the js inside the HTML but it bothers me that I can't do it the normal way anymore.

More details about this error (the #$&%# weirdest thing I've found):

The JavaScript is something like this:

old_sentence = "Dig that hole, forget the sun"  // this is what I want to change
$("#jqselector").text(old_sentence)

new_sentence = "Run, rabbit, run"  // this is the new sentence, it just won't show up.

So, I changed the js and restart the server, still the html shows the old sentence. Then I deleted the reference to the login.js file and put all the js inside script tags in the HTML, of course, the new sentence appears. Then I include the login.js file, comment out the js inside the html but I delete all the content inside the login.js file, making it an empty file... but the old sentence still shows up.

Therefore the old login.js file must be cashed somewhere I don't know. Then I open Chrome and try it all again, same problem.

What can it be? is there an option to force django to refresh staticfiles? I thought restarting the server was enough. Should I reboot my computer?

Django Solutions


Solution 1 - Django

  • Clearing static file python manage.py collectstatic --noinput --clear. This will clear the statics beforehand.

  • Clear the browser cache

  • Add a random string after the js file include, e.g jquery.js?rand=23423423, with each load.

Solution 2 - Django

It sounds like both your browsers have the javascript file cached. In Chrome you can clear the cache by pressing Ctrl + Shift + Del and ticking just 'Cached images and files'. Firefox probably has a similar shortcut.

You can take a look at this question on tips to disable caching of static files on your development server altogether.

Solution 3 - Django

You need to bust the browser cache. This template tag will output a time based uuid when DEBUG=True. Otherwise it will look for a PROJECT_VERSION environment variable. If that is not found it will output a static version number.

import os
import uuid
from django import template                                                                                                              
from django.conf import settings                                                                                                         
                                                                                                                                         
register = template.Library()                                                                                                            
                                                                                                                                                                
@register.simple_tag(name='cache_bust')                                                                                                  
def cache_bust():                                                                                                                        
                                                                                                                                         
    if settings.DEBUG:                                                                                                                   
        version = uuid.uuid1()                                                                                                           
    else:                                                                                                                                
        version = os.environ.get('PROJECT_VERSION')                                                                                       
        if version is None:                                                                                                              
            version = '1'                                                                                                                
                                                                                                                                         
    return '__v__={version}'.format(version=version)

You would use in a template like this:

{% load cache_bust %}

<link rel="stylesheet" href="{% static "css/project.css" %}?{% cache_bust %}"/>

and here is the resulting output:

<link rel="stylesheet" href="/static/css/project.css?__v__=7d88de4e-7258-11e7-95a7-0242ac130005"/>

Solution 4 - Django

Instead of using complicated solutions you can add extra parameter to your includes in the templates.

For static includes:

<script src="{% static 'js/polls/polls.js' %}?version=1"></script>

For direct includes:

<link rel="stylesheet" type="text/css" href="/site_media/css/style.css?version=1" />  

Note the ?version=1 in the code. Every time you're modifying the css/js file, change this version in the template, so browser will be forced to reload the file.

And if you want to avoid caching at all for some unknown reason, you may use the current timestamp instead of version:

<link rel="stylesheet" type="text/css" href="/site_media/css/style.css?{% now "U" %}" />

Solution 5 - Django

"Changes of staticfiles is not working". There can be multiple reasons for that.

  1. Your browser is storing cache of your static files.

Solution (1): Open Incognito/Private window

Solution (2): Use hard refresh:

  • For mac: cmd + shift + r
  • For others: ctr + shift + r
  1. If you're facing this issue in production then follow the steps below:
  • Remove staticfiles folder by following command: sudo rm -rf staticfiles [inside your project directory]

  • Now run collectstatic command: python3 manage.py collectstatic

  • Restart gunicorn, by following command: sudo systemctl restart gunicorn

  • Restart nginx, by following command: sudo systemctl restart nginx

Sometimes browser stores thes staticfiles data (as caches) for a certain time. After couple of hours the problem may gone.

Hope this will fix you issue.

Solution 6 - Django

I have also struggled with this problem for hours. I have tried to inject random string using Javascript, but this method seems stupid and ugly-looking. One possible way to handle this problem is to introduce a custom tag. See this document for details:

Specifically, you need to create a package called templatetags in whatever apps you have created (or create a new one if you want). And you create any file in this package, and write something like this:

from django import template
from django.utils.crypto import get_random_string
from django.templatetags import static

register = template.Library()


class StaticExtraNode(static.StaticNode):

    def render(self, context):
        return super().render(context) + '?v=' + get_random_string(32)


@register.tag('static_no_cache')
def do_static_extra(parser, token):
    return StaticExtraNode.handle_token(parser, token)


def static_extra(path):
    return StaticExtraNode.handle_simple(path)

then you can use tag {% static_no_cache '.../.../path...' %} to create a path with random arguments!

I hope this would help!

Solution 7 - Django

For me after re collecting the static files Just Changes reflected for me.

$ python manage.py collectstatic --noinput --clear

Now run your server, hope it works.

$ python manage.py runserver

Solution 8 - Django

One solution is to change the settings to the following:

STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.ManifestStaticFilesStorage'

What this does is create a copy of the static file with a content hash in the file name (when running collectstatic). This way when the contents are changed the filename is changed and the old cache won't be used. The only problem with this is it doesn't get used when in DEBUG = True mode so you have to do a shift-reload to do a hard reload.

You can read the docs on ManifestStaticFilesStorage for more info.

EDIT: I found a solution for making sure static files are not cached in dev and posted it on another question.

Solution 9 - Django

A simple way to get rid, do a hard refresh cmd+shift+r/ctr+shift+r

A hard refresh is a way of clearing the browser’s cache for a specific page, to force it to load the most recent version of a page. on browser cmd+shift+r/ctr+shift+r

Solution 10 - Django

Simply running python manage.py collectstatic should do the trick. Then hard refresh browser with ctrl + F5 which should work on all browsers.

Solution 11 - Django

To refresh static files you should run python manage.py collectstatic again.

Solution 12 - Django

If nothing else works, search for the file name in the project and look for an unexpected copy. If you saved to the wrong location (different app) at some point, or splintered off a new app from an old, load priority may be playing tricks on you.

Solution 13 - Django

If you don't want to refresh the browser cache each time you change your CSS and JavaScript files, or while styling images, you need to set STATIC_URL dynamically with a varying path component. With the dynamically changing URL, whenever the code is updated, the visitor's browser will force loading of all-new uncached static files. In this recipe, we will set a dynamic path for STATIC_URL using time of last edit in os.

import os
from datetime import datetime    

def get_file_changeset(absolute_path):
    timestamp = max(map(lambda x: os.path.getmtime(x[0]), os.walk(os.path.join(absolute_path, 'static'))))
    try:
        timestamp = datetime.utcfromtimestamp(int(timestamp))
    except ValueError:
        return ""
    changeset = timestamp.strftime('%Y%m%d%H%M%S')
    return changeset

And next change in your SETTINGS:

from utils.misc import get_file_changeset
STATIC_URL = "/static/%s/" % get_file_changeset(BASE_DIR)

How it works:
The get_file_changeset()function takes the absolute_path directory as a parameter and calls the os.path.getmtime() to each file in each nested directory and finds the last-edited file (with its max edit time). The timestamp is parsed; converted to a string consisting of year, month, day, hour, minutes, and seconds; returned; and included in the definition of STATIC_URL.

Note: With this you have to reload dev server each time when you edit your static files.

Solution 14 - Django

I was chasing a css static file change tonight. Going thru a Django tutorial. My Django html page would not show the updated css to my base.css file.

I would see the original base.css but no my update to file.This is on a dev environment.

I did not think django cached static on dev and only after running coll ecstatic in production.

For a quick work around I changed the name of my test sites. base.css file to base1.css and the html page link to base1.css

reloaded page and my updated css took affect. No best solution. but quick fix.

Solution 15 - Django

For a window user, ctrl+f5 does the job on a development server and if this doesn't work then using the command python manage.py collectstatic is working else other ways mentioned in some answers are really risky so it's better to have a backup of your static files.

Solution 16 - Django

first run python manage.py collectstatic --link -l then python manage.py collectstatic do not use python manage.py collectstatic --noinput --clear it will bring down your server.

Solution 17 - Django

Your browser will cache images and files (javascript included). First, clear just your cached images and files. Then use incognito mode in chrome or private browsing in firefox while you are making changes to your .js files so you see them instantly after a page refresh

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionAlejandro VeintimillaView Question on Stackoverflow
Solution 1 - DjangoDanial TzView Answer on Stackoverflow
Solution 2 - DjangoknbkView Answer on Stackoverflow
Solution 3 - DjangoDerrick PetzoldView Answer on Stackoverflow
Solution 4 - DjangoThe GodfatherView Answer on Stackoverflow
Solution 5 - DjangoFarid ChowdhuryView Answer on Stackoverflow
Solution 6 - DjangoScott ChangView Answer on Stackoverflow
Solution 7 - DjangoChandan SharmaView Answer on Stackoverflow
Solution 8 - DjangoTim TisdallView Answer on Stackoverflow
Solution 9 - DjangoMuhammad AbdullahView Answer on Stackoverflow
Solution 10 - Djangoandypaling1View Answer on Stackoverflow
Solution 11 - DjangocatavaranView Answer on Stackoverflow
Solution 12 - DjangopragmarView Answer on Stackoverflow
Solution 13 - DjangoChiefirView Answer on Stackoverflow
Solution 14 - DjangoBill SandersonView Answer on Stackoverflow
Solution 15 - DjangoPythonOpView Answer on Stackoverflow
Solution 16 - DjangoSimbarashe MhlangaView Answer on Stackoverflow
Solution 17 - DjangoJason HView Answer on Stackoverflow