How to Handle 500 Internal Server Error in Flask

In Flask, you can handle 500 Internal Server Errors by defining an error handler with @app.errorhandler(500). This lets you show a friendly message or custom page instead of the default error. Use this to improve user experience and log errors for debugging.

Why This Happens

A 500 Internal Server Error means something went wrong on the server while processing a request. This usually happens because of bugs like exceptions or mistakes in your code that Flask does not catch automatically.

For example, dividing by zero or accessing a variable that does not exist will cause this error.

python

from flask import Flask
app = Flask(__name__)

@app.route('/')
def index():
    # This will cause a ZeroDivisionError
    result = 10 / 0
    return f'Result is {result}'

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

Output

Internal Server Error
The server encountered an internal error and was unable to complete your request.

The Fix

To handle 500 errors gracefully, add an error handler in your Flask app using @app.errorhandler(500). This function will run when a 500 error occurs, letting you return a custom message or page.

This improves user experience and helps you log or debug errors.

python

from flask import Flask, render_template_string
app = Flask(__name__)

@app.route('/')
def index():
    result = 10 / 0  # This will cause an error
    return f'Result is {result}'

@app.errorhandler(500)
def internal_error(error):
    return render_template_string('<h1>Oops! Something went wrong.</h1><p>Please try again later.</p>'), 500

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

Output

<h1>Oops! Something went wrong.</h1><p>Please try again later.</p>

Prevention

To avoid 500 errors, always validate inputs and handle exceptions where possible. Use Flask's debugging mode during development to see detailed error messages.

Also, log errors to files or monitoring tools to catch issues early. Writing tests for your routes helps catch bugs before deployment.

Related Errors

Other common errors include 404 Not Found when a route does not exist, and 400 Bad Request when input data is invalid. Handling these with @app.errorhandler improves your app's robustness.

Key Takeaways

Use @app.errorhandler(500) to catch and handle internal server errors in Flask.

Return user-friendly messages or pages to improve the user experience on errors.

Enable debug mode during development to see detailed error info.

Validate inputs and handle exceptions to prevent 500 errors.

Log errors to monitor and fix issues quickly.