Hello! 欢迎来到小浪资源网!



开源合作进展


开源合作进展

概述

最近,我在开发一个将 slack bolt 与 sanic 集成的项目时遇到了一个有趣的挑战,sanic 是一个我以前不熟悉的框架,这导致了一些意外的弃用警告和类型相关的问题。我将向您介绍我是如何解决这个问题的、我学到的经验教训以及解决问题的精确代码更改。

sanic 和 slack bolt 是什么?

萨尼奇

sanic 是一个 python 中的高性能、异步 web 框架。它被设计为快速,利用 python 的 asyncio 功能来有效地处理大量请求。其简约设计使其适用于轻量级 web 应用程序、微服务和 api 层。

松弛螺栓

slack bolt 是一个用于构建 slack 应用程序的框架。它抽象了 slack api 的复杂性,使开发人员能够专注于创建交互式和事件驱动的 slack 应用程序。使用 bolt,您可以轻松管理命令、快捷方式、事件等。

挑战

在实现集成时,我在运行测试和处理请求时遇到了一些与 sanic 的 Cookie 处理相关的警告。这是我看到的警告示例:

deprecationwarning: [deprecation] setting cookie values using the dict pattern has been deprecated. deprecationwarning: [deprecation] accessing cookies from the cookiejar by dict key is deprecated. typeerror: argument "path" to "add_cookie" of "basehttpresponse" has incompatible type "optional[any]"; expected "str" 

根本原因是使用了 sanic 旧的基于字典的 cookie 处理语法,从 sanic v23.3 开始不再推荐使用该语法。相反,必须使用新的 add_cookie 方法来确保兼容性并消除这些警告。

解决方案

关键的变化是用 add_cookie 方法替换基于字典的 cookie 处理,确保传递的所有 cookie 参数都是正确的类型。

这是更新后的代码片段:

# Iterate over cookies and add them using Sanic's add_cookie method for cookie in bolt_resp.cookies():     for key, c in cookie.items():         # Convert "expires" field if provided         expire_value = c.get("expires")         expires = datetime.strptime(expire_value, "%a, %d %b %Y %H:%M:%S %Z") if expire_value else None          # Convert "max-age" if provided         max_age = int(c["max-age"]) if c.get("max-age") else None          # Ensure values are of the correct type before passing to add_cookie         path = str(c.get("path")) if c.get("path") else "/"         domain = str(c.get("domain")) if c.get("domain") else None          # Add cookie with Sanic's add_cookie method         resp.add_cookie(             key=key,             value=c.value,             expires=expires,             path=path,             domain=domain,             max_age=max_age,             secure=True,             httponly=True,         )  

替换了基于字典的语法:旧方法依赖于使用 dict 语法直接操作 resp.cookies,该语法已被弃用。相反,我们使用 resp.add_cookie() 以向前兼容的方式设置 cookie。

确保正确的数据类型路径和域等参数有时为 none 或不是字符串。在将这些值传递给 add_cookie 之前,我们显式地将这些值转换为字符串或设置默认值(“/”表示路径,none 表示域)。

处理可选 cookie 字段: expires 被解析为日期时间对象(如果提供),使用格式“%a, %d %b %y %h:%m:%s %z”。
max-age 已转换为整数(如果可用)。

这些更改解决了所有警告和错误,确保集成遵循 sanic 的现代实践。

最后的想法

由于我之前没有使用 sanic 的经验,因此了解其文档至关重要。了解 sanic 如何处理 cookie 和请求帮助我认识到为什么旧语法有问题以及新的 add_cookie 方法如何工作。

将 slack bolt 与 sanic 集成是一项有益的挑战。它不仅提高了我对 sanic 的理解,而且还强调了了解最新框架最佳实践的重要性。如果您面临类似的问题,我希望这篇博文能够提供清晰的信息并帮助您更有效地解决问题。

相关阅读