开发者分享如何用Rust风格写Python代码
来源标题:Writing Python like it's Rust (2023)
一位拥有多年Rust经验的开发者提出,Rust的严格类型系统改变了他写Python的方式:从动态松散、无类型提示、到处传字典,转向追求API的"健全性",让错误用法难以出现。在Rust中错误使用接口通常会导致编译报错,而Python即便用错也能照常运行,可借助pyright或PyCharm等类型检查工具提前发现问题。
以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。
你可以查看这篇博客文章对应的 YouTube 演讲录像。几年前我开始用 Rust 编程,它逐渐改变了我用其他编程语言(尤其是 Python)设计程序的方式。在开始用 Rust 之前,我写 Python 代码的方式通常非常动态、类型松散,不用类型提示,到处传递和返回字典,偶尔还会退回到“字符串类型化”的接口。然而,在体验了 Rust 类型系统的严格性、并注意到它“在构造上”就能防止的所有问题之后,每当我回到 Python 却得不到同样的保证时,就会突然感到相当不安。
需要说明的是,这里的“保证”并不是指内存安全(Python 本身已经具备合理的内存安全性),而是指“健全性”——即设计出很难或根本不可能被误用的 API,从而防止未定义行为和各类 bug 的理念。在 Rust 中,错误使用接口通常会导致编译错误。在 Python 中,你仍然可以执行这样错误的程序,但如果你使用类型检查器(比如 pyright)或带有类型分析器的 IDE(比如 PyCharm),你仍然可以获得类似水平的、关于潜在问题的快速反馈。
最终,我开始在 Python 程序中采用一些来自 Rust 的概念。归根结底是两件事——尽可能使用类型提示,以及坚持那句老话:让非法状态不可表示。我尽量对需要长期维护的程序这样做,也对一次性工具脚本这样做。主要是因为根据我的经验,后者经常会变成前者 :) 在我看来,这种方法能让程序更容易理解和修改。
在这篇文章中,我会展示几个将这类模式应用于 Python 程序的例子。这算不上什么火箭科学,但我仍然觉得把它们记录下来可能有用。
注意:这篇文章包含很多关于编写 Python 代码的观点。我不想在每句话里都加上“恕我直言”,所以请把本文中的一切仅仅当作我对此事的看法,而不是试图推广某种普遍真理 :) 另外,我并不是说这里提出的想法都是在 Rust 中发明的,当然,它们也被用于其他语言。
首要的事情是尽可能使用类型提示,尤其是在函数签名和类属性中。当我读到这样一个函数签名时:
def find_item(records, check):
仅从签名本身,我完全不知道发生了什么。records 是列表、字典还是数据库连接?check 是布尔值还是函数?这个函数返回什么?如果失败会发生什么,是抛出异常还是返回 None?要找到这些问题的答案,我要么必须去读函数体(而且常常还要递归地去读它调用的其他函数体——这相当烦人),要么读它的文档(如果有的话)。文档可能包含关于函数做什么的有用信息,但不应该还需要用它来记录前面那些问题的答案。其中很多问题都可以由内置机制——类型提示——来回答。
def find_item( records: List[Item], check: Callable[[Item], bool] ) -> Optional[Item]:
写这个签名花了我更多时间吗?是的。这是个问题吗?不是,除非我的编码受限于每分钟写多少字符,而这实际上并不会发生。显式写出类型迫使我思考这个函数实际提供的接口是什么,以及我如何能让它尽可能严格,让调用者难以错误地使用它。有了上面的签名,我可以相当清楚地知道如何使用这个函数、传什么作为参数、以及可以预期它返回什么。此外,与文档注释不同——代码变化时文档注释很容易过时——当我改变了类型却没有更新函数的调用者时,类型检查器会冲我大喊1。而如果我对 Item 是什么感兴趣,我只需使用“转到定义”,就能立刻看到那个类型长什么样。
当然,在这方面我不是原教旨主义者,如果需要五个嵌套的类型提示才能描述一个参数,我通常会直接放弃,给它一个更简单但不精确的类型。根据我的经验,这种情况并不常发生。而如果真的发生了,它实际上可能标志着代码有问题——如果你的函数参数可以是数字、字符串元组或字符串到整数的字典映射,这可能是一个信号:你也许应该重构并简化它。
使用类型提示是一回事,但它仅仅描述了函数的接口是什么。第二步是实际让这些接口尽可能精确、“锁定”。一个典型的例子是从函数返回多个值(或单个复杂值)。懒惰而快速的做法是返回一个元组:
def find_person(...) -> Tuple[str, str, int]:
很好,我们知道要返回三个值。它们是什么?第一个字符串是这个人的名吗?第二个字符串是姓吗?那个数字是什么?是年龄吗?在某个列表中的位置吗?社会保障号吗?这种类型标注是不透明的,除非你查看函数体,否则你不知道这里发生了什么。
“改进”这一点的下一步可能是返回一个字典:
def find_person(...) -> Dict[str, Any]: ... return { "city": ..., "age": ... }
现在我们确实对返回的各个属性有了概念,但同样必须检查函数体才能得知。从某种意义上说,类型甚至变得更糟了,因为现在我们甚至不知道各个属性的数量和类型。此外,当这个函数发生变化、返回字典中的键被重命名或删除时,也没有简单的方法来找到
(原文较长,此处译出前 6000 字,完整内容请点「打开原文」。)
正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。