Starlette 源码阅读 (阶段总结一)

在前五篇中,笔者对applications.pyrouting.pyrequests.pyresponses.py进行了解读。了解到了从app进入,到endpoint返回responses的大致流程。本篇将对其内容进行总结,方便记忆。

applications.py

Starlette类

Starlette(
        debug: bool = False,
        # 用于设置在出现错误时是否应返回调试回溯
        routes: typing.Sequence[BaseRoute] = None,
        # 一个由BaseRoute衍生类实例组成列表,用于定义路由
        middleware: typing.Sequence[Middleware] = None,
        # 中间件列表,左外右内
        exception_handlers: typing.Dict[
            typing.Union[int, typing.Type[Exception]], typing.Callable
        ] = None,
        # 异常处理的字典,定义了一个状态码/异常类发生时,执行的处理函数
        # 格式应该为handler(request, exc) -> response
        on_startup: typing.Sequence[typing.Callable] = None,
        # 启动时的调用项列表
        on_shutdown: typing.Sequence[typing.Callable] = None,
        # 结束时的调用项列表
        lifespan: typing.Callable[["Starlette"], typing.AsyncGenerator] = None,
        # 前两者结合的生命周期函数,启动和结束项用一个yield分隔开
    )

def build_middleware_stack(self) -> ASGIApp
app构建时的方法,构建一个中间件堆栈,其返回值为ServerErrorMiddleware其app属性指向下一个中间件,一直串到最内层中间件ExceptionMiddleware,其app指向了router,即穿过了中间件层

async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None
app被调用时的方法,即入口。在这里将传过来的内容,传递给中间件层的最外层。

routing.py

Router类

Router(
        self,
        routes: typing.Sequence[BaseRoute] = None,
        # 路由列表
        redirect_slashes: bool = True,
        # 重定向斜杠
        default: ASGIApp = None,
        # 处理无法匹配项的最基础App
        on_startup: typing.Sequence[typing.Callable] = None,
        # 启动事件列表
        on_shutdown: typing.Sequence[typing.Callable] = None,
        # 结束事件列表
        lifespan: typing.Callable[[typing.Any], typing.AsyncGenerator] = None,
        # 上述两者的合并
) 

async def not_found(self, scope: Scope, receive: Receive, send: Send) -> None
当没有定义default时,默认的default为not_found

async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None
router的主入口进行路由的调度,重定向的分配,匹配失败的处理,以及可以执行lifespan

五个路由节点类

BaseRoutej基类,以及其四个衍生类

Route类

Route(
    path: str,
    # 路径
    endpoint: typing.Callable,
    # 路径对应的函数(使用者所写的那些)
    methods: typing.List[str] = None,
    # 支持的HTTP方法
    name: str = None,
    # 用于反向查找的名字
    include_in_schema: bool = True,
    # 暂时未知
)

def matches(self, scope: Scope) -> typing.Tuple[Match, Scope]
将router传过来的path与自身进行匹配

async def handle(self, scope: Scope, receive: Receive, send: Send) -> None
被router调用的函数,可以调用自己的app

WebSocketRoute类

WebSocketRoute(
    path: str, 
    endpoint: typing.Callable, 
    name: str = None
)

同上

Mount

用于实现子路由,其app还是一个router

    """
    例:
        Route('/', homepage),
        Mount('/users', routes=[
            Route('/', users),
            Route('/{username}', user)
        ])
    用于实现子路由, 他的app是一个router
    """
Mount(
    path: str,
    app: ASGIApp = None,
    routes: typing.Sequence[BaseRoute] = None,
    name: str = None,
) 

同上

Host

推测用于通过host匹配请求

Host(
    host: str,
    app: ASGIApp,
    name: str = None
)

同上

requests.py

Request类

request是使用者在endpoint中最能直接获得的信息,尤其其中的scope,是整个请求从app入口一路到endpoint的处理信息的记录

Request(
    scope: Scope,
    receive: Receive = empty_receive,
    send: Send = empty_send
)

https://www.starlette.io/requests/
关于request的详细方法,可以直接参考官方文档。

Response.py

Request类

Response(
    content: typing.Any = None,
    status_code: int = 200,
    headers: dict = None,
    media_type: str = None,
    background: BackgroundTask = None,
) 

def set_cookiedelete_cookie可以用于cookies的设置
async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None
Response也可以调用,调用时会开始发送response数据

其余Response类在此略

何为app

asgi接受的Starlette实例是个app,每个中间件都是个app,Router是个app,route里面也包含app,而其中包括endpoint封装成的app,或者像Mount的app又是个Router

那么究竟什么是app,什么算作app?

我觉得,所有接收(self, scope: Scope, receive: Receive, send: Send)参数的方法函数,都是app

app即可被其他app调用,也可以独立存在。他们都可以接收上述三个参数,并加以处理
每个app,都可能直接或间接包含一个app属性,用于将自己处理好的数据,传给下一个app。

Starlette实例app,它的app属性的值,是中间件堆栈最外层的app,它将三个方法传给堆栈最外层,而最外层中间件app,他的app属性,指向的是第二次app。最内层中间件app,指向了Router这个app,router中有许多route,每个route都有自己的app,router可以选择将数据传给那个route,而route的app,可能是由endpoint封装而成,代表流程以及接近终点,快返程了。也可能是一个子router,继续处理数据。

直到产生了response,response标志着返程的开始,“按app索骥”的路程才可能就此结束。
所以我们可以将app群组的职能对通常流程进行大体划分

Starlette实例app中间件堆栈app路由列表appendpoint封装app
注意:流程的终点不是endpoint,而是产生response

send与receive,究竟是在与谁通讯?

我猜测可能是ASGI服务器,也可能是直接发送给前端
这个需要在其他代码中寻找蛛丝马迹,或者等到了解ASGI服务器时,方可清晰理解。
当触发response的call中的send时starlette部分的工作才宣告结束

总结

简单的starlette流程在此已经解读完毕。但starlette是个强大的asgi工具包,源码解读的工作还远远没有结束。
下一章将开始进行其他次重要的模块源码解读。

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