模块 / 包 ​

1. 模块简介 ​

有过C语言编程经验的朋友都知道在C语言中如果要引用sqrt函数，必须用语句#include <math.h>引入math.h这个头文件，否则是无法正常进行调用的。

在Python中有一个概念叫做模块（module），这个和C语言中的头文件以及Java中的包很类似。模块就好比是工具包，要想使用这个工具包中的工具(就好比函数)，就需要导入这个模块

在Python中，相关功能代码写到一个Python文件中，我们就称该文件为模块，模块的名字就是文件的名字。如果模块需要在其他地方使用，文件名需要严格遵循标识符命名规范。

2. 导入模块 ​

导入一个模块时，Python会首先把模块文件的代码执行一遍。

为了提升代码执行效率，解释器会在首次程序执行时把需要使用的模块解释成的字节码文件缓存到__pycache__目录下，缓存文件名一般为模块名.解释器.Python版本.pyc。程序下次执行需要调用模块时会首先从缓存中读取，避免耗时的重复解释。

2.1 import ​

在Python中用关键字import来引入某个模块。使用模块名.成员名方式调用的。

import time   # 引入time模块

time.ctime()  # 调用time模块ctime函数
time.sleep(5)  # 让程序延迟执行5秒

__import__(name)魔法方法可以导入指定名称(字符串)的包或模块,其返回值为导入对象

time = __import__("time")
time.ctime()

2.2 from...import ​

2.2.1 模块的成员 ​

如果要引用某个模块中指定成员,可以使用from module import member语法。这只会单独引入指定的成员，而不会引入整个模块。

from math import sqrt,sin  # 引入math模块的sqrt和sin函数

sqrt(4)  # 调用引入的模块函数
sin(60)

'''
此方式引入，调用函数时只能给出函数名，不能给出模块名
当多个模块中含有相同名称函数时，后面引入会覆盖前面引入

如先引入A模块funciton(),再引入B模块function(),调用function函数会执行B模块的function()
'''

2.2.2 路径下模块 ​

如果要引用某个路径中指定模块,可以使用from path import module语法。Python3中在非根目录中模块之间引用不支持使用import module方式，此时就需要使用from path import module。Python2同时支持以上两种语法。

在包(package)__init__文件中导入包模块时常用此方式。

2.3 别名 ​

import模块时可以使用as关键字定义模块或模块成员别名。定义别名后原名不能再使用。

• 模块别名

import math as mt

mt.sqrt(4)

• 模块成员别名

from math import sqrt as kf

kf(4)

2.4 导入方式对比 ​

import module

from module import *

3. 模块高级 ​

3.1 重新加载 ​

当我们导入一个模块使用过程中，如果此模块内容被修改，就需要我们重新加载模块。importlib模块的reload(module)方法就用于重新加载模块。

import test

test.greet()

from importlib import reload

reload(test)  # 重新加载模块
test.greet()

3.2 模块查找 ​

导入一个模块时，Python解释器会按照一定的顺序到在某些目录下寻找模块文件。搜索目录和顺序存储在sys模块的path变量中。

import sys


print(sys.path)

sys.path是一个目录列表，Python解释器会按照列表顺序依次查找，找到即止。最终找不到会抛出ModuleNotFoundError异常。

既然定位模块依赖sys.path，那我们可以按需修改此列表。如果我们想要解释器到我们自定义的某个路径下查找模块文件，那我们可以将目录加入到sys.path当中，也可以控制其优先顺序。

sys.path.append("/home/colin/modules")
sys.path.insert(0,"/home/robin/modules")  # 确保先搜索这个路径

3.3 循环导入 ​

a.py:

from b import b 

def a():
    print("hello, a")
    b() 

a() # 异常 ImportError

b.py:

from a import a

def b():
    print("hello, b")
    a()

以上两个模块中代码相互以来会导致循环导入(ImportError)异常。

我们通常通过以下方式避免循环导入问题。

1. 分层设计，避免基础模块间引用，降低模块耦合。如果a,b基础模块间存在依赖，可以抽象一个更高层c模块导入a,b后进行逻辑聚合
2. 需要依赖时再导入。如在一个函数中依赖其他模块，则可以在函数内部进行导入

3.4 __all__ ​

3.4.1 模块 ​

当使用from ... import *方式导入一个模块全部内容时，在模块中可以通过__all__变量指定对外公开的成员，只有在其列表中的成员才允许被外部使用。

通过import...方式导入时，__all__无效。

test.py:

__all__ = ["TestClass", "sum"]


class TestClass(object):
    pass


num = 123


def sum(a, b):
    return a + b

main.py:

from test import *

c = TestClass()
sum(1, 2)
print(num)  # 异常。num没有出现在test模块的__all__列表中，外部不可访问

3.4.2 包 ​

通过from ... import *方式导入包时，在包的__init__文件中可以通过__all__指定对外公开的模块，只有在其列表中的模块才允许被外部使用。

相关使用方式参阅 包。

3.5 __name__ ​

实际开中，模块编写完成后，为了验证模块是否达到预期效果，通常会在模块文件中添加一些测试代码，但测试代码不应该在模块被外部调用时执行。

Python模块在执行时有一个__name__变量表征当前代码被执行调用的文件。此变量值为__main__时表示当前在模块定义文件内部执行,否则为模块被外部调用，值为引用此模块的文件名(不含扩展名)。因此，我们可以选择性的执行模块测试代码。

calc.py:

def sum(a, b):
    return a + b


# 以下测试代码只会在该模块内部执行
if __name__ == '__main__':
    a, b = 1, 2
    c = sum(a, b)
    print("test inside. %d + %d = %d" % (a, b, c))

main.py:

import calc # 导入模块时不会打印测试信息


sum = calc.sum(1, 2)
print(sum)

除了模块外，类和函数也有__name__属性表示自身名称。

class Person(object):
    def sayhi():
        pass

Person.__name__  # Person
Person().sayhi.__name__  # sayhi

4. 包 ​

4.1 包使用简介 ​

日常开发中，我们通常会将关联性较强的模块组织在一起，放在同一个目录下，为了管理其中的模块，我们通常通会在目录中建一个名为__init__.py的特殊文件(Python2必须,Python3非必须)，类似于模块清单，此时我们就把这个目录就称之为包。Python包相当于C#中的类库和Java中的包。

包支持嵌套使用，即在包中包含子包，多级目录。

4.2 发布包 ​

包开发完成后，如果想共享给他人，就需要我们发布包。

1) 配置 ​

假设我们有包目录结构如下。

my_project/
├── my_package/
│   ├── __init__.py
│   ├── module1.py
│   └── module2.py
└── setup.py

__init__.py是一个空文件，用于指示该文件夹是一个Python包。当包被引用时，会首先执行包的__init__.py文件,它控制着包的导入行为。

my_package/module1.py:

from .module2 import hello_module2

def hello_module1():
    print("Hello from module1!")
    hello_module2()

my_package/module2.py:

def hello_module2():
    print("Hello from module2!")

特别需要注意的是包中存在内部模块引用时，务必使用相对路径，否则打包之后第三方调用时会提示找不到模块的错误。

2) 打包 ​

在包同级目录下创建setup.py文件，内容如下：

from setuptools import setup, find_packages

setup(
    name='my_package',
    version='1.0',
    packages=find_packages(),
    install_requires=[
        # List any dependencies here
    ]
)

我们使用find_packages()函数来查找所有包含在my_package文件夹中的模块，并将它们包含在我们的Python包中。我们还可以使用install_requires参数来指定我们的Python包所依赖的任何其他Python包。

最后，我们可以使用以下命令来构建并打包我们的Python包。

python setup.py sdist

此命令将创建一个名为dist的文件夹，并在其中创建一个压缩文件，其中包含我们的Python包。该文件可以通过电子邮件、FTP或其他方式发送给第三方使用。

3) 安装 ​

使用我们的Python包的第三方可以通过以下命令来安装它：

pip install my_package-1.0.tar.gz

一旦安装完成，第三方就可以使用我们包中的函数了。

from my_package.module1 import hello_module1

hello_module1()

5. 标准库 ​

Python的强大有很大一部分是因为其庞大的标准库(standard library)提供了各式各样的功能，基本上日常使用中你所需要的功能都可以从中找到，从而大大减轻开发人员的压力，节省开发人员的时间。标准库会随着Python解释器，一起安装在你的电脑中的。它是Python的一个组成部分。

# 标准库使用示例
import hashlib

md5 = hashlib.md5()
md5.update(b"something to encrypt")
md5.hexdigest()

pyhton除了强大标准库，还有异常丰富的第三方扩展库。