python基础===monkeytype可以自动添加注释的模块！

Posted 2020-10-21 botoo

monkeytype 一个可以自动添加注释的模块！

 

先要下载：

pip install monkeytype

 

以官网的sample code为例

#moudle.py

def add(a, b):
    return a + b

这个test.py的文件会调用add（）方法

#test.py

from module import add

print(add(1, 2))

我们在cmd窗口执行如下命令：

monkeytype run test.py

程序执行完毕，可以看到返回了3

ok！重点来了，我们发现多了一个monkeytype.sqlite3文件。

官网解释是这样的：

By default this will dump call traces into a sqlite database in the file monkeytype.sqlite3 in the current working directory. You can then use the monkeytype command to generate a stub file for a module, or apply the type annotations directly to your code.

在cmd下执行命令：

monkeytype stub some.module

可以清楚的看到对a 和 b ，以及add方法的注释

应用注释到代码中：

monkeytype apply some.module

再看module.py文件：

代码已经自动打上注释了。

 

详细操作指南，参考：

http://monkeytype.readthedocs.io/en/latest/index.html#