Python Tips: __init__.py的作用
admin
2024-04-24 04:31:01
0

  我们经常在python的模块目录中会看到 "__init__.py"  这个文件,那么它到底有什么作用呢?

1. 标识该目录是一个python的模块包(module package)

  如果你是使用python的相关IDE来进行开发,那么如果目录中存在该文件,该目录就会被识别为 module package 。

2. 简化模块导入操作

  假设我们的模块包的目录结构如下:

.
└── mypackage├── subpackage_1│   ├── test11.py│   └── test12.py├── subpackage_2│   ├── test21.py│   └── test22.py└── subpackage_3├── test31.py└── test32.py

  如果我们使用最直接的导入方式,将整个文件拷贝到工程目录下,然后直接导入:

from mypackage.subpackage_1 import test11
from mypackage.subpackage_1 import test12
from mypackage.subpackage_2 import test21
from mypackage.subpackage_2 import test22
from mypackage.subpackage_3 import test31
from mypackage.subpackage_3 import test32

  当然这个例子里面文件比较少,如果模块比较大,目录比较深的话,可能自己都记不清该如何导入。(很有可能,哪怕只想导入一个模块都要在目录中找很久)

  这种情况下,__init__.py 就很有作用了。我们先来看看该文件是如何工作的。

2.1 __init__.py 是怎么工作的?

  实际上,如果目录中包含了 __init__.py 时,当用 import 导入该目录时,会执行 __init__.py 里面的代码。

  我们在mypackage目录下增加一个 __init__.py 文件来做一个实验:

.
└── mypackage├── __init__.py├── subpackage_1│   ├── test11.py│   └── test12.py├── subpackage_2│   ├── test21.py│   └── test22.py└── subpackage_3├── test31.py└── test32.py

  mypackage/__init__.py 里面加一个print,如果执行了该文件就会输出:

print("You have imported mypackage")

  下面直接用交互模式进行 import

>>> import mypackage
You have imported mypackage

  很显然,__init__.py 在包被导入时会被执行。

2.2  控制模块导入

  我们再做一个实验,在 mypackage/__init__.py 添加以下语句:

from subpackage_1 import test11

  我们导入 mypackage 试试:

>>> import mypackage
Traceback (most recent call last):File "", line 1, in File "/home/taopeng/Workspace/Test/mypackage/__init__.py", line 2, in from subpackage_1 import test11
ImportError: No module named 'subpackage_1'

  报错了。。。怎么回事?

  原来,在我们执行import时,当前目录是不会变的(就算是执行子目录的文件),还是需要完整的包名。

from mypackage.subpackage_1 import test11

  综上,我们可以在__init__.py 指定默认需要导入的模块  

2.3  偷懒的导入方法

  有时候我们在做导入时会偷懒,将包中的所有内容导入

from mypackage import *

  这是怎么实现的呢? __all__ 变量就是干这个工作的。

  __all__ 关联了一个模块列表,当执行 from xx import * 时,就会导入列表中的模块。我们将 __init__.py 修改为 。

__all__ = ['subpackage_1', 'subpackage_2']

  这里没有包含 subpackage_3,是为了证明 __all__ 起作用了,而不是导入了所有子目录。

>>> from mypackage import *
>>> dir()
['__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'subpackage_1', 'subpackage_2']
>>> 
>>> dir(subpackage_1)
['__doc__', '__loader__', '__name__', '__package__', '__path__', '__spec__']

  子目录的中的模块没有导入!!!

  该例子中的导入等价于

from mypackage import subpackage_1, subpackage_2

  因此,导入操作会继续查找 subpackage_1 和 subpackage_2 中的 __init__.py 并执行。(但是此时不会执行 import *

  我们在 subpackage_1 下添加 __init__.py 文件:

__all__ = ['test11', 'test12']# 默认只导入test11
from mypackage.subpackage_1 import test11

  再来导入试试

>>> from mypackage import *
>>> dir()
['__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'subpackage_1', 'subpackage_2']
>>> 
>>> dir(subpackage_1)
['__all__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', 'test11']

  如果想要导入子包的所有模块,则需要更精确指定。

>>> from mypackage.subpackage_1 import *
>>> dir()
['__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'test11', 'test12']

3. 配置模块的初始化操作

  在了解了 __init__.py 的工作原理后,应该能理解该文件就是一个正常的python代码文件。

  因此可以将初始化代码放入该文件中。

相关内容

热门资讯

开战机、盖皇宫,81岁的“坏孩... 全世界比拉里·埃里森更有钱的只有5个,像他这样的硅谷“坏孩子”却是唯一。文 | 华商韬略1944年,...
海南洋浦:渔船锚地翻扣 7人全... 中新网海南洋浦9月15日电 (符史祥)洋浦海上搜救分中心14日晚间通报,当日一艘渔船在洋浦港发生翻扣...
深圳明星独角兽,要IPO了 明... 一家深圳明星独角兽冲向港股。近日,飞骧科技申请在港上市。在清华校友龙华的带领下,这家已盈利的半导体公...
胜宏科技上周获融资资金买入超2... 一、证券市场回顾南财金融终端数据显示,上周(9月8日-9月12日,下同),上证综指周内上涨1.52%...
申万宏源最新研判:当前“长牛”... 21世纪经济报道记者 刘夏菲8月以来,A股持续冲高,沪指一度冲击3900点大关。进入9月,A股延续上...
科华数据:生产经营正常,无应披... 新京报贝壳财经讯 9月14日,科华数据发布关于股价异动的公告称,公司股票交易价格连续3个交易日收盘价...
西贝喊错冤 西贝喊错冤 西贝道... 来源 | 伯虎财经(bohuFN)作者 | 路费一夜之间,罗永浩、连锁餐饮品牌西贝莜面村(以下简称“...
独家|小牛电动创始人李一男再创... 蓝鲸新闻9月15日电,蓝鲸科技记者通过可靠信源获悉,小牛电动创始人、小牛电动前CEO、自游家创始人李...
十地挑起改革重担,助推中国经济... 本文来源:时代周报 作者:迟雨近日,国务院批准在10个地区开展要素市场化配置综合改革试点。试点名单包...
潮宏基向香港联交所递交H股发行... 新京报贝壳财经讯 9月14日,潮宏基发布公告称,公司已于2025年9月12日向香港联合交易所有限公司...