flask 源码解析:请求

2024-09-02 12:58
文章标签 源码 请求 解析 flask

本文主要是介绍flask 源码解析:请求,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

转载于:http://cizixs.com/2017/01/18/flask-insight-request

简介

对于物理链路来说,请求只是不同电压信号,它根本不知道也不需要知道请求格式和内容到底是怎样的; 对于 TCP 层来说,请求就是传输的数据(二进制的数据流),它只要发送给对应的应用程序就行了; 对于 HTTP 层的服务器来说,请求必须是符合 HTTP 协议的内容; 对于 WSGI server 来说,请求又变成了文件流,它要读取其中的内容,把 HTTP 请求包含的各种信息保存到一个字典中,调用 WSGI app; 对于 flask app 来说,请求就是一个对象,当需要某些信息的时候,只需要读取该对象的属性或者方法就行了。

可以看到,虽然是同样的请求数据,在不同的阶段和不同组件看来,是完全不同的形式。因为每个组件都有它本身的目的和功能,这和生活中的事情一个道理:对于同样的事情,不同的人或者同一个人不同人生阶段的理解是不一样的。

这篇文章呢,我们只考虑最后一个内容,flask 怎么看待请求。

请求

我们知道要访问 flask 的请求对象非常简单,只需要 from flask import request

from flask import requestwith app.request_context(environ):assert request.method == 'POST'

前面一篇文章 已经介绍了这个神奇的变量是怎么工作的,它最后对应了 flask.wrappers:Request 类的对象。 这个类内部的实现虽然我们还不清楚,但是我们知道它接受 WSGI server 传递过来的 environ 字典变量,并提供了很多常用的属性和方法可以使用,比如请求的 method、path、args 等。 请求还有一个不那么明显的特性——它不能被应用修改,应用只能读取请求的数据。

这个类的定义很简单,它继承了 werkzeug.wrappers:Request,然后添加了一些属性,这些属性和 flask 的逻辑有关,比如 view_args、blueprint、json 处理等。它的代码如下:

from werkzeug.wrappers import Request as RequestBaseclass Request(RequestBase):"""The request object is a :class:`~werkzeug.wrappers.Request` subclass andprovides all of the attributes Werkzeug defines plus a few Flaskspecific ones."""#: The internal URL rule that matched the request.  This can be#: useful to inspect which methods are allowed for the URL from#: a before/after handler (``request.url_rule.methods``) etc.url_rule = None#: A dict of view arguments that matched the request.  If an exception#: happened when matching, this will be ``None``.view_args = None    @propertydef max_content_length(self):"""Read-only view of the ``MAX_CONTENT_LENGTH`` config key."""ctx = _request_ctx_stack.topif ctx is not None:return ctx.app.config['MAX_CONTENT_LENGTH']    @propertydef endpoint(self):"""The endpoint that matched the request.  This in combination with:attr:`view_args` can be used to reconstruct the same or amodified URL.  If an exception happened when matching, this willbe ``None``."""if self.url_rule is not None:return self.url_rule.endpoint    @propertydef blueprint(self):"""The name of the current blueprint"""if self.url_rule and '.' in self.url_rule.endpoint:return self.url_rule.endpoint.rsplit('.', 1)[0]    @propertydef is_json(self):mt = self.mimetypeif mt == 'application/json':return Trueif mt.startswith('application/') and mt.endswith('+json'):return Truereturn False

这段代码没有什难理解的地方,唯一需要说明的就是 @property 装饰符能够把类的方法变成属性,这是 python 中经常见到的用法。

接着我们就要看 werkzeug.wrappers:Request

class Request(BaseRequest, AcceptMixin, ETagRequestMixin,UserAgentMixin, AuthorizationMixin,CommonRequestDescriptorsMixin):"""Full featured request object implementing the following mixins:- :class:`AcceptMixin` for accept header parsing- :class:`ETagRequestMixin` for etag and cache control handling- :class:`UserAgentMixin` for user agent introspection- :class:`AuthorizationMixin` for http auth handling- :class:`CommonRequestDescriptorsMixin` for common headers"""

这个方法有一点比较特殊,它没有任何的 body。但是有多个基类,第一个是 BaseRequest,其他的都是各种 Mixin。 这里要讲一下 Mixin 机制,这是 python 多继承的一种方式,如果你希望某个类可以自行组合它的特性(比如这里的情况),或者希望某个特性用在多个类中,就可以使用 Mixin。 如果我们只需要能处理各种 Accept 头部的请求,可以这样做:

class Request(BaseRequest, AcceptMixin)pass

但是不要滥用 Mixin,在大多数情况下子类继承了父类,然后实现需要的逻辑就能满足需求。

我们先来看看 BaseRequest:

class BaseRequest(object):def __init__(self, environ, populate_request=True, shallow=False):self.environ = environif populate_request and not shallow:self.environ['werkzeug.request'] = selfself.shallow = shallow

能看到实例化需要的唯一变量是 environ,它只是简单地把变量保存下来,并没有做进一步的处理。Request 的内容很多,其中相当一部分是被 @cached_property 装饰的方法,比如下面这种:

    @cached_propertydef args(self):"""The parsed URL parameters."""return url_decode(wsgi_get_bytes(self.environ.get('QUERY_STRING', '')),self.url_charset, errors=self.encoding_errors,cls=self.parameter_storage_class)    @cached_propertydef stream(self):"""The stream to read incoming data from.  Unlike :attr:`input_stream`this stream is properly guarded that you can't accidentally read pastthe length of the input.  Werkzeug will internally always refer tothis stream to read data which makes it possible to wrap thisobject with a stream that does filtering."""_assert_not_shallow(self)return get_input_stream(self.environ)    @cached_propertydef form(self):"""The form parameters."""self._load_form_data()return self.form    @cached_propertydef cookies(self):"""Read only access to the retrieved cookie values as dictionary."""return parse_cookie(self.environ, self.charset,self.encoding_errors,cls=self.dict_storage_class)    @cached_propertydef headers(self):"""The headers from the WSGI environ as immutable:class:`~werkzeug.datastructures.EnvironHeaders`."""return EnvironHeaders(self.environ)

@cached_property 从名字就能看出来,它是 @property 的升级版,添加了缓存功能。我们知道 @property 能把某个方法转换成属性,每次访问属性的时候,它都会执行底层的方法作为结果返回。 @cached_property 也一样,区别是只有第一次访问的时候才会调用底层的方法,后续的方法会直接使用之前返回的值。 那么它是如何实现的呢?我们能在 werkzeug.utils 找到它的定义:

class cached_property(property):"""A decorator that converts a function into a lazy property.  Thefunction wrapped is called the first time to retrieve the resultand then that calculated result is used the next time you accessthe value.The class has to have a `__dict__` in order for this property towork."""# implementation detail: A subclass of python's builtin property# decorator, we override __get__ to check for a cached value. If one# choses to invoke __get__ by hand the property will still work as# expected because the lookup logic is replicated in __get__ for# manual invocation.def __init__(self, func, name=None, doc=None):self.__name__ = name or func.__name__self.__module__ = func.__module__self.__doc__ = doc or func.__doc__self.func = funcdef __set__(self, obj, value):obj.__dict__[self.__name__] = valuedef __get__(self, obj, type=None):if obj is None:return selfvalue = obj.__dict__.get(self.__name__, _missing)if value is _missing:value = self.func(obj)obj.__dict__[self.__name__] = valuereturn value

这个装饰器同时也是实现了 __set__ 和 __get__ 方法的描述器。 访问它装饰的属性,就会调用 __get__ 方法,这个方法先在 obj.__dict__ 中寻找是否已经存在对应的值。如果存在,就直接返回;如果不存在,调用底层的函数 self.func,并把得到的值保存起来,再返回。这也是它能实现缓存的原因:因为它会把函数的值作为属性保存到对象中。

关于 Request 内部各种属性的实现,就不分析了,因为它们每个具体的实现都不太一样,也不复杂,无外乎对 environ 字典中某些字段做一些处理和计算。 接下来回过头来看看 Mixin,这里只用 AcceptMixin 作为例子:

class AcceptMixin(object):    @cached_propertydef accept_mimetypes(self):return parse_accept_header(self.environ.get('HTTP_ACCEPT'), MIMEAccept)    @cached_propertydef accept_charsets(self):return parse_accept_header(self.environ.get('HTTP_ACCEPT_CHARSET'),CharsetAccept)    @cached_propertydef accept_encodings(self):return parse_accept_header(self.environ.get('HTTP_ACCEPT_ENCODING'))    @cached_propertydef accept_languages(self):return parse_accept_header(self.environ.get('HTTP_ACCEPT_LANGUAGE'),LanguageAccept)

AcceptMixin 实现了请求内容协商的部分,比如请求接受的语言、编码格式、相应内容等。 它也是定义了很多 @cached_property 方法,虽然自己没有 __init__ 方法,但是也直接使用了 self.environ,因此它并不能直接使用,只能和 BaseRequest 一起出现。

参考资料

  • Flask official docs

这篇关于flask 源码解析:请求的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1130015

相关文章

深度解析Python yfinance的核心功能和高级用法

《深度解析Pythonyfinance的核心功能和高级用法》yfinance是一个功能强大且易于使用的Python库,用于从YahooFinance获取金融数据,本教程将深入探讨yfinance的核... 目录yfinance 深度解析教程 (python)1. 简介与安装1.1 什么是 yfinance?

Python Flask实现定时任务的不同方法详解

《PythonFlask实现定时任务的不同方法详解》在Flask中实现定时任务,最常用的方法是使用APScheduler库,本文将提供一个完整的解决方案,有需要的小伙伴可以跟随小编一起学习一下... 目录完js整实现方案代码解释1. 依赖安装2. 核心组件3. 任务类型4. 任务管理5. 持久化存储生产环境

99%的人都选错了! 路由器WiFi双频合一还是分开好的专业解析与适用场景探讨

《99%的人都选错了!路由器WiFi双频合一还是分开好的专业解析与适用场景探讨》关于双频路由器的“双频合一”与“分开使用”两种模式,用户往往存在诸多疑问,本文将从多个维度深入探讨这两种模式的优缺点,... 在如今“没有WiFi就等于与世隔绝”的时代,越来越多家庭、办公室都开始配置双频无线路由器。但你有没有注

Python中的sort()和sorted()用法示例解析

《Python中的sort()和sorted()用法示例解析》本文给大家介绍Python中list.sort()和sorted()的使用区别,详细介绍其参数功能及Timsort排序算法特性,涵盖自适应... 目录一、list.sort()参数说明常用内置函数基本用法示例自定义函数示例lambda表达式示例o

Python用Flask封装API及调用详解

《Python用Flask封装API及调用详解》本文介绍Flask的优势(轻量、灵活、易扩展),对比GET/POST表单/JSON请求方式,涵盖错误处理、开发建议及生产环境部署注意事项... 目录一、Flask的优势一、基础设置二、GET请求方式服务端代码客户端调用三、POST表单方式服务端代码客户端调用四

SpringBoot加载profile全面解析

《SpringBoot加载profile全面解析》SpringBoot的Profile机制通过多配置文件和注解实现环境隔离,支持开发、测试、生产等不同环境的灵活配置切换,无需修改代码,关键点包括配置文... 目录题目详细答案什么是 Profile配置 Profile使用application-{profil

MySQL的触发器全解析(创建、查看触发器)

《MySQL的触发器全解析(创建、查看触发器)》MySQL触发器是与表关联的存储程序,当INSERT/UPDATE/DELETE事件发生时自动执行,用于维护数据一致性、日志记录和校验,优点包括自动执行... 目录触发器的概念:创建触www.chinasem.cn发器:查看触发器:查看当前数据库的所有触发器的定

Java中的volatile关键字多方面解析

《Java中的volatile关键字多方面解析》volatile用于保证多线程变量可见性与禁止重排序,适用于状态标志、单例模式等场景,但不保证原子性,相较synchronized更轻量,但需谨慎使用以... 目录1. volatile的作用1.1 保证可见性1.2 禁止指令重排序2. volatile的使用

Python lambda函数(匿名函数)、参数类型与递归全解析

《Pythonlambda函数(匿名函数)、参数类型与递归全解析》本文详解Python中lambda匿名函数、灵活参数类型和递归函数三大进阶特性,分别介绍其定义、应用场景及注意事项,助力编写简洁高效... 目录一、lambda 匿名函数:简洁的单行函数1. lambda 的定义与基本用法2. lambda

深入解析Java NIO在高并发场景下的性能优化实践指南

《深入解析JavaNIO在高并发场景下的性能优化实践指南》随着互联网业务不断演进,对高并发、低延时网络服务的需求日益增长,本文将深入解析JavaNIO在高并发场景下的性能优化方法,希望对大家有所帮助... 目录简介一、技术背景与应用场景二、核心原理深入分析2.1 Selector多路复用2.2 Buffer