app/v2/utils.py

from flask import request
from werkzeug.exceptions import BadRequest

from app.v2.errors import BadRequestError


def get_valid_json():
    try:
        request_json = request.get_json(force=True)
    except BadRequest:
        raise BadRequestError(
            message="Invalid JSON supplied in POST data", status_code=400
        )
    return request_json or {}
Check that the request payload data is valid json. By adding `force=True` to request.get_json() the mime type is ignore. If the data is not valid json the method will return a `BadRequestError` we catch that and throw our own error with a clear error message "Invalid JSON supplied in POST data". If the json is valid return the json data or an empty dict if None is passed in. This PR improves the error messages if the json is invalid, previously, the error message was "None object type" message which is not very helpful. 2019-11-21 15:21:18 +00:00			`from flask import request`
Run auto-correct on app/ and tests/ 2021-03-10 13:55:06 +00:00			`from werkzeug.exceptions import BadRequest`
Check that the request payload data is valid json. By adding `force=True` to request.get_json() the mime type is ignore. If the data is not valid json the method will return a `BadRequestError` we catch that and throw our own error with a clear error message "Invalid JSON supplied in POST data". If the json is valid return the json data or an empty dict if None is passed in. This PR improves the error messages if the json is invalid, previously, the error message was "None object type" message which is not very helpful. 2019-11-21 15:21:18 +00:00
			`from app.v2.errors import BadRequestError`


			`def get_valid_json():`
			`try:`
			`request_json = request.get_json(force=True)`
			`except BadRequest:`
reformat 2023-08-29 14:54:30 -07:00			`raise BadRequestError(`
			`message="Invalid JSON supplied in POST data", status_code=400`
			`)`
Check that the request payload data is valid json. By adding `force=True` to request.get_json() the mime type is ignore. If the data is not valid json the method will return a `BadRequestError` we catch that and throw our own error with a clear error message "Invalid JSON supplied in POST data". If the json is valid return the json data or an empty dict if None is passed in. This PR improves the error messages if the json is invalid, previously, the error message was "None object type" message which is not very helpful. 2019-11-21 15:21:18 +00:00			`return request_json or {}`