Optionally raise detailed exceptions vs. returning False #160
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.
Currently, python-saml has a number of cases where methods simply return False on failure. This prevents error details from bubbling up and being saved for retrieval.
This change decorates those methods with a decorator that, by default, returns False when an exception is raised. However, internally to python-saml, those exceptions are raised and saved for retrieval with
get_last_error_reason
.As a result, more detail is available for diagnostics, but the overall API is preserved, because, by default, those exceptions are suppressed when the methods in question are called directly.
Unit tests have been added to ensure that the appropriate exception is raised in all places where False is currently returned when the
raise_exceptions=True
keyword argument is passed, and existing tests checking that these methods return False when that keyword isn't passed remain as written.