Implementing API exceptions in flask

在我們編寫Restful Api的時(shí)候,非常常見的是flask內(nèi)建的exception不夠用佳鳖,所以我們需要擴(kuò)展flask中的exception,從而滿足我們的定制化需求。

下面的代碼是一個(gè)簡單的定制exception的例子:

from flask import Flask
from flask import jsonify
app = Flask(__name__)

class InvalidUsage(Exception):
    status_code = 400

    def __init__(self, message, status_code = None, payload = None):
        Exception.__init__(self)
        self.message = message
        if status_code is not None:
            self.status_code = status_code
        self.payload = payload

    def to_dict(self):
        rv = dict(self.payload or ())
        rv['message'] = self.message
        return rv

@app.errorhandler(InvalidUsage)
def handle_invalid_useage(error):
    response = jsonify(error.to_dict())
    response.status_code = error.status_code
    return response

@app.route('/')
def hello_world():
    return 'Hello, World!'
@app.route('/errorpage')
def error_test():
    raise InvalidUsage('Error in this page', status_code = 401)

首先我們要import jsonify這個(gè)function恋昼,因?yàn)樵诜祷氐捻撁嬷行枰裡rror message以json的格式展示出來。之后我們需要構(gòu)建我們exception class赶促,InvalidUsage這個(gè)class繼承自Exception class液肌,在constructor中做一些error checking和參數(shù)的初始化。之后只有一個(gè)方法叫做to_dict()需要我們把message和payload轉(zhuǎn)換成dict的格式鸥滨,從而方便把它格式成json嗦哆。

在我們完成InvalidUsage class之后,理論上我們已經(jīng)用raise InvalidUsage了爵赵,但是我們還沒有在flask中注冊(cè)它吝秕,所以還需要注冊(cè)這個(gè)error handler。在flask中還是通過decorator來實(shí)現(xiàn)的空幻,用@app.errorhandler(InvalidUsage)注冊(cè)InvalidUsage烁峭,之后把json化的值賦和status_code賦值給response,然后我們就可以非常方便的使用InvalidUsage了秕铛。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末约郁,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子但两,更是在濱河造成了極大的恐慌鬓梅,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,084評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件谨湘,死亡現(xiàn)場(chǎng)離奇詭異绽快,居然都是意外死亡芥丧,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,623評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門坊罢,熙熙樓的掌柜王于貴愁眉苦臉地迎上來续担,“玉大人,你說我怎么就攤上這事活孩∥镉觯” “怎么了?”我有些...
    開封第一講書人閱讀 163,450評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵憾儒,是天一觀的道長询兴。 經(jīng)常有香客問我,道長起趾,這世上最難降的妖魔是什么诗舰? 我笑而不...
    開封第一講書人閱讀 58,322評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮阳掐,結(jié)果婚禮上始衅,老公的妹妹穿的比我還像新娘。我一直安慰自己缭保,他們只是感情好汛闸,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,370評(píng)論 6 390
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著艺骂,像睡著了一般诸老。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上钳恕,一...
    開封第一講書人閱讀 51,274評(píng)論 1 300
  • 那天别伏,我揣著相機(jī)與錄音,去河邊找鬼忧额。 笑死厘肮,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的睦番。 我是一名探鬼主播类茂,決...
    沈念sama閱讀 40,126評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼托嚣!你這毒婦竟也來了巩检?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,980評(píng)論 0 275
  • 序言:老撾萬榮一對(duì)情侶失蹤示启,失蹤者是張志新(化名)和其女友劉穎兢哭,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體夫嗓,經(jīng)...
    沈念sama閱讀 45,414評(píng)論 1 313
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡迟螺,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,599評(píng)論 3 334
  • 正文 我和宋清朗相戀三年冲秽,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片煮仇。...
    茶點(diǎn)故事閱讀 39,773評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡劳跃,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出浙垫,到底是詐尸還是另有隱情,我是刑警寧澤郑诺,帶...
    沈念sama閱讀 35,470評(píng)論 5 344
  • 正文 年R本政府宣布夹姥,位于F島的核電站,受9級(jí)特大地震影響辙诞,放射性物質(zhì)發(fā)生泄漏辙售。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,080評(píng)論 3 327
  • 文/蒙蒙 一飞涂、第九天 我趴在偏房一處隱蔽的房頂上張望旦部。 院中可真熱鬧,春花似錦较店、人聲如沸士八。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,713評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽婚度。三九已至,卻和暖如春官卡,著一層夾襖步出監(jiān)牢的瞬間蝗茁,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,852評(píng)論 1 269
  • 我被黑心中介騙來泰國打工寻咒, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留哮翘,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,865評(píng)論 2 370
  • 正文 我出身青樓毛秘,卻偏偏與公主長得像饭寺,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子熔脂,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,689評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理佩研,服務(wù)發(fā)現(xiàn),斷路器霞揉,智...
    卡卡羅2017閱讀 134,654評(píng)論 18 139
  • 22年12月更新:個(gè)人網(wǎng)站關(guān)停旬薯,如果仍舊對(duì)舊教程有興趣參考 Github 的markdown內(nèi)容[https://...
    tangyefei閱讀 35,181評(píng)論 22 257
  • 轉(zhuǎn)至元數(shù)據(jù)結(jié)尾創(chuàng)建: 董瀟偉,最新修改于: 十二月 23, 2016 轉(zhuǎn)至元數(shù)據(jù)起始第一章:isa和Class一....
    40c0490e5268閱讀 1,709評(píng)論 0 9
  • [TOC]一直想做源碼閱讀這件事适秩,總感覺難度太高時(shí)間太少绊序,可望不可見硕舆。最近正好時(shí)間充裕,決定試試做一下骤公,并記錄一下...
    何柯君閱讀 7,185評(píng)論 3 98
  • 難道你不好奇抚官,你身邊清冷擁擠,我都在這里 不說一句 別太充滿戾氣阶捆,別太消極情緒凌节。 愿你每一次抬頭都是溫暖的太陽,清...
    周游的野狗閱讀 277評(píng)論 0 0