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

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

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

例如下面这个例子:

图片

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

但今天我在看icecream/builtins.py[1]源代码的时候,突然发现了一个高级用法,可以让我们使用工具函数的时候,就像使用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文件里面都可以直接通过注册的名字调用这个工具函数,就跟调用内置函数一样。

参考资料

[1] icecream/builtins.py: https://github.com/gruns/icecream/blob/master/icecream/builtins.py​

责任编辑:武晓燕 来源: 未闻Code
相关推荐

2024-02-20 22:13:48

Python项目Java

2021-09-13 20:38:47

Python链式调用

2021-03-12 21:19:15

Python链式调用

2021-07-27 21:32:57

Python 延迟调用

2024-07-30 08:16:18

Python代码工具

2024-07-30 08:11:16

2021-10-15 21:08:31

PandasExcel对象

2022-06-28 09:31:44

LinuxmacOS系统

2022-03-12 20:38:14

网页Python测试

2021-04-05 14:47:55

Python多线程事件监控

2024-11-13 09:18:09

2023-10-29 09:16:49

代码安全命令

2021-04-12 21:19:01

PythonMakefile项目

2021-04-27 22:15:02

Selenium浏览器爬虫

2020-05-19 13:55:38

Python加密密码

2023-10-28 12:14:35

爬虫JavaScriptObject

2021-06-08 21:36:24

PyCharm爬虫Scrapy

2022-01-26 07:35:10

爬虫Requestsgzip

2024-11-11 00:38:13

Mypy静态类型

2021-05-08 19:33:51

移除字符零宽
点赞
收藏

51CTO技术栈公众号