Custom status codes in Flask - Performance & Optimization

Performance: Custom status codes

LOW IMPACT

Custom status codes affect how the server communicates response status to the browser, impacting how browsers handle rendering and caching.

Returning HTTP responses with custom status codes in Flask

Flask

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

@app.route('/')
def index():
    return Response('Custom error', status=450)

Using custom codes within the valid HTTP range (e.g., 4xx or 5xx) ensures better compatibility and predictable browser behavior.

📈 Performance Gainavoids unexpected browser fallbacks, maintaining consistent rendering and caching

Returning HTTP responses with custom status codes in Flask

Flask

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

@app.route('/')
def index():
    return Response('Custom error', status=999)

Using non-standard status codes like 999 can confuse browsers and intermediaries, causing unpredictable rendering or caching issues.

📉 Performance Costmay cause browsers to ignore caching or fallback to default error handling, indirectly affecting load behavior

Performance Comparison

Pattern	DOM Operations	Reflows	Paint Cost	Verdict
Non-standard status code (e.g., 999)	No direct DOM changes	No reflows triggered	May cause fallback paint	[X] Bad
Standard custom status code (e.g., 450)	No direct DOM changes	No reflows triggered	Normal paint behavior	[OK] Good

Rendering Pipeline

The server sends the HTTP status code with the response headers. Browsers use this code to decide how to render content or handle errors. Non-standard codes may cause browsers to skip normal rendering or caching steps.

→Network

→Rendering

→Caching

⚠️ BottleneckRendering stage can be affected if browsers do not recognize the status code and fallback to generic error pages.

Optimization Tips

1Avoid using non-standard HTTP status codes outside the valid range.

2Use custom status codes within recognized HTTP ranges (4xx or 5xx) for better browser compatibility.

3Check response status codes in DevTools Network tab to ensure proper handling.

Performance Quiz - 3 Questions

What is a potential downside of using a non-standard HTTP status code like 999 in Flask responses?

A It speeds up page rendering.

B It reduces server CPU usage.

C Browsers may not recognize it and show fallback error pages.

D It improves caching automatically.

DevTools: Network

How to check: Open DevTools, go to Network tab, reload the page, and inspect the response status code of the request.

What to look for: Check if the status code is standard or custom and observe if the browser renders content or shows fallback error pages.

Practice

1. What is the correct way to return a custom status code 450 from a Flask route?

easy

A. return "Error", 450

B. return 450, "Error"

C. return Response(status=450)

D. return make_response(450, "Error")

Solution

1. Step 1: Understand Flask return tuple format

   Flask routes return a tuple with (response_body, status_code) to set custom status codes.

2. Step 2: Match the tuple with custom code 450

   Returning "Error", 450 matches the format (body, status_code) correctly.

3. Final Answer:

   return "Error", 450 -> Option A

4. Quick Check:

   Tuple (body, status) = return "Error", 450 [OK]

Hint: Return (body, code) tuple to set custom status [OK]

Common Mistakes:

• Swapping order of status and body in return tuple
• Using Response without import or wrong parameters
• Using make_response incorrectly

2. Which of the following is the correct syntax to return a JSON response with a custom status code 499 in Flask?

easy

A. return jsonify(message="Fail"), 499

B. return jsonify(message="Fail", status=499)

C. return jsonify(message="Fail", 499)

D. return jsonify(message="Fail").status_code(499)

Solution

1. Step 1: Use jsonify to create JSON response

   jsonify returns a Response object with JSON content.

2. Step 2: Return tuple with jsonify and status code

   To set custom status code, return (jsonify(...), status_code) tuple.

3. Final Answer:

   return jsonify(message="Fail"), 499 -> Option A

4. Quick Check:

   jsonify + tuple (response, code) = return jsonify(message="Fail"), 499 [OK]

Hint: Return (jsonify(...), code) tuple for JSON + custom code [OK]

Common Mistakes:

• Passing status code inside jsonify arguments
• Trying to call status_code as method
• Incorrect tuple order or syntax

3. What will be the HTTP status code returned by this Flask route?

from flask import Flask
app = Flask(__name__)

@app.route('/test')
def test():
    return "Custom", 499

medium

A. 404

B. 200

C. 499

D. 500

Solution

1. Step 1: Check the return statement in route

   The route returns a tuple ("Custom", 499), where 499 is the status code.

2. Step 2: Flask uses the second tuple element as status code

   Flask sets HTTP status code to 499 as specified in the return tuple.

3. Final Answer:

   499 -> Option C

4. Quick Check:

   Return tuple second value = status code 499 [OK]

Hint: Second tuple value in return sets status code [OK]

Common Mistakes:

• Assuming default 200 status code
• Confusing return order
• Thinking 499 is invalid and defaults to 500

4. Identify the error in this Flask route that tries to return a custom status code 499:

from flask import Flask
app = Flask(__name__)

@app.route('/error')
def error():
    return "Oops", status=499

medium

A. Route function must return a Response object

B. Custom status code 499 is not allowed in Flask

C. Missing jsonify for JSON response

D. Using 'status' keyword argument in return is invalid

Solution

1. Step 1: Check return statement syntax

   Flask does not accept 'status' keyword in return statement directly.

2. Step 2: Correct way is to return tuple (body, status_code)

   Use return "Oops", 499 instead of return "Oops", status=499.

3. Final Answer:

   Using 'status' keyword argument in return is invalid -> Option D

4. Quick Check:

   Return tuple (body, code) not keyword args [OK]

Hint: Return tuple (body, code), not keyword args [OK]

Common Mistakes:

• Using status=code in return instead of tuple
• Assuming Flask auto-detects status from keywords
• Confusing with Response object parameters

5. You want to create a Flask route that returns a JSON message with a custom status code 460 only if a query parameter 'valid' is 'no'. Otherwise, return status 200 with a success message. Which code correctly implements this?

hard

A. from flask import Flask, request, jsonify
app = Flask(__name__)

@app.route('/check')
def check():
if request.args.get('valid') == 'no':
return jsonify(error="Invalid", status=460)
return jsonify(message="OK")

B. from flask import Flask, request, jsonify
app = Flask(__name__)

@app.route('/check')
def check():
if request.args.get('valid') == 'no':
return jsonify(error="Invalid"), 460
return jsonify(message="OK"), 200

C. from flask import Flask, request, jsonify
app = Flask(__name__)

@app.route('/check')
def check():
if request.args.get('valid') == 'no':
return jsonify(error="Invalid").status_code = 460
return jsonify(message="OK")

D. from flask import Flask, request, jsonify
app = Flask(__name__)

@app.route('/check')
def check():
if request.args.get('valid') == 'no':
return jsonify(error="Invalid")
return jsonify(message="OK"), 200

Solution

1. Step 1: Check conditional logic for query parameter

   Use request.args.get('valid') to check if it equals 'no'.

2. Step 2: Return JSON with custom status code 460 if invalid

   Return (jsonify(...), 460) tuple to set custom status code correctly.

3. Step 3: Return success JSON with status 200 otherwise

   Return (jsonify(...), 200) tuple for success response.

4. Final Answer:

   Correct conditional returns with tuples for custom and normal codes -> Option B

5. Quick Check:

   Return (jsonify, code) tuples for all cases [OK]

Hint: Return (jsonify(...), code) tuples for all responses [OK]

Common Mistakes:

• Passing status inside jsonify arguments
• Trying to set status_code attribute directly
• Missing status code tuple on error response