Is it possible to implement extended response about flask-smorest HOT 17 CLOSED

# this logic is overriden in decorator

      if disable_etag:
            disable_etag_for_request()

            # Check etag precondition
            check_precondition()

            # Store etag_schema in AppContext
            set_etag_schema(etag_schema)

            # Execute decorated function
            result = func(*args, **kwargs)

            # Verify that check_etag was called in resource code if needed
            verify_check_etag()

"""Exception handler"""

from flask import jsonify, current_app
from werkzeug.exceptions import HTTPException, InternalServerError


def prepare_error(error) -> dict:
    payload = {
        'status': str(error),
    }

    # Get additional info passed as kwargs when calling abort
    # data may not exist if HTTPException was raised not using webargs abort
    # or if not kwargs were passed (https://github.com/sloria/webargs/pull/184)
    data = getattr(error, 'data', None)
    if data:
        # If we passed a custom message
        if 'message' in data:
            payload['message'] = data['message']
        # If we passed "errors"
        if 'errors' in data:
            payload['errors'] = data['errors']
        # If webargs added validation errors as "messages"
        # (you should use 'errors' as it is more explicit)
        elif 'messages' in data:
            payload['errors'] = data['messages']
        # If we passed additional headers
        if 'headers' in data:
            headers = data['headers']

    return payload


def handle_http_exception(error, prepare_func):
    log_info = True

    if not isinstance(error, HTTPException):
        error = InternalServerError()
        # Flask logs uncaught exceptions as ERROR already, no need to log here
        log_info = False

    headers = {}

    payload = prepare_func(error)

    # Log error as INFO, including payload content
    if log_info:
        log_string_content = [str(error.code), ]
        for key in ('message', 'errors'):
            if key in payload:
                log_string_content.append(str(payload[key]))
        current_app.logger.info(' '.join(log_string_content))

    return jsonify(payload), error.code, headers


# This is part of App.init_app method
    ...py

    for code in default_exceptions:
        # App may define prepare_error_response function as prepare_func above.
        # Same would go for prepare_success_response
        error_handler = partial(handle_http_exception, prepare_func=self.prepare_error_response)
        app.register_error_handler(code, handle_http_exception)


     @staticmethod
     def prepare_error_response():
           return error_handler.prepare_error

class ReworkApi(Api):

    @staticmethod
    def _prepare_error_reponse_content(error):

        headers = {}
        payload = {'status': str(error), 'type': 'error'}

        # Note: added <or getattr(error, 'description')> to get description from HTTPException
        data = getattr(error, 'data', None) or getattr(error, 'description')
        if data:
            if 'message' in data:
                payload['message'] = data['message']
            if 'errors' in data:
                payload['errors'] = data['errors']
            elif 'messages' in data:
                payload['errors'] = data['messages']
            if 'headers' in data:
                headers = data['headers']

        return payload, headers


class ReworkBlueprint(Blueprint):
    @staticmethod
    def _make_doc_response_schema(schema):
        if not schema:
            return

        class WrappingSchema(ma.Schema):
            type = ma.fields.String(required=True)
            data = ma.fields.Nested(schema)

        return WrappingSchema()

    @staticmethod
    def _make_response(data):
        data = {"type": "success", "data": data}
        return jsonify(data)

"""Api extension initialization

Override base classes here to allow painless customization in the future.
"""
import marshmallow as ma
import flask_smorest as flasksm
from flask import jsonify


class Blueprint(flasksm.Blueprint):
    """Blueprint override"""

    @staticmethod
    def _make_doc_response_schema(schema):
        if not schema:
            return

        class WrappingSchema(ma.Schema):
            type = ma.fields.String(required=True)
            data = ma.fields.Nested(schema)

        return WrappingSchema()

    @staticmethod
    def _make_response(data):
        data = {"type": "success", "data": data}
        return jsonify(data)


class Api(flasksm.Api):
    """Api override"""

    def __init__(self, app=None, *, spec_kwargs=None):
        super().__init__(app, spec_kwargs=spec_kwargs)

    @staticmethod
    def _prepare_error_reponse_content(error):

        headers = {}
        payload = {"status": str(error), "type": "error"}

        # Note: added <or getattr(error, 'description')> to get description from HTTPException
        data = getattr(error, "data", None) or getattr(error, "description")
        if data:
            if "message" in data:
                payload["message"] = data["message"]
            if "errors" in data:
                payload["errors"] = data["errors"]
            elif "messages" in data:
                payload["errors"] = data["messages"]
            if "headers" in data:
                headers = data["headers"]

        return payload, headers

        # Register custom Marshmallow fields in doc
        # self.register_field(CustomField, 'type', 'format')

        # Register custom Flask url parameter converters in doc
        # self.register_converter(CustomConverter, 'type', 'format')


class Schema(ma.Schema):
    """Schema override"""

class Blueprint(flasksm.Blueprint):
    """Blueprint override"""

    @staticmethod
    def _prepare_response_content(data):
        if data is not None:
            return {"data": data}
        return None


class Api(flasksm.Api):
    """Api override"""

    def __init__(self, app=None, *, spec_kwargs=None):
        super().__init__(app, spec_kwargs=spec_kwargs)


class Schema(ma.Schema):
    """Schema override"""