How to register a customized http status code for flask?

Question

I want to add my own http status code to my Flask application. Here is my code:

from werkzeug import exceptions

class UnrecognizedParametersOrCombination(exceptions.HTTPException):
    code = 460
    description = 'The query parameters or their combination are not recognized!'


exceptions.default_exceptions[460] = UnrecognizedParametersOrCombination

But when I call abort(460), I got error: LookupError: no exception for 460

It seems I didn't correctly register the new exception to werkzeug default exceptions. The official document is quite blur on this part. How should I do this?

LoopsGod · Accepted Answer · 2019-06-10 16:44:32Z

1

You shouldn't be doing this, as you would break the RFCs associated with the HTTP status codes. HTTP status codes are supposed to be universal and not misused. I'd recommend responding some JSON, like "status": "460", if you want to use your own debugging codes, just don't use them as HTTP responses.

answered Jun 10, 2019 at 16:44

LoopsGod

3712 silver badges12 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

bieboebap Over a year ago

Why can't you have different RFC error codes? Not all of them are used. (I.e. 460 has no meaning that is still relevant: rfc-editor.org/info/rfc460)

Z.Wei · Accepted Answer · 2019-06-19 18:28:24Z

OK, I figured it out. According to the document: http://flask.pocoo.org/docs/1.0/errorhandling/ This is not doable. What we can do is to define an exception, and raise() it instead of abort() it. It seems now werkzeug doesn't support registering a customized http status code in its default exceptions any longer...

So now my working code is:

from werkzeug import exceptions

class UnrecognizedParametersOrCombination(exceptions.HTTPException):
    code = 460
    description = 'The query parameters or their combination are not recognized!'


def handle_460(e):
    return render_template('460.html')


app.register_error_handler(UnrecognizedParametersOrCombination, handle_460)

And now I need to use raise UnrecognizedParametersOrCombination() instead of abort(460) for responding. And so, the response is a 200 instead of a non-officially-supported 460.

Sharan Arumugam · Accepted Answer · 2019-06-10 16:00:35Z

0

Tried abort mapping?

abort.mappings[460] = UnrecognizedParametersOrCombination

answered Jun 10, 2019 at 16:00

Sharan Arumugam

3736 silver badges13 bronze badges

1 Comment

Z.Wei Over a year ago

Seems this api is not available any longer since 0.11

Collectives™ on Stack Overflow

How to register a customized http status code for flask?

3 Answers 3

1 Comment

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related