皮皮网

【巡更源码】【phpdos源码】【VRTSvcs源码】flask 源码

2024-12-27 15:54:52 来源:仿迷你世界源码

1.关于flask的jsonify与json.dumps的一些追溯和思考
2.在flask中使用jsonify和json.dumps的区别
3.Python Flask 开发,Flask 的 Swagger 神器 —— Flask-RESTX

flask 源码

关于flask的jsonify与json.dumps的一些追溯和思考

       有一天,我遇到了一个服务器报警问题,追踪错误栈时,发现是由于在使用 Flask 的 jsonify 函数时传入的字典中混入了 string 和 int 类型的键导致的。修改数据后,巡更源码我开始思考这一设计背后的逻辑以及为何会如此设定。源码追溯路径指向 JSONDecoder、flask.json.__init__.py 及 _dump_arg_defaults。分析这部分源码,我发现项目使用的是继承自 Flask 的 JSONDecoder,稍作修改以兼容如 bson.ObjectId 和 datetime 等数据类型,其主体基于标准库中的 JSONEncoder。

       进一步深入 JSONEncoder 的源码,我发现 sort_keys 的使用在 JSONEncoder._iterencode_dict 中。此时,我开始思考是否可以修改为始终使用默认的 False,以确保 key 为纯字符串。然而,官方为何没有选择这一方案?我开始在 GitHub 上寻找答案,最终在 issue 中找到了线索。phpdos源码在 Python 2 中确实如我所想,但在 Python 3 中,设计发生了改变。大佬们解释了背后的理由。

       深入思考后,我倾向于支持 Python 3 的设计选择。首先,明确数据处理逻辑(如是否排序)是至关重要的。这里,我认为 Flask 的VRTSvcs源码默认设置为 False 是个错误,应该与标准库保持一致。其次,确保数据类型的一致性是动态语言的局限性之一,这也是我越来越偏爱 Go 的原因。

       从工作角度来看,我得出以下思考:永远不要依赖传入的数据,务必进行验证,尤其是在关键业务中。这不仅是对 Flask 设计的反思,也是bill源码对编程实践的提醒,强调了数据验证和明确数据处理逻辑的重要性。

在flask中使用jsonify和json.dumps的区别

       1.Content-Type有区别

       jsonify的作用实际上就是将我们传入的json形式数据序列化成为json字符串,作为响应的body,并且设置响应的Content-Type为application/json,构造出响应返回至客户端。jsonify的部分源码如下:

       def jsonify(*args, **kwargs):

       if __debug__:

       _assert_have_json()

       return current_app.response_class(json.dumps(dict(*args, **kwargs),

       indent=None if request.is_xhr else 2), mimetype='application/json')

       å¯ä»¥çœ‹å‡ºjsonify实际上也是使用了json.dumps来序列化json形式的数据,作为响应正文返回。indent表示json格式化的缩进,若是Ajax请求则不缩进(因为一般Ajax数据没必要直接展示),否则缩进2格。但想必从第一部分的实验结果我们已经看出来了,使用jsonify时响应的Content-Type字段值为application/json,而使用json.dumps时该字段值为text/html。Content-Type决定了接收数据的一方如何看待数据,如何处理数据,如果是application/json,则可以直接当做json对象处理,若是text/html,则还要将文本对象转化为json对象再做处理(个人理解,有误请指正)。

       2.接受参数有区别

       jsonify可以接受和python中的dict构造器同样的参数,如下图。

       è€Œjson.dumps比jsonify可以多接受list类型和一些其他类型的参数。但我试了一下,形式为key1=value1,[key2=value2,...]这样的参数是不行的,会报出“TypeError: dumps() takes exactly 1 argument (0 given)”这一错误,而jsonify不会报错并能正常返回数据。

       æœ€åŽï¼Œæˆ‘们可以使用flask中的make_response方法或者直接通过Response类,通过设置mimetype参数来达到和使用jsonify差不多的效果,但少写点代码何乐而不为呢?况且简洁一点更不容易出错,参数越多调试和维护就越麻烦。当然,使用哪个并不是绝对的,必要时要根据前端的数据处理方式来决定。

Python Flask 开发,Flask 的 Swagger 神器 —— Flask-RESTX

       在构建Python Web应用时,Flask是一个轻量级的选择,它允许开发者以最小的投入快速搭建应用。而当涉及到构建RESTful API时,Flask-RESTX库提供了方便的方法来定义、编写和查看API文档。

       Flask-RESTX是Flask框架的扩展,集成Swagger,源码备案这是一个强大的API文档工具。Swagger规范和完整框架用于生成、描述、调用和可视化RESTfulWeb服务的API文档。

       安装Flask-RESTX很简单,通过pip命令即可完成。确保Flask已经在开发环境中安装,若未安装,使用相应命令进行安装。

       快速开始,创建简单Flask应用并引入Flask-RESTX。这里有个例子,实现一个简单的API,包含一个HelloWorld资源类,提供GET请求响应。使用@api.expect('name')装饰器指定期望参数。

       定义API文档时,使用装饰器和注解。文档自动出现在Swagger用户界面中。定义期望参数,使用api.expect装饰器。定义数据模型,使用api.model方法。模型可在API资源中使用。

       Flask-RESTX提供高级功能,例如异常处理、错误处理器等。通过Flask错误处理机制定义异常处理器,返回适当HTTP状态码和错误信息。

       Flask-RESTX的官方社区活跃在GitHub上,提供源代码和问题跟踪器。社区成员分享使用经验和最佳实践,解决遇到问题。

       总结,Flask-RESTX是Flask框架的强大扩展,集成Swagger提供丰富的API文档支持,易于设计、实现和维护RESTfulAPI。无论是初学者还是有经验的开发者,都能从Flask-RESTX的易用性和强大功能中受益。

       通过本文了解,已具备构建Flask应用的基础知识。实践是学习的最好方式,动手尝试,创建自己的Flask应用吧!