Teardown hooks in Flask - Mini Project: Build & Apply

Using Teardown Hooks in Flask

📖 Scenario: You are building a simple Flask web app that needs to clean up resources after each request. This is important to avoid resource leaks, like open database connections.

🎯 Goal: Learn how to use Flask's teardown_appcontext decorator to run cleanup code automatically after each request finishes.

📋 What You'll Learn

Create a Flask app instance named app

Define a function called close_db that prints 'Closing database connection' when called

Register close_db as a teardown hook using @app.teardown_appcontext

Create a simple route / that returns 'Hello, Flask!'

💡 Why This Matters

🌍 Real World

Teardown hooks help clean up resources like database connections or files after each web request, preventing resource leaks.

💼 Career

Understanding teardown hooks is important for backend developers to write robust Flask applications that manage resources efficiently.

1

Create the Flask app instance

Import Flask from flask and create a Flask app instance called app.

Flask

# Import Flask and create app instance
# Your code here

Hint

Use Flask(__name__) to create the app instance.

2

Define the teardown function

Define a function called close_db that takes one argument exception and prints 'Closing database connection' inside the function.

Flask

from flask import Flask
app = Flask(__name__)

# Define close_db function
# Your code here

Hint

The function must accept exception even if you don't use it.

3

Register the teardown hook

Use the @app.teardown_appcontext decorator to register the close_db function as a teardown hook.

Flask

from flask import Flask
app = Flask(__name__)

# Register close_db as teardown hook
# Your code here
def close_db(exception):
    print('Closing database connection')

Hint

Place the decorator @app.teardown_appcontext right above the close_db function.

4

Add a simple route

Create a route for / using @app.route('/') that defines a function index returning the string 'Hello, Flask!'.

Flask

from flask import Flask
app = Flask(__name__)

@app.teardown_appcontext
def close_db(exception):
    print('Closing database connection')

# Create route for '/' that returns 'Hello, Flask!'
# Your code here

Hint

Use @app.route('/') decorator and define index function returning the greeting string.

Practice

1. What is the main purpose of a teardown_request function in Flask?

easy

A. To handle incoming HTTP requests

B. To define URL routes

C. To start a new request

D. To run cleanup code after each request finishes

Solution

1. Step 1: Understand the role of teardown hooks

   Teardown hooks run after a request ends to clean up resources like files or database connections.

2. Step 2: Match the purpose with options

   Only To run cleanup code after each request finishes describes running cleanup code after each request finishes, which matches the teardown hook purpose.

3. Final Answer:

   To run cleanup code after each request finishes -> Option D

4. Quick Check:

   Teardown hooks = cleanup after request [OK]

Hint: Teardown hooks always run after request ends [OK]

Common Mistakes:

• Confusing teardown with request handling
• Thinking teardown runs before request
• Assuming teardown defines routes

2. Which of the following is the correct way to register a teardown function in Flask?

easy

A. @app.teardown_request
def cleanup(error=None): pass

B. @app.after_request
def cleanup(): pass

C. @app.route('/teardown')
def cleanup(): pass

D. @app.before_request
def cleanup(): pass

Solution

1. Step 1: Identify the correct decorator for teardown

   The correct decorator to register a teardown function is @app.teardown_request, which optionally accepts an error parameter.

2. Step 2: Check function signature

   The function should accept an optional error=None parameter to detect errors during the request.

3. Final Answer:

   @app.teardown_request\ndef cleanup(error=None): pass -> Option A

4. Quick Check:

   Teardown decorator = @app.teardown_request [OK]

Hint: Teardown functions use @app.teardown_request with error param [OK]

Common Mistakes:

• Using @app.before_request instead
• Missing the optional error parameter
• Confusing with @app.after_request

3. Given this Flask code snippet, what will be printed after a request completes successfully (no error)?

@app.teardown_request
def cleanup(error=None):
    if error:
        print('Error occurred')
    else:
        print('Request finished cleanly')

medium

A. Error occurred

B. Request finished cleanly

C. No output

D. SyntaxError

Solution

1. Step 1: Understand the error parameter in teardown

   The error parameter is None if the request finished without errors.

2. Step 2: Trace the if-else logic

   Since error is None, the else branch runs, printing 'Request finished cleanly'.

3. Final Answer:

   Request finished cleanly -> Option B

4. Quick Check:

   error=None means clean finish [OK]

Hint: error=None means no error, so else branch runs [OK]

Common Mistakes:

• Assuming error is always True
• Expecting no output
• Confusing teardown with before_request

4. What is wrong with this teardown function?

@app.teardown_request
def cleanup():
    print('Cleaning up')

medium

A. Decorator should be @app.before_request

B. Using print inside teardown is not allowed

C. Missing the optional error parameter in the function

D. Function name must be 'teardown' exactly

Solution

1. Step 1: Check teardown function signature

   Teardown functions must accept an optional error=None parameter to receive error info.

2. Step 2: Identify missing parameter issue

   The function cleanup has no parameters, so Flask will raise an error when calling it.

3. Final Answer:

   Missing the optional error parameter in the function -> Option C

4. Quick Check:

   Teardown needs error param or it fails [OK]

Hint: Teardown functions must accept error=None parameter [OK]

Common Mistakes:

• Omitting error parameter
• Using wrong decorator
• Thinking function name is fixed

5. You want to close a database connection after every request, but only if it was opened during that request. Which is the best way to do this using a teardown hook?

hard

A. Use @app.teardown_request with a function that checks if the connection exists and closes it

B. Use @app.before_request to close the connection before the request starts

C. Use @app.route to close the connection on a specific URL

D. Use @app.after_request to close the connection without checking if it exists

Solution

1. Step 1: Understand when to close resources

   Resources like database connections should be closed after the request ends, not before or on specific routes.

2. Step 2: Use teardown_request with conditional check

   The teardown function can check if the connection was opened during the request and close it safely.

3. Final Answer:

   Use @app.teardown_request with a function that checks if the connection exists and closes it -> Option A

4. Quick Check:

   Teardown + check connection before closing = best practice [OK]

Hint: Close resources in teardown only if they exist [OK]

Common Mistakes:

• Closing connection before request starts
• Closing without checking if connection exists
• Trying to close on specific route only