docs: add recipe for customizing error handling#2694
Closed
Atishay17 wants to merge 2 commits into
Closed
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2694 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 64 64
Lines 7987 7987
Branches 1105 1105
=========================================
Hits 7987 7987 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Member
|
Hi @Atishay17, and thanks for this PR. Moreover, you marked in the checklist that you ran Tox, but it's not entirely true -- some gates fail. We will move forward with a version from a human Sprint participant if that gets committed. Otherwise we can circle back on this PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of Changes
Adds a new recipe to
docs/user/recipes/demonstrating two ways tocustomize Falcon's error handling behavior:
set_error_serializerto negotiate the error response formatbased on the client's
Acceptheader (JSON vs. plain text).add_error_handlerto intercept a specific exception type andeither render a custom response directly, or re-raise it as an
instance of
HTTPErrorso Falcon renders it as usual.Both examples are provided for WSGI and ASGI, with accompanying tests
in
tests/test_recipes.py. Adapted from the example gist linked inthe issue.
Note: drafted with LLM (Claude) assistance for the initial code/docs
and debugging test failures; all code has been run, tested, and
reviewed by me before submission.
Related Issues
Closes #2692
Pull Request Checklist
tox.docs/.docs/.versionadded,versionchanged, ordeprecateddirectives.docs/_newsfragments/.