1. Python中的模块介绍与使用
在前面的几个章节中我们脚本上是用 python 解释器来编程,如果你从 Python 解释器退出再进入,那么你定义的所有的方法和变量就都消失了。
为此 Python 提供了一个办法,把这些定义存放在文件中,为一些脚本或者交互式的解释器实例使用,这个文件被称为模块。
模块是一个包含所有你定义的函数和变量的文件,其后缀名是.py。模块可以被别的程序引入,以使用该模块中的函数等功能。这也是使用 python 标准库的方法。
说的通俗点:模块就好比是工具包,要想使用这个工具包中的工具(就好比函数),就需要导入这个模块
1.1 import语句
想使用 Python 源文件,只需在另一个源文件里执行 import 语句,语法如下:
import module1[, module2[,... moduleN]
当解释器遇到 import 语句,如果模块在当前的搜索路径就会被导入。
搜索路径是一个解释器会先进行搜索的所有目录的列表。如想要导入模块 support,需要把命令放在脚本的顶端:
support.py 文件代码为:
#!/usr/bin/python3
# Filename: support.py
def print_func( par ):
print ("Hello : ", par)
return
在test.py中 引入 support 模块:
#!/usr/bin/python3
# Filename: test.py
# 导入模块
import support
# 现在可以调用模块里包含的函数了
support.print_func("Runoob")
输出结果:
$ python3 test.py
Hello : Runoob
support.print_func("Runoob")
模块名.函数名
为什么必须加上模块名调用呢?
因为可能存在这样一种情况:在多个模块中含有相同名称的函数,此时如果只是通过函数名来调用,解释器无法知道到底要调用哪个函数。所以如果像上述这样引入模块的时候,调用函数必须加上模块名
有时候我们只需要用到模块中的某个函数,只需要引入该函数即可,此时可以用下面方法实现:
from 模块名 import 函数名1,函数名2....
不仅可以引入函数,还可以引入一些全局变量、类等
注意:
●通过这种方式引入的时候,调用函数时只能给出函数名,不能给出模块名,但是当两个模块中含有相同名称函数的时候,后面一次引入会覆盖前一次引入。也就是说假如模块A中有函数function( ),在模块B中也有函数function( ),如果引入A中的function在先、B中的function在后,那么当调用function函数的时候,是去执行模块B中的function函数。
●如果想一次性引入math中所有的东西,还可以通过from math import * 来实现
1.2 from … import …
Python的from语句让你从模块中导入一个指定的部分到当前命名空间中,语法如下:
from modname import name1[, name2[, ... nameN]]
例如,要导入模块 fibo 的 fib 函数,使用如下语句:
>>> from fibo import fib, fib2
>>> fib(500)
1 1 2 3 5 8 13 21 34 55 89 144 233 377
注意:
这个声明不会把整个fibo模块导入到当前的命名空间中,它只会将fibo里的fib函数引入进来。
1.3 from … import *
把一个模块的所有内容全都导入到当前的命名空间也是可行的,只需使用如下声明:
from modname import *
注意:
• 这提供了一个简单的方法来导入一个模块中的所有项目。然而这种声明不该被过多地使用。
1.4 as
当调用的模块名和函数名过长时,可用 as 为前者重命名
格式如下:
import time as tt
tt.sleep()
from time import sleep as tt
1.5 定位模块
当你导入一个模块,Python解析器对模块位置的搜索顺序是:
1. 当前目录
2. 如果不在当前目录,Python则搜索在shell变量PYTHONPATH下的每个目录。
3. 如果都找不到,Python会察看默认路径。UNIX下,默认路径一般为/usr/local/lib/python/
4. 模块搜索路径存储在system模块的sys.path变量中。变量里包含当前目录,PYTHONPATH和由安装过程决定的默认目录。
2. 模块制作
2.1 定义自己的模块
在Python中,每个Python文件都可以作为一个模块,模块的名字就是文件的名字。
比如有这样一个文件test.py,在test.py中定义了函数add,如下:
def add(a,b):
return a+b
2.2 调用自己定义的模块
那么在其他文件中就可以先import test,然后通过test.add(a,b)来调用了,当然也可以通过from test import add来引入,如下是在main.py中引用模块test.py:
import test
result = test.add(11,22)
print(result)
2.3 测试模块
在实际开中,当一个开发人员编写完一个模块后,为了让模块能够在项目中达到想要的效果,这个开发人员会自行在py文件中添加一些测试信息,如下test.py:
def add(a,b):
return a+b
# 用来进行测试
ret = add(12,22)
print('int test.py file,,,,12+22=%d'%ret)
如果此时,在其他py文件中引入了此文件的话,想想看,测试的那段代码是否也会执行呢:
import test
result = test.add(11,22)
print(result)
至此,可发现test.py中的测试代码,应该是单独执行test.py文件时才应该执行的,不应该是其他的文件引用时执行的
为了解决这个问题,python在执行一个文件时有个变量__name__
总结:
• 可以根据__name__
变量的结果能够判断出,是直接执行的python脚本还是被引入执行的,从而能够有选择性的执行测试代码
• __name__
如果写在被直接运行的主文件中,是”__main__
”
• 如果写在被导入的文件中,运行主文件的时候,导入文件中的__name__
是”模块的名字”
3. 模块中的__all__
1.没有 __all__
2.有 __all__
总结:
• 如果一个文件中有all变量,那么也就意味着这个变量中的元素,不会被from xxx import *时导入
4. python中的包
4.1 引入包
若果有2个模块功能有些联系:
所以将其放到同一个文件夹下:
使用import 文件.模块
的方式导入:
使用from 文件夹 import 模块
的方式导入:
在msg文件夹下创建__init__.py
文件:
在__init__.py
文件中写入:
重新使用from 文件夹 import 模块
的方式导入
总结:
• 包将有联系的模块组织在一起,即放到同一个文件夹下,并且在这个文件夹创建一个名字为__init__.py
文件,那么这个文件夹就称之为包
• 有效避免模块名称冲突问题,让应用组织结构更加清晰
4.2 __init__.py
文件作用
__init__.py
控制着包的导入行为
4.2.1 当__init__.py
为空时
仅仅是把这个包导入,不会导入包中的模块
4.2.2 __all__
的作用
在__init__.py
文件中,定义一个__all__
变量,它控制着from 包名 import *
时导入的模块
4.2.3 (了解)可以在__init__.py
文件中编写内容
可以在这个文件中编写语句,当导入时,这些语句就会被执行
4.3 嵌套的包
假定我们的包的例子有如下的目录结构:
Phone/
__init__.py
common_util.py
Voicedta/
__init__.py
Pots.py
Isdn.py
Fax/
__init__.py
G3.py
Mobile/
__init__.py
Analog.py
igital.py
Pager/
__init__.py
Numeric.py
Phone 是最顶层的包,Voicedta 等是它的子包。 我们可以这样导入子包:
import Phone.Mobile.Analog
Phone.Mobile.Analog.dial()
你也可使用 from-import 实现不同需求的导入顶层的子包,然后使用属性/点操作符向下引用子包树,事实上,你可以一直沿子包的树状结构导入:
from Phone.Mobile.Analog import dial
dial('555-1212')
在我们上边的目录结构中,我们可以发现很多的__init__.py
文件。这些是初始化模块,from-import 语句
导入子包时需要用到它。 如果没有用到,他们可以是空文件。
包同样支持 from-import all 语句:
from package.module import *
然而,这样的语句会导入哪些文件取决于操作系统的文件系统。所以我们在__init__.py
中加入__all__
变量。该变量包含执行这样的语句时应该导入的模块的名字。它由一个模块名字符串列表组成.。
5. 模块发布
1.mymodule目录结构体如下:
.
├── setup.py
├── suba
│ ├── aa.py
│ ├── bb.py
│ └── __init__.py
└── subb
├── cc.py
├── dd.py
└── __init__.py
2.编辑 setup.py 文件
py_modules需指明所需包含的py文件
示例:
from distutils.core import setup
setup(name="yongGe", version="1.0", description="yongGe's module", author="yongGe", py_modules=['suba.aa', 'suba.bb', 'subb.cc', 'subb.dd'])
3.构建模块
与工作目录于当前模块目录,控制台键入:
python setup.py build
构建后目录结构:
.
├── build
│ └── lib.linux-i686-2.7
│ ├── suba
│ │ ├── aa.py
│ │ ├── bb.py
│ │ └── __init__.py
│ └── subb
│ ├── cc.py
│ ├── dd.py
│ └── __init__.py
├── setup.py
├── suba
│ ├── aa.py
│ ├── bb.py
│ └── __init__.py
└── subb
├── cc.py
├── dd.py
└── __init__.py
4.生成并发布压缩包
同上:
python setup.py sdist
打包后,生成最终发布压缩包yongGe-1.0.tar.gz , 目录结构如下:
.
├── build
│ └── lib.linux-i686-2.7
│ ├── suba
│ │ ├── aa.py
│ │ ├── bb.py
│ │ └── __init__.py
│ └── subb
│ ├── cc.py
│ ├── dd.py
│ └── __init__.py
├── dist
│ └── yongGe-1.0.tar.gz
├── MANIFEST
├── setup.py
├── suba
│ ├── aa.py
│ ├── bb.py
│ └── __init__.py
└── subb
├── cc.py
├── dd.py
└── __init__.py
6. 模块的安装与使用
6.1 安装
- 找到模块的压缩包
- 解压
- 进入文件夹
- 执行命令
python setup.py install
注意:
• 如果在install的时候,执行目录安装,可以使用python setup.py install --prefix=安装路径
6.2 模块引入
在程序中,使用from import 即可完成对安装的模块使用:
from 模块名 import 模块名或者*