Flask 实现 Rest API (02) - 查询结果转换为 json 字符串

Rest API 以 json 格式对 Request 进行响应。结果集是如何转换成 json 呢?上一篇我们是这样做的:

# 首先得到一个 dict
items = [dict((curr.description[i][0], value) 
    for i, value in enumerate(row)) 
    for row in curr.fetchall()]

# 然后通过 flask 的 jsonify 转换成 json 格式
employees = emp.listAll()
return jsonify({'rows': employees}), 200;

这几句代码的信息量太大,我打算再用一篇文章来解释,顺便解决代码中存在的一个小问题。

获取字段名

Python DB-API 规定,cursor 对象的 description 属性应该返回一个序列 (sequence),这个序列包括下面的内容:

  • name
  • type_code
  • display_size
  • internal_size
  • precision
  • scale
  • null_ok

第一个元素的 name 就是我们要的 column name。据此,可以编写一个函数得到 column name:

import pymysql

def get_connection():
    db = pymysql.connect('localhost', 'root', 'pwd', 'stonetest')
    return db

def get_column_names(sql):
    conn = get_connection()
    cur = conn.cursor()
    cur.execute(sql)

    col_names = []
    column_count = len(cur.description)
    for i in range(column_count):
        desc = cur.description[i]
        col_names.append(desc[0])

    return col_names

col_names = get_column_names('select * from users;')
print (col_names)

写的这么啰嗦是为了解释 column name 是如何获得的。通过调试可以发现,cur.description 根据 resultset 的每一列,创建了一个 7-item 的元组 (tuple), name 处在 index 为 0 的位置。然后所有列的元组再组合成一个元组,如下图所示:

所以我们用上面的方法,得到列名的集合,以 list 类型返回。get_column_names 函数用的是常规的循环方法,其实 Python 提供了很好的机制,让我们可以大大简化代码。需要用到 enumerate 函数和列表推导式。先 两个相关相关知识做一个简单说明。

enumerate 函数

enurmerate函数是 Python 的内置函数,enurmerate 作用于序列或者迭代器 (iterator),返回一个新的迭代器,同时自动维护一个内部的计数器,从而简化循环的语句的编写。比如从 basic_colors 的列表中,遍历得到每一种颜色,为了循环,我们构造了一个计数器 i

basic_colors = ['red', 'green', 'blue']
for i in range(len(basic_colors)):
    print (i, basic_colors[i])

使用 enumerate 函数后,代码可以简化为:

basic_colors = ['red', 'green', 'blue']
for i, item in enumerate(basic_colors):
    print (i, item)

列表推导式

列表推导式提供了一种简明的方法来创建列表列表推导式在有些情况下特别方便,特别是当你需要使用 for 循环来生成一个新列表时。比如:

days = []
for i in range(1, 32):
    days.append(i)
print (days)

# output: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31]

可以使用列表推导式简化为:

days = [i for i in range(1, 32)]
print (days)

有了以上两个工具,get_column_names 函数可以简化为:

def get_column_names(sql):
    conn = get_connection()
    cur = conn.cursor()
    cur.execute(sql)

    column_names = [item[0] for counter, item in enumerate(cur.description) ]
    return column_names

现在应该理解了最刚开始的 items 语句:

items = [dict((curr.description[i][0], value) 
    for i, value in enumerate(row)) 
    for row in curr.fetchall()]

翻译一下,就是下面的代码:

def list_all():
    # ...

    rows = cur.fetchall()
    rows_list = []
    for row in rows:
        line_dict = dict()
        for i in range(len(row)):
            line_dict[cur.description[i][0]] = row[i]
        
        rows_list.append(line_dict)
    
    return rows_list

解决字段顺序问题

以上方法得到的 json 字符串,json 字符串中 key 的顺序与表中字段的顺序并不一致,原因有两点:

  • dictkey 是没有顺序的,dict 使用 key 来查找,所以输出的顺序随机;
  • flask 的 jsonfify() 方法在输出字段时,受 app.config['JSON_SORT_KEYS'] 控制,默认为 True,所以一般情况下 json 的输出是 key 的字母顺序输出的。jsonfiy() 方法会同时将 minetype 设置为 application/json

知道问题的所在,解决办法也很简单:

  • app.config['JSON_SORT_KEYS'] 设为 False
  • listAll() 方法中,返回值用 dict 的子类 OrderedDict。改写后的 listAll() 方法如下:
    def listAll(self):
        conn = db.connect()
        curr = conn.cursor()

        curr.callproc('getEmployees')

        col_names = [desc[0] for desc in curr.description]
        result = []
        for row in curr.fetchall():
            dict_obj = OrderedDict()
            for i, v in enumerate(row): # index, value
                dict_obj[col_names[i]] = v
            result.append(dict_obj)

        curr.close()
        conn.close()

        return result

References

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,588评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,456评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,146评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,387评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,481评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,510评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,522评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,296评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,745评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,039评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,202评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,901评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,538评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,165评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,415评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,081评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,085评论 2 352

推荐阅读更多精彩内容