什么是package?
Python文件要么是脚本(script),要么是模块(module)。这取决于文件的使用方式。 如果python文件当作模块使用,模块名和文件名同名。
如果直接运行python文件,则称为运行一个python脚本。如果在另一个python文件里import这个文件或者这个文件里的方法,对象,或者class等,则此时称之为模块。
1.脚本(script)
直接运行下面的脚本a.py
#!/usr/bin/python
# -*- coding: utf-8 -*-
if __name__ == '__main__':
print 'ok'
在上面脚目录下运行该文件
python a.py
输出是
'ok'
上面被运行的python文件就是一个脚本,a.py作为python程序的参数传入,则其中的__name__
被赋值成一个'__main__'
字符串,从而会执行if
下面的语句。
2. 模块(module)
当在该文件中加入函数,class或者对象时,这些函数,class或者对象可以被其他的脚本引用,从而该文件就是一个module,mudule与文件名同名。
#!/usr/bin/python
# -*- coding: utf-8 -*-
#filename: a.py
def sub(x, y):
return x-y
if __name__ == '__main__':
print 'ok'
In Command Line
from a import sub
sub(2,1)
输出下面的值
1
在上面的代码中,a.py被当成了模块使用,引用了模块中的sub(x, y)方法。注意到if
语句的 print 'ok'
并没有被执行,原因是当作为module引用是,该上下文环境的__name__
并没有被赋值成'__main__'
字符串。
从上面的使用方法看,模块是功能的集合,或者说是function, class和variable的集合,这些都可以被其他脚本引用,因此,模块一般作为一个功能集合。如果一个文件是模块,通常,他就不会是程序入口。因此不需要定义if __name__ == '__main__': pass
,除非你需要在其中加入测试代码(可以使用单元测试)
2. 包(package)
当你需要写一个比较复杂的framework,例如一个ORM包,这时候会包含大量的逻辑模块,如果将这些逻辑全部写在一个文件中并不现实,难以管理。因此,将多个module作为一个整体进行管理是非常有必要的。如果我们在使用一个模块时,可以安装,可以类似from package import module
或者from package.module import *
引入需要的资源,则非常方便。
类似文件名对应于Module名称, 路径名对应于pakage名称。为了区别路径和package,定义一个包只需要创建一个init.py文件,如果没有初始化的任务,文件可以是空文件。
下面列出的是一个package的路径
.
└── test1
├── init.py
├── a.py
└── b.py
#!/usr/bin/python
# -*- coding: utf-8 -*-
#File Name: __init__.py
#Nothing here
#!/usr/bin/python
# -*- coding: utf-8 -*-
#File Name: b.py
def add(x, y):
return x+y
#!/usr/bin/python
# -*- coding: utf-8 -*-
#File Name: a.py
def sub(x, y):
return x-y
if __name__ == '__main__':
print 'ok'
该package的名称是test1, 从中可以引用a和b模块
>>> import test1
>>> from test1 import a
>>> a
<module 'test1.a' from 'test1/a.py'>
>>> a.sub(2,1)
1
>>> from test1.b import add
>>> add(1,2)
3
注意上面的代码,可以从test1 package中引用模块a, 然后调用模块a中的函数a.sub(2,1)
, 也可以使用.
的形式引用package下面的module,例如 from test1.b import add
。
很多情况下,这样引用module里的资源比较麻烦,如果直接能从test1模块中引用add或者sub就很方便。python通过在__init__.py
中使用import
语句的方式,引入模块中的函数,类或者变量,从而可以从package的顶级进行访问。
例如,如下修改上面的__init__.py
文件
#!/usr/bin/python
# -*- coding: utf-8 -*-
#File Name: __init__.py
from a import sub
在test1同级别目录运行python和下面的代码
>>> from test1 import *
>>> sub(2,1)
1
>>> add(1,2)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
NameError: name 'add' is not defined
>>>
可以看出,引用了pacakge test1中所有资源后(from test1 import *
), 可以直接调用sub(x, y),该函数在a.py中定义。而add(x, y)则不可以直接访问,需要通过b.add(1, 2)
才能访问,否则你需要在你的客户端代码中使用from test1.b import add
总结
- 包(package/library)是模块的集合,模块是function,class, 和variable的集合.
- 模块和script之间没有明确的界限,模块也可以直接运行,无论通过
python -m <module_name> <args>
的模式还是通过python <file_name.py>
的方式。
注意
无论是script还是模块都是都可以被直接执行的
script:
python <file_name.py>
module被当作脚本执行
python -m <module_name> <args>
关键词
- package (包)
- __init__.py
- module (模块)
- python script
- 路径
- import
- python -m
网友评论