4. 模块

发表于 | 分类于

模块

在计算机程序的开发过程中，随着程序代码越来越多，在一个文件里代码就会越来越长，越来越不容易维护。

为了编写可维护的代码，我们可以把很多函数分组，分别放到不同的文件里，这样，每个文件包含的代码就越来越少，很多编程语言都采用这种组织代码的方式。在Python中，一个.py文件就称之为一个模块。

使用模块的好处在哪里？

最大的好处是大大提高了代码的可维护性，其次，编写代码不用从零开始。当一个模块编写完毕，就可以被其他地方引用。我们在编写程序的时候，也经常引用其他模块，包括Python内置的模块和来自第三方的模块。

使用模块还可以避免函数名和变量名冲突。相同名字的函数和变量完全可以分别存在不同的模块中，因此，我们在编写模块时，不必考虑名字会和其他模块冲突。但是也要注意，尽量不要与内置函数名字冲突。Python的内置函数在这里： [https://docs.python.org/3/library/functions.html]

同时，为了避免模块名冲突，Python又引入了按目录来组织模块的方法，称为包(Package)。

例如，一个abc.py的文件就是一个名字叫abc的模块，一个xyz.py的文件就是一个名字叫xyz的模块。现在我们假设abc和xyz这两个模块名字与其他模块冲突了，于是我们通过包来组织模块，避免冲突。方法是选择一个顶层包名，比如mycompany，按照如下目录来存放：
Alt text
引入了包之后，只要顶层的包名不与别人冲突，那所有模块都不会与别人冲突。现在，abc.py模块的名字就变为了mycompany.abc。请注意，在每一个包目录下面都会有一个__init__.py的文件，这个文件是必须存在的，否则，Python就把这个目录当做普通目录，而不是一个包。__init__.py可以是空文件也可以有Python代码，因为其本身就是一个模块，其模块名为mycompany。

类似的，可以有多级目录，组成多级层次的包结构，比如：
Alt text
文件www.py的模块名就是mycompany.web.www，两个文件utils.py的模块名分比为mycompany.utils和mycompany.web.utils。

自己创建模块时要注意命名，不能喝Python自带的模块名称冲突。例如，系统自带了sys模块，自己模块就不可命名为sys.py，否则就无法导入系统自带的sys模块。mycompany.web也是一个模块，对应的文件为__init__.py。

使用模块

Python本身就内置了很多非常有用的模块，只要安装完毕，这些模块就可以立即使用。

我们以内建的sys模块为例，编写一个hello的模块：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
#!/usr/bin/env python3
#-*- coding: utf-8 -*-
'a test module'
__author__='cdx'
import sys
def test():
	args=sys.argv
	if len(args)==1:
		print('Hello,world!')
	elif len(args==2):
		print('Hello,%s!' %args[1])
	else:
		print('too many arguments!')
if __name__=='__main__':
	test()

第一行和第二行是标准注释，第一行注释可以让这个hello.py文件直接在Unix/Linux/Mac上运行，第二行注释表示.py文件本身使用标准的UTF-8编码。
第四行是一个字符串，表示模块的文档注释，任何模块代码的第一个字符串都被视为模块的文档注释；第六行使用__author__变量把作者写进去，开源后可以查看作者姓名。签名都是一些标准写法，虽然可以不写，但是按照标准是没有任何问题的。

使用sys的第一步是导入该模块：

import sys

导入该模块后，我们就有了变量sys指向该模块，利用sys这个变量，就可以访问sys模块的所有功能。sys模块有一个argv变量，用list存储了命令行的所有参数。argv至少有一个元素，因为第一个参数永远是该.py文件的名称，例如：

运行python hello.py获得的sys.argv就是['hello.py','cdx']。

最后注意到这两行代码：

if name==’main‘:
test()

当我们在命令行运行hello模块文件时，Python解释器把一个特殊变量__name__置为__main__，而如果在其他地方导入该hello模块时，if判断将失败，因此这种if测试可以让一个模块通过命令行运行时执行一些额外的代码，最常见的就是运行测试。

我们可以通过命令行运行hello.py看看效果：

1
2
D:\笔记\Python\Notepad++>python hello.py
Hello,world!

如果进入Python交互换将，再导入hello模块：

1
2
3
4
5
Python 3.5.0 (v3.5.0:374f501f4567, Sep 13 2015, 02:27:37) [MSC v.1900 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import hello
>>> hello.test()
Hello,world!

导入时，没有打印Hello,world!，因为没有执行test()函数，调用Hello,world!时就会打印了。

作用域

在一个模块中，我们会定义很多函数和变量，但有的函数和变量我们希望给别人使用，有的函数和变量我们希望仅仅在模块内部使用。在Python中，是通过前缀_来实现的。

正常函数和变量名是公开的public，可以被直接引用，比如：abc,x123,PI等。

类似__xxx__这样的变量是特殊变量，可以别直接引用，但是有特殊用途，比如上面的__author__，__name__就是特殊变量，hello模块定义的文档注释也可以用特殊变量__doc__来访问，我们自己的变量一般不要用这种变量名；

类似_xxx和__xxx这种函数或变量就是非公开的private，不应该被直接引用，比如_abc``__abc_等。

之所以说，private函数和变量不应该被直接引用，而不是不能被直接引用，是因为Python并没有一种方法可以完全限制访问private函数或变量，但是，从编程习惯上不应该引用private函数或变量。

private变量或函数的作用示例：

1
2
3
4
5
6
7
8
9
10
11
def _private_1(name):
    return 'Hello, %s' % name
def _private_2(name):
    return 'Hi, %s' % name
def greeting(name):
    if len(name) > 3:
        return _private_1(name)
    else:
        return _private_2(name)

我们在模块里公开greeting()函数，而把内部逻辑用private函数隐藏起来了，这样，调用greeting()函数不关心内部的private细节，这也是一种非常有用的代码封装和抽象方法，即：

外部不需要引用的函数全部定义为private，只有外部需要引用的函数才定义为public。

安装第三方模块

在Python中，安装第三方模块，是通过管理工具pip完成的。

现在我们来安装一个第三方库—-Python Imaging Library，这是Python下非常强大的处理图像的工具库。一般来说，第三方库都会在Python官方的pypi.python.org网站注册，要安装一个第三方库，必须知道该库的名称，可以在官网或者pipy上搜索，比如Pillow的名称叫pillow，因此，安装Pillow的命令就是：

1
pip install Pillow

安装了Pillow之后，就可以处理图片了，随便找一个图片生成缩略图：

1
2
3
4
5
6
>>> from PIL import Image
>>> im=Image.open(r'desktop\test.png')
>>> print(im.format, im.size, im.mode)
PNG (1841, 959) RGBA
>>> im.thumbnail((200,100))
>>>im.save(r'desktop\thumb.jpg','JPEG')

其他常用的第三方库还有MySQL的驱动，mysql-connector-python，用于科学计算的NumPy库numpy，用于生成文本的模板工具Jinja2等。

模块搜索路径

当我们试图加载一个模块时，Python会在指定的路径下搜索对应的.py文件，如果找不到，就会报错；默认情况下，Python解释器会搜索当前目录，所有已安装的内置模块和第三方模块，搜索路径存放在sys模块中的path变量中：

1
2
3
>>> import sys
>>> sys.path
['', 'C:\\Users\\cdxu0\\AppData\\Local\\Programs\\Python\\Python35\\python35.zip', 'C:\\Users\\cdxu0\\AppData\\Local\\Programs\\Python\\Python35\\DLLs', 'C:\\Users\\cdxu0\\AppData\\Local\\Programs\\Python\\Python35\\lib', 'C:\\Users\\cdxu0\\AppData\\Local\\Programs\\Python\\Python35', 'C:\\Users\\cdxu0\\AppData\\Local\\Programs\\Python\\Python35\\lib\\site-packages']

如果要添加自己的搜索目录，有两种方法：

1.直接修改sys.path，添加要搜索的目录
2.设置环境变量PYTHONPATH，该环境变量的内容会被自动添加到模块搜索路径中，设置方法和设置path 环境变量类似。

Donate comment here