一日一技：如何让自己的工具函数在Python全局可用？

2022-06-20

我们在开发Python项目的时候，经常会写一些工具函数。为了在项目里面多个.py文件中使用这个工具函数，就不得不在多个地方都导入它，非常麻烦。

例如下面这个例子：

在A.py和C.py文件都要使用clean_msg这个工具函数，那么他们就都要从util.py中导入clean_msg。这似乎理所当然。

但今天我在看icecream/builtins.py源代码的时候，突然发现了一个高级用法，可以让我们使用工具函数的时候，就像使用Python的print函数一样，不用导入，而是直接使用。

我们先来看看效果：

大家注意A.py和C.py，我并没有导入clean_msg而是直接使用了这个函数。并且运行完全正常。

关键原理就在入口文件main.py，被我框住的3行：

import builtins

from util import clean_msg
setattr(builtins, 'clean_msg', clean_msg)

在Python里面，所有内置的函数或者类都在builtins模块中，因此在代码里面可以直接使用而不用导入。现在只需要把我们自定义的工具函数注册到builtins模块中，就能让它跟内置函数有相同的效果。

如果想把一个工具函数注册成为内置函数，只需要在入口文件中导入它，然后使用setattr把它设置成builtins模块的一个属性。第二个参数是你想全局调用的时候的名字，第三个参数就是你需要注册的工具函数。名字可以跟工具函数的名字不相同，只要不跟已有的内置函数重复就好了。

注册完成以后，在这个项目的整个运行时中，任何.py文件里面都可以直接通过注册的名字调用这个工具函数，就跟调用内置函数一样。

第一时间获取最新文章更新，请订阅我的微信公众号：未闻Code

Recommend