Teardown hooks in Flask - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a teardown hook in Flask?

A teardown hook in Flask is a function that runs after each request, used to clean up resources like closing database connections.

beginner

How do you register a teardown hook in Flask?

You register a teardown hook using the @app.teardown_appcontext decorator for app-level cleanup or @app.teardown_request for request-level cleanup.

intermediate

When exactly does a teardown hook run in Flask?

A teardown hook runs after the response is sent to the client, regardless of whether the request was successful or raised an error.

intermediate

What argument does a teardown function receive in Flask?

A teardown function receives an error argument that is None if no error occurred, or contains the exception if one happened during the request.

beginner

Why are teardown hooks important in Flask applications?

Teardown hooks help prevent resource leaks by ensuring things like database connections or files are properly closed after each request.

Which decorator is used to register a teardown hook for the entire Flask application context?

A @app.route

B @app.teardown_appcontext

C @app.before_request

D @app.after_request

The @app.teardown_appcontext decorator registers a function to run when the application context tears down.

When does a teardown hook run in Flask?

A After the response is sent

B Only if the request is successful

C Only if the request raises an error

D Before the request starts

Teardown hooks run after the response is sent, regardless of success or error.

What argument does a teardown function receive?

A An error object or None

B The response object

C The request object

D No arguments

Teardown functions receive an error argument that is None if no error occurred.

Which of these is a common use for teardown hooks?

A Starting a database connection

B Logging request start time

C Closing database connections

D Rendering templates

Teardown hooks are commonly used to close database connections or clean up resources.

Can teardown hooks modify the response sent to the client?

A Only if an error occurred

B Yes, always

C Only if no error occurred

D No, they run after response is sent

Teardown hooks run after the response is sent, so they cannot modify it.

Explain what a teardown hook is in Flask and why it is useful.

Think about what happens after a web request finishes.

Describe how to register a teardown hook in Flask and what argument the function receives.

Focus on the decorator and function signature.

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