【新开源报道 36】有效减少错误代码！Instagram 开源用于 Python 3 的 MonkeyType 工具

开源最前线（ID：OpenSourceTop） 猿妹 整编

综合自：https://engineering.instagram.com/let-your-code-type-hint-itself-introducing-open-source-monkeytype-a855c7284881、GitHub

Instagram 宣布将其 MonkeyType 工具开源。它是通过运行时跟踪类型自动将类型注释添加到您的 Python 3 代码的工具。

Python 3代码管理工具 MonkeyType

授权协议：BSD

开发语言：Python

操作系统：跨平台

项目地址：https://github.com/Instagram/MonkeyType

MonkeyType 简介

MonkeyType 是通过运行时跟踪类型自动将类型注释添加到您的 Python 3 代码的工具。

在 Instagram 上，有数百名工程师编译超过一百万行的代码在 Python 3上。在不同的生产环境中每天都在加入新的代码，所以 Instagram 一直在寻找一种新方法可以使代码更易于阅读和理解，并且更加适合静态分析，以此减少错误代码的频率。

MonkeyType 需要 Python 3.6+ 和 retype 库（用于施加型存根的代码的文件），只生成 Python 3 类型的注释（无类型注释）。Instagram 基础设施团队工程师 Carl Meyer 表示：在 MonkeyType 的帮助下，我们已经在代码库中对三分之一的功能进行了注释，而且我们已经看到了类型检查会捕获更多的错误。

使用入门

在 MonkeyType 告诉我们任何有用的东西之前，我们需要让它跟踪一些函数调用。最简单的方法是 monkeytype run 在 MonkeyType 跟踪下运行任何 Python 脚本。例如，您可以在 MonkeyType 下轻松运行您的测试套件：

当你的测试运行时，MonkeyType 检查每个函数调用的参数类型和返回/ yield类型，并将它们记录在数据库中。（默认情况下，它会根据这些数据生成存根文件，并可以使用retype将这些存根文件直接应用到您的代码中。）

当然，你的测试套件可能不提供最好的类型信息 - 有时候测试使用的是假类型，而不是真正的类型，我们发现很多情况下类型检查显示我们的测试意外地从生产中传入不同的类型。因此，如果您不想基于测试套件进行注释，则可以记录生产运行时的调用跟踪。对于这个用例，MonkeyType提供了一个上下文管理器API：

如果你需要更多的灵活性，你可以创建自己的 CallTracer，安装它 sys.setprofile()，并准备好时将其删除。

如何在 Instagram上使用MonkeyType

我们选择一个小的随机生产 Web 请求样本，并通过 Django 中间件打开 MonkeyType。使用自定义 CallTraceStore 从 SCUBA（Facebook的数据分析平台）存储和检索跟踪。因为不断地进行追踪，所以代码总是在更新的，生产代码频繁变化，这使我们的记录都是保持最新的那个。

每当工程师想要向模块添加类型注释时，他们只需运行 monkeytype stub，然后 monkeytype apply 修复新注释显示的任何错误类型，然后提交！

附：新开源报道汇总

---

●本文编号124，以后想阅读这篇文章直接输入124即可

●输入m获取文章目录

↓↓↓ 点击"阅读原文" 进入GitHub详情页