Static folder configuration in Flask - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the static folder in a Flask application?

The static folder holds files like images, CSS, and JavaScript that the browser can load directly. It helps keep these files organized and accessible.

beginner

How do you tell Flask where your static folder is located?

You can set the static folder location by passing the static_folder parameter when creating the Flask app, like Flask(__name__, static_folder='my_static').

beginner

What is the default URL path to access static files in Flask?

By default, Flask serves static files under the URL path /static/. For example, a file style.css in the static folder is accessed at /static/style.css.

intermediate

How can you change the URL path prefix for static files in Flask?

You can change the URL path prefix by setting the static_url_path parameter when creating the Flask app, like Flask(__name__, static_url_path='/assets'). Then static files are accessed under /assets/.

beginner

Why is it important to keep static files in a separate folder in Flask?

Keeping static files separate helps organize your project, makes it easier for browsers to cache files, and allows Flask to serve them efficiently without running Python code.

What is the default folder name Flask uses to serve static files?

A assets

B public

C static

D resources

Flask uses the folder named 'static' by default to serve static files.

How do you change the folder Flask uses for static files?

A Modify the config file named static.conf

B Rename the 'templates' folder

C Change the app route decorator

D Set the static_folder parameter when creating the Flask app

You change the static folder by passing static_folder='folder_name' when creating the Flask app.

If you want static files to be accessed at '/assets/', which parameter should you set?

A url_prefix='/assets'

B static_url_path='/assets'

C static_folder='/assets'

D static_route='/assets'

The static_url_path parameter changes the URL prefix for static files.

Which of these files would you put in the static folder?

A style.css

B app.py

C index.html

D database.db

CSS files like style.css belong in the static folder to be served directly to browsers.

What URL would you use to access 'logo.png' inside the default static folder?

A /static/logo.png

B /logo.png

C /assets/logo.png

D /files/logo.png

By default, static files are accessed under '/static/', so the URL is '/static/logo.png'.

Explain how to configure a custom static folder and URL path in a Flask app.

Think about the parameters you pass when creating the Flask app object.

Why should static files be separated from templates and Python code in Flask?

Consider how browsers and servers handle static files differently from dynamic content.

Practice

1. What is the default folder name Flask uses to serve static files like images and CSS?

easy

A. assets

B. static

C. public

D. files

Solution

1. Step 1: Recall Flask default static folder

   Flask by default looks for a folder named static in your project to serve static files.

2. Step 2: Confirm other options are not defaults

   Folders like assets, public, or files are common in other frameworks but not Flask's default.

3. Final Answer:

   static -> Option B

4. Quick Check:

   Default static folder = static [OK]

Hint: Remember Flask uses 'static' folder by default for static files [OK]

Common Mistakes:

• Confusing 'assets' or 'public' as default static folder
• Thinking Flask serves static files from root directory
• Assuming no default static folder exists

2. Which of the following is the correct way to change the static folder name to 'assets' when creating a Flask app?

easy

A. app = Flask(__name__, static='assets')

B. app = Flask(static_folder='assets')

C. app = Flask(__name__, static_folder='assets')

D. app = Flask(__name__, static_url_path='assets')

Solution

1. Step 1: Identify correct Flask constructor parameter

   The parameter to change the static folder name is static_folder, used as Flask(__name__, static_folder='assets').

2. Step 2: Check other options for errors

   static='assets' is invalid, missing __name__ is wrong, and static_url_path changes URL path, not folder name.

3. Final Answer:

   app = Flask(__name__, static_folder='assets') -> Option C

4. Quick Check:

   Change folder with static_folder param [OK]

Hint: Use static_folder param in Flask constructor to rename folder [OK]

Common Mistakes:

• Using static instead of static_folder
• Omitting __name__ argument
• Confusing static_url_path with static_folder

3. Given this Flask app code:

app = Flask(__name__, static_folder='assets', static_url_path='/content')

# Assume assets folder contains image.png

# What URL path serves image.png?

medium

A. /content/image.png

B. /assets/image.png

C. /static/image.png

D. /image.png

Solution

1. Step 1: Understand static_folder and static_url_path roles

   static_folder='assets' sets the folder name, static_url_path='/content' sets the URL prefix to access static files.

2. Step 2: Determine URL to access image.png

   Since URL path is set to /content, the image is served at /content/image.png.

3. Final Answer:

   /content/image.png -> Option A

4. Quick Check:

   URL path = static_url_path value [OK]

Hint: URL uses static_url_path, not static_folder name [OK]

Common Mistakes:

• Assuming URL matches folder name
• Using default /static URL path despite override
• Confusing folder name with URL path

4. What is wrong with this Flask app code if static files are not served correctly?

app = Flask(__name__, static_folder='staticfiles')

# staticfiles folder exists with CSS files

# Trying to access /static/style.css returns 404

medium

A. The URL path /static does not match the static_folder name 'staticfiles'

B. The static_folder parameter should be set to 'static', not 'staticfiles'

C. The static_url_path should be set to '/staticfiles' to match folder name

D. Flask does not serve static files automatically

Solution

1. Step 1: Check static_folder and URL path mismatch

   Flask serves static files at URL path /static by default, but folder is renamed to staticfiles.

2. Step 2: Understand URL path must match static_url_path

   Since static_url_path is not set, Flask expects files at /static URL but folder is staticfiles, causing 404.

3. Final Answer:

   The URL path /static does not match the static_folder name 'staticfiles' -> Option A

4. Quick Check:

   URL path must match static_folder or static_url_path [OK]

Hint: Match static_url_path with static_folder or set both explicitly [OK]

Common Mistakes:

• Assuming folder rename auto-updates URL path
• Not setting static_url_path when changing folder
• Believing Flask never serves static files automatically

5. You want to serve static files from a folder named 'public_assets' but keep the URL path as '/static'. Which Flask app configuration achieves this?

hard

A. app = Flask(__name__, static_url_path='/static')

B. app = Flask(__name__, static_folder='static', static_url_path='/public_assets')

C. app = Flask(__name__, static_folder='public_assets')

D. app = Flask(__name__, static_folder='public_assets', static_url_path='/static')

Solution

1. Step 1: Set static_folder to 'public_assets'

   To serve files from 'public_assets' folder, set static_folder='public_assets'.

2. Step 2: Keep URL path as '/static'

   Set static_url_path='/static' to keep URL path unchanged.

3. Step 3: Verify other options

   app = Flask(__name__, static_folder='static', static_url_path='/public_assets') swaps folder and URL path, C uses default URL path '/static', D misses folder setting.

4. Final Answer:

   app = Flask(__name__, static_folder='public_assets', static_url_path='/static') -> Option D

5. Quick Check:

   Folder and URL path set explicitly [OK]

Hint: Set static_folder and static_url_path explicitly to control folder and URL [OK]

Common Mistakes:

• Swapping folder and URL path values
• Not setting static_url_path when folder changes
• Assuming default URL path changes with folder