How-To: Static Files

All good websites need static files like images, fonts and CSS. In this How-To guide you will be guided through how to access and use static files. You will also be shown how to modify certain things, like changing how Waffleweb looks for static files.

Adding Static Files

You can add static files to your application by creating a directory in your project with your STATIC_DIR (default is “/static”) and putting your static files in there.

Changing the Static Directory

To change the directory in which static files are looked for in you can add an item to the settings of your app. The key should be called “STATIC_DIR” with the path for Waffleweb to look for static files in.

yourApp.settings['STATIC_DIR'] = '/path/static'

Accessing Static Files

You can access static files from your templates or from your route functons.

Accessing in Routes

To access your static files from your route functions you can use the openStatic() function. openStatic() takes all the same arguments as open() except by default it looks under your STATIC_DIR (default is “/static”). You can change how openStatic() looks for static files. We will get into that later. openStatic()’s mode by default is “rb” because the FileResponse takes a binary file.

from waffleweb.static import openStatic
from waffleweb.response import FileResponse

@app.route('/file', methods=['GET'])
def file(request):
    with openStatic('file.jpg') as f:
              return FileResponse(request, f)

Accessing in Templates

Whenever a URL ends with a file extension Waffleweb looks for a static file with that path using openStatic(). if openStatic() returns a file, a FileResponse is sent, but if it doesn’t return a file then it sends a 404 page. By default it looks under your STATIC_DIR (default is “/static”). You can also access it in the browser this way.

To access “./STATIC_DIR/CSS/index.css” in the browser you can go to “localhost:8000/CSS/index.css”.

<img src="/file.jpg" alt="File">

Changing How Waffleweb Looks For Static Files

To change how Waffleweb looks for static files you can make your own function to find static. To change the static finder all you have to do is add an item to the settings of your app. The key should be called “DEFUALT_STATIC_FINDER” with the function for Waffleweb to use. By default Waffleweb uses the findStatic function.

yourApp.settings["DEFUALT_STATIC_FINDER"] = staticFinderFunction

Your static finder function should take a file or path, and return a path to the static file.

The DEFUALT_STATIC_FINDER is called by openStatic() with it’s file argument. openStatic() returns open() with the file being what the DEFUALT_STATIC_FINDER returns.

When a file is accessed from the browser Waffleweb calls function as so:

#Accessed URL: "localhost:8000/CSS/file.css"