Profiling Flask applications - Mini Project: Build & Apply

Profiling Flask applications

📖 Scenario: You are building a small Flask web application to understand how to profile its performance. Profiling helps find slow parts so you can improve your app.

🎯 Goal: Create a simple Flask app with one route, add a configuration variable to enable profiling, use Flask's built-in profiler middleware, and finally run the app with profiling enabled.

📋 What You'll Learn

Create a Flask app instance named app

Add a route / that returns the text 'Hello, Profiling!'

Create a configuration variable PROFILE set to True

Wrap the Flask app with ProfilerMiddleware from werkzeug.middleware.profiler when PROFILE is True

Run the Flask app with app.run()

💡 Why This Matters

🌍 Real World

Profiling helps developers find slow parts of their Flask web apps so they can improve speed and user experience.

💼 Career

Knowing how to profile Flask apps is useful for backend developers to optimize performance and troubleshoot bottlenecks.

1

Create the Flask app and route

Import Flask from flask. Create a Flask app instance called app. Add a route for '/' that returns the string 'Hello, Profiling!'.

Flask

from flask import Flask

# Create the Flask app instance
# Your code here

Hint

Use app = Flask(__name__) to create the app. Use @app.route('/') to define the route. The function should return the exact string.

2

Add a configuration variable to enable profiling

Add a configuration variable called PROFILE to the app.config dictionary and set it to True.

Flask

from flask import Flask

app = Flask(__name__)
app.config['PROFILE'] = True  # Your code here

@app.route('/')
def home():
    return 'Hello, Profiling!'

Hint

Use app.config['PROFILE'] = True to add the config variable.

3

Wrap the app with ProfilerMiddleware when profiling is enabled

Import ProfilerMiddleware from werkzeug.middleware.profiler. If app.config['PROFILE'] is True, wrap app.wsgi_app with ProfilerMiddleware passing app.wsgi_app and stream=None.

Flask

from flask import Flask
from werkzeug.middleware.profiler import ProfilerMiddleware

app = Flask(__name__)
app.config['PROFILE'] = True

# Wrap app.wsgi_app with ProfilerMiddleware if profiling is enabled
# Your code here

@app.route('/')
def home():
    return 'Hello, Profiling!'

Hint

Use an if statement to check app.config['PROFILE']. Wrap app.wsgi_app with ProfilerMiddleware.

4

Run the Flask app

Add the code to run the Flask app by calling app.run() at the bottom of the file.

Flask

from flask import Flask
from werkzeug.middleware.profiler import ProfilerMiddleware

app = Flask(__name__)
app.config['PROFILE'] = True

if app.config['PROFILE']:
    app.wsgi_app = ProfilerMiddleware(app.wsgi_app, stream=None)

@app.route('/')
def home():
    return 'Hello, Profiling!'

# Run the Flask app
# Your code here

Hint

Use the standard Python check if __name__ == '__main__': and call app.run() inside it.

Practice

1. What is the main purpose of profiling a Flask application?

easy

A. To find slow parts and improve performance

B. To add new routes to the app

C. To change the app's theme

D. To handle user authentication

Solution

1. Step 1: Understand profiling concept

   Profiling is used to measure where the app spends time during execution.

2. Step 2: Identify profiling goal in Flask

   In Flask, profiling helps find slow parts to optimize performance.

3. Final Answer:

   To find slow parts and improve performance -> Option A

4. Quick Check:

   Profiling = Find slow parts [OK]

Hint: Profiling = finding slow parts to speed up app [OK]

Common Mistakes:

• Confusing profiling with adding features
• Thinking profiling changes app design
• Mixing profiling with security tasks

2. Which code snippet correctly adds profiling middleware to a Flask app using Werkzeug?

easy

A. app = ProfilerMiddleware(app, restrictions=[30])

B. from flask_profiler import Profiler
app = Profiler(app)

C. from werkzeug.middleware.profiler import ProfilerMiddleware
app.wsgi_app = ProfilerMiddleware(app.wsgi_app, restrictions=[30])

D. from werkzeug.middleware import Profiler
app = Profiler(app)

Solution

1. Step 1: Import ProfilerMiddleware correctly

   It is imported from werkzeug.middleware.profiler.

2. Step 2: Wrap app.wsgi_app with ProfilerMiddleware

   Correct usage is app.wsgi_app = ProfilerMiddleware(app.wsgi_app, restrictions=[30]).

3. Final Answer:

   from werkzeug.middleware.profiler import ProfilerMiddleware app.wsgi_app = ProfilerMiddleware(app.wsgi_app, restrictions=[30]) -> Option C

4. Quick Check:

   Correct import and wrapping = from werkzeug.middleware.profiler import ProfilerMiddleware app.wsgi_app = ProfilerMiddleware(app.wsgi_app, restrictions=[30]) [OK]

Hint: ProfilerMiddleware wraps app.wsgi_app, not app directly [OK]

Common Mistakes:

• Importing from wrong module
• Wrapping app instead of app.wsgi_app
• Using wrong class names

3. Given this Flask app snippet with profiling enabled, what will be the effect when you run it?

from flask import Flask
from werkzeug.middleware.profiler import ProfilerMiddleware
app = Flask(__name__)
app.wsgi_app = ProfilerMiddleware(app.wsgi_app, restrictions=[10])

@app.route('/')
def home():
    return 'Hello Profiling!'

if __name__ == '__main__':
    app.run()

medium

A. The app runs but profiling is disabled silently

B. The app runs normally and prints profiling info for each request in console

C. The app crashes due to wrong middleware usage

D. The app returns profiling data as HTTP response

Solution

1. Step 1: Analyze middleware wrapping

   ProfilerMiddleware wraps app.wsgi_app correctly with restrictions=[10].

2. Step 2: Understand runtime behavior

   App runs normally and profiling info prints to console for each request.

3. Final Answer:

   The app runs normally and prints profiling info for each request in console -> Option B

4. Quick Check:

   Correct middleware = profiling info output [OK]

Hint: ProfilerMiddleware prints profile info to console during requests [OK]

Common Mistakes:

• Expecting profiling data in HTTP response
• Thinking app crashes with middleware
• Assuming profiling is off without errors

4. You added ProfilerMiddleware but see no profiling output. What is the most likely mistake in this code?

from flask import Flask
from werkzeug.middleware.profiler import ProfilerMiddleware
app = Flask(__name__)
app = ProfilerMiddleware(app, restrictions=[10])

@app.route('/')
def index():
    return 'Test'

medium

A. Flask app must be run with debug=True for profiling

B. Missing import of ProfilerMiddleware

C. Restrictions list must be empty

D. ProfilerMiddleware should wrap app.wsgi_app, not app directly

Solution

1. Step 1: Check how ProfilerMiddleware is applied

   It incorrectly wraps app instead of app.wsgi_app.

2. Step 2: Correct usage for profiling

   ProfilerMiddleware must wrap app.wsgi_app to work properly.

3. Final Answer:

   ProfilerMiddleware should wrap app.wsgi_app, not app directly -> Option D

4. Quick Check:

   Wrap app.wsgi_app, not app [OK]

Hint: Always wrap app.wsgi_app with ProfilerMiddleware [OK]

Common Mistakes:

• Wrapping app instead of app.wsgi_app
• Forgetting to import ProfilerMiddleware
• Misconfiguring restrictions parameter

5. You want to profile only the slowest 5 functions in your Flask app and save the results to files in a directory named 'profile'. Which code snippet correctly achieves this?

hard

A. from werkzeug.middleware.profiler import ProfilerMiddleware
app.wsgi_app = ProfilerMiddleware(app.wsgi_app, restrictions=[5], profile_dir='./profile')

B. from werkzeug.middleware.profiler import ProfilerMiddleware
app.wsgi_app = ProfilerMiddleware(app.wsgi_app, restrictions=[5], profile_dir='.')

C. from werkzeug.middleware.profiler import ProfilerMiddleware
app.wsgi_app = ProfilerMiddleware(app.wsgi_app, restrictions=[5], profile_dir='profile.log')

D. from werkzeug.middleware.profiler import ProfilerMiddleware
app.wsgi_app = ProfilerMiddleware(app.wsgi_app, restrictions=[5], profile_dir=None)

Solution

1. Step 1: Understand restrictions parameter

   restrictions=[5] limits output to slowest 5 functions.

2. Step 2: Set profile_dir correctly

   profile_dir must be a directory path, not a file name, to save profile files.

3. Step 3: Choose correct directory path

   './profile' is a directory path suitable for saving logs.

4. Final Answer:

   from werkzeug.middleware.profiler import ProfilerMiddleware app.wsgi_app = ProfilerMiddleware(app.wsgi_app, restrictions=[5], profile_dir='./profile') -> Option A

5. Quick Check:

   restrictions=5 + directory path = from werkzeug.middleware.profiler import ProfilerMiddleware app.wsgi_app = ProfilerMiddleware(app.wsgi_app, restrictions=[5], profile_dir='./profile') [OK]

Hint: profile_dir must be a folder, restrictions limits slowest funcs [OK]

Common Mistakes:

• Using file name instead of directory for profile_dir
• Setting profile_dir to None disables saving
• Misunderstanding restrictions parameter