Move from flask_restful to flask_restx. Replace error dictionaries with abort #15
Conversation
This file contains 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
This commit replaces all instances of returning error dictionaries with flask_restx.abort in multiple resources files. This refactoring enhances code readability and simplifies error handling. It also ensures that HTTP errors are handled in a more standardized way across the application.
The flask_restful import for Resource has been streamlined to flask_restx, and the initialization process in the PgsqlResource class has been extended with additional *args and **kwargs. This adjustment refines how our resources are initialized, and makes handling database connections in the kwargs argument more straightforward.
Flask_restful library is replaced with flask_restx in app.py file to leverage extended functionalities provided by flask_restx. This change aims to refine the resource initialization and streamline the handling of database connections.
The required Python package flask-restx has been added to the requirements file. Migrating from the flask_restful library to flask_restx, offers added features and a smoother experience with handling database connections and initializing resources.
maxachis
changed the title
joshuagraber
approved these changes
Jun 11, 2024
middleware/security.py
Outdated
| @@ -80,25 +82,27 @@ def decorator(*args, **kwargs): | |||
| if len(authorization_header) >= 2 and authorization_header[0] == "Bearer": | |||
| api_key = request.headers["Authorization"].split(" ")[1] | |||
| if api_key == "undefined": | |||
| return {"message": "Please provide an API key"}, 400 | |||
| abort(code=400, message="Please provide an API key") | |||
There was a problem hiding this comment.
@maxachis Is this going to change the shape of the error objects we receive on the client?
There was a problem hiding this comment.
@joshuagraber Based on my tests, yes, but only somewhat, and seemingly not in a way that should interfere. The response.json will now include a "http_status_code" key-value pair in addition to the "message" key-value pair.
So {'message': 'An unexpected error occurred'} will become {'http_status_code': 500, 'message': 'An unexpected error occurred'}
# Conflicts: # middleware/security.py # resources/PsycopgResource.py # resources/QuickSearch.py # resources/RefreshSession.py
…sage key directly.
…e_with_abort # Conflicts: # resources/QuickSearch.py
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.
Fixes
Description
Apiusage inapp.pyhas transitioned fromflask_restfultoflask_restx, which supports automated swagger documentation and has more active support.Testing
Performance
Docs