Python源目录中的__init__.py
是什么?
除了将目录标记为Python包并定义__all__
, __init__.py
允许您在包级别定义任何变量。 如果程序包定义了将以类似于API的方式频繁导入的内容,则这样做通常很方便。 这种模式促进了对Pythonic的“扁平优于嵌套”哲学的坚持。
这是我的一个项目的示例,在该项目中,我经常导入一个名为Session
的sessionmaker
来与数据库进行交互。 我写了一个带有一些模块的“数据库”包:
database/
__init__.py
schema.py
insertions.py
queries.py
我的__init__.py
包含以下代码:
import os
from sqlalchemy.orm import sessionmaker
from sqlalchemy import create_engine
engine = create_engine(os.environ['DATABASE_URL'])
Session = sessionmaker(bind=engine)
由于我在此处定义Session
,因此可以使用以下语法开始新的会话。 此代码将从“数据库”包目录的内部或外部执行相同。
from database import Session
session = Session()
当然,这很方便-替代方法是在数据库包中的新文件(例如“ create_session.py”)中定义Session
,然后使用以下命令启动新的会话:
from database.create_session import Session
session = Session()
这里有一个非常有趣的reddit线程,涵盖了__init__.py
适当用法:
http://www.reddit.com/r/Python/comments/1bbbwk/whats_your_opinion_on_what_to_include_in_init_py/
大多数人似乎认为__init__.py
文件应该很薄,以避免违反“显式优于隐式”的哲学。
在Python中,包的定义非常简单。 像Java一样,层次结构和目录结构相同。 但是您必须在包中包含__init__.py
。 我将使用以下示例解释__init__.py
文件:
package_x/
|-- __init__.py
|-- subPackage_a/
|------ __init__.py
|------ module_m1.py
|-- subPackage_b/
|------ __init__.py
|------ module_n1.py
|------ module_n2.py
|------ module_n3.py
__init__.py
可以为空,只要它存在。 它指示该目录应视为一个包。 当然, __init__.py
也可以设置适当的内容。
如果我们在module_n1中添加一个函数:
def function_X():
print "function_X in module_n1"
return
运行后:
>>>from package_x.subPackage_b.module_n1 import function_X
>>>function_X()
function_X in module_n1
然后,我们遵循层次结构包,并将module_n1称为函数。 我们可以这样在subPackage_b中使用__init__.py
:
__all__ = ['module_n2', 'module_n3']
运行后:
>>>from package_x.subPackage_b import *
>>>module_n1.function_X()
Traceback (most recent call last):
File "", line 1, in
ImportError: No module named module_n1
因此,使用*导入,模块包受__init__.py
内容约束。
__init__.py
会将其所在的目录视为可加载模块。
对于喜欢阅读代码的人,我在这里添加了两位炼金术士的评论。
$ find /tmp/mydir/
/tmp/mydir/
/tmp/mydir//spam
/tmp/mydir//spam/__init__.py
/tmp/mydir//spam/module.py
$ cd ~
$ python
>>> import sys
>>> sys.path.insert(0, '/tmp/mydir')
>>> from spam import module
>>> module.myfun(3)
9
>>> exit()
$
$ rm /tmp/mydir/spam/__init__.py*
$
$ python
>>> import sys
>>> sys.path.insert(0, '/tmp/mydir')
>>> from spam import module
Traceback (most recent call last):
File "", line 1, in
ImportError: No module named spam
>>>
__init__.py
有两个主要原因
为方便起见:其他用户将不需要知道您的函数在包层次结构中的确切位置。
your_package/ __init__.py file1.py file2.py ... fileN.py
# in __init__.py from file1 import * from file2 import * ... from fileN import *
# in file1.py def add(): pass
然后其他人可以通过以下方式调用add()
from your_package import add
不知道file1,例如
from your_package.file1 import add
如果您想初始化一些东西; 例如,日志记录(应放在顶层):
import logging.config logging.config.dictConfig(Your_logging_config)
从Python 3.3开始,不再需要__init__.py
来将目录定义为可导入的Python包。
检查PEP 420:隐式命名空间包 :
对不需要
__init__.py
标记文件并且可以自动跨越多个路径段的软件包目录的本地支持(受PEP 420中所述的各种第三方方法的启发)
这是测试:
$ mkdir -p /tmp/test_init
$ touch /tmp/test_init/module.py /tmp/test_init/__init__.py
$ tree -at /tmp/test_init
/tmp/test_init
├── module.py
└── __init__.py
$ python3
>>> import sys
>>> sys.path.insert(0, '/tmp')
>>> from test_init import module
>>> import test_init.module
$ rm -f /tmp/test_init/__init__.py
$ tree -at /tmp/test_init
/tmp/test_init
└── module.py
$ python3
>>> import sys
>>> sys.path.insert(0, '/tmp')
>>> from test_init import module
>>> import test_init.module
参考资料:
https://docs.python.org/3/whatsnew/3.3.html#pep-420-implicit-namespace-packages
https://www.python.org/dev/peps/pep-0420/
Python 3中的软件包是否不需要__init__.py?
名为__init__.py
文件用于将磁盘上的目录标记为Python软件包目录。 如果您有文件
mydir/spam/__init__.py
mydir/spam/module.py
并且mydir
在您的路径上,您可以将module.py
的代码导入为
import spam.module
要么
from spam import module
如果删除__init__.py
文件,Python将不再在该目录中查找子模块,因此尝试导入该模块将失败。
__init__.py
文件通常为空,但可用于以更方便的名称导出包的选定部分,保留方便的函数等。给定上面的示例,可以按以下方式访问init模块的内容:
import spam
基于此
它曾经是软件包的必需部分( 旧的3.3之前的“常规软件包” ,而不是新的3.3+“命名空间软件包” )。
这是文档。
Python定义了两种类型的程序包,常规程序包和名称空间程序包。 常规软件包是Python 3.2及更早版本中存在的传统软件包。 常规软件包通常实现为包含
__init__.py
文件的目录。 导入常规程序包时,将隐式执行此__init__.py
文件,并将其定义的对象绑定到程序包名称空间中的名称。__init__.py
文件可以包含任何其他模块可以包含的相同Python代码,并且在导入时Python将向该模块添加一些其他属性。
但是只需单击链接,它包含一个示例,更多信息以及名称空间包的说明,即不带__init__.py
的包的类型。
它有助于导入其他python文件。 当您将此文件放置在包含其他py文件的目录中(例如,东西)时,可以执行诸如import stuff.other之类的操作。
root\
stuff\
other.py
morestuff\
another.py
如果在目录东西中没有这个__init__.py
,您将无法导入other.py,因为Python不知道东西的源代码在哪里,也无法将其识别为包。
__init__.py
文件使Python将包含它的目录视为模块。
此外,这是要在模块中加载的第一个文件,因此您可以使用它来执行每次加载模块时要运行的代码,或指定要导出的子模块。
尽管Python在没有__init__.py
文件的情况下仍可工作,但您仍应包含一个。
它指定应将程序包视为模块,因此将其包括在内(即使它为空)。
在某些情况下,您实际上可能会使用__init__.py
文件:
假设您具有以下文件结构:
main_methods
|- methods.py
而methods.py
包含以下内容:
def foo():
return 'foo'
要使用foo()
您将需要以下之一:
from main_methods.methods import foo # Call with foo()
from main_methods import methods # Call with methods.foo()
import main_methods.methods # Call with main_methods.methods.foo()
也许您需要(或想要)将methods.py
保留在main_methods
(例如,运行时/依赖项),但是您只想导入main_methods
。
如果将methods.py
的名称更改为__init__.py
则可以通过导入main_methods
来使用foo()
:
import main_methods
print(main_methods.foo()) # Prints 'foo'
之所以__init__.py
是因为__init__.py
被视为程序包的一部分。
一些Python软件包实际上是这样做的。 以JSON为例,其中运行import json
实际上是从json
包中导入__init__.py
. json
( 请参见此处的包文件结构 ):
源代码:
Lib/json/__init__.py
__init__.py
文件使导入变得容易。 当包中包含__init__.py
,可以从文件b.py
导入函数a()
, b.py
所示:
from b import a
但是,没有它,您将无法直接导入。 您必须修改系统路径:
import sys
sys.path.insert(0, 'path/to/b.py')
from b import a