Python自动化开发 - 模块与包

本节内容

一、模块

　  1、import module

　　2、from module  import

　　3、from module  import *

　　4、模块的__name__属性

　　5、模块搜索路径

　　6、编译Python文件

　　7、标准模块

二、包

　　1、包的概述

　　2、import packet.module

　　3、from packet import module

　　4、__init.py__文件

　　5、from packet.packet import *

　　6、绝对导入和相对导入

一、模块

什么是模块

一个模块就是一个包含了python定义和声明的文件，文件名就是模块名字加上.py的后缀

为何要使用模块

当退出Python解释器后重新进入，之前定义的函数或者变量都将丢失，因此通常将程序写到文件中以便永久保存下来，

需要时就通过Python test.py方式去执行，此时test.py被称为脚本script

随着程序的发展，功能越来越多，为了方便管理，我们通常将程序分成一个个的文件，这样做程序的结构更清晰，方便管理。

这时我们不仅仅可以把这些文件当做脚本去执行，还可以把他们当做模块来导入到其他的模块中，实现了功能的重复利用。

如何使用模块

1、import module

示例文件 spam.py 文件名为spam.py，模块名为spam

# spam.py
print('from the spam.py')
money = 1000

def read1():
    print('spam->read1->money', money)

def read2():
    print('spam->read2 calling read')
    read1()

def change():
    global money
    money = 0

模块可以包含可执行的语句和函数的定义，这些语句的目的是初始化模块，它们只在模块名第一次遇到导入import语句时才执行

sys.module中找到当前已经加载的模块，sys.module是一个字典，内部包含模块名与模块对象的映射，该字典决定了导入模块时是否需要重新导入

如果改变了模块的内容必须重启程序，Python不支持重新加载或删除之前导入的模块

# test.py
import spam
import spam
import spam
'''
第一次导入后就将模块名加载到内存了，
后续的import语句仅是对已经加载大内存中的模块对象增加了一次引用，
不会重新执行模块内的语句
'''
money = 10
spam.read1()     # 输出结果 spam->read1->money 1000， 不受money=10影响

def read1():
    print('=====')
spam.read1()   # 输出结果 spam->read1->money 1000，不受print('=====')影响

money = 1
spam.change()
print(money)       # 输出结果为 1，不受money=1影响
print(spam.money)  # 输出结果为 0，变化局限于导入模块 spam 

每个模块都是一个独立的名称空间，定义在这个模块中的函数，把这个模块的名称空间当做全局名称空间，

这样我们在编写自己的模块时，就不用担心定义在导入模块中全局变量，与使用者的全局变量冲突

小结：首次导入模块spam时会做三件事

1. 为源文件(spam模块)创建新的名称空间

　 在spam中定义的函数和方法若是用到了global时访问的就是这个名称空间

2. 在新创建的命名空间中执行模块中包含的代码，执行于import spam

　 模块级别函数定义的执行将函数名放入模块全局名称空间表，用globals()可以查看

3. 创建名字spam来引用该命名空间

　 这个名字和变量名没什么区别，都是"第一类的"，且使用spam.名字的方式可以访问spam.py文件中定义的名字，

　spam.名字与test.py中的名字来自完全不同的地方

支持起别名与导入多个模块

import spam as sm   # 为模块起别名
import sys, os, re  # 在一行导入多个模块

2、from module  import

将模块中的名字直接导入到当前的名称空间中，在当前名称空间中，直接使用名字就可以了

# test01.py
from spam import read1, read2

# 测试一：导入的函数read1，执行时仍然回到spam.py中寻找全局变量money
money = 10
read1()     # 执行结果 spam->read1->money 1000
print(money)
# Python中的变量赋值不是一种存储操作，而只是一种绑定关系，如money == 10

# 测试二：导入的函数read2，执行时需要调用read1(),仍然回到spam.py中找read1()
def read1():
    print("=====")
read2()
'''
执行结果
spam->read2 calling read
spam->read1->money 1000
'''

# 测试三:导入的函数read1，被当前位置定义的read1覆盖掉了
def read1():
    print("=====")
read1()  # 输出结果  =====

支持起别名与导入多个变量

from spam import read1 as read   # 起别名
from spam import (read1,         # 导入多个变量
                   read2,
                   money,)

3、from module import *

把spam中所有的不是以下划线(_)开头的名字都导入到当前位置，大部分情况下Python程序不应该使用这种导入方式

因为 * 你不知道你导入什么名字，很可能会覆盖掉你之前已经定义的名字，而且可读性较差

from spam import *  # 将模块spam中所有的名字都导入到当前名称空间
print(money)
print(read1)
print(read2)
print(change)

'''
执行结果
from the spam.py
1000
<function read1 at 0x000000F86F2DC488>
<function read2 at 0x000000F86F2DC400>
<function change at 0x000000F86F2DC510>
'''

可以使用__all__来控制 * (用来发布新版本)，但是对import spam和 from spam import read2,change导入特定变量 不起作用

在spam.py 中新增一行

__all__=['money','read1'] #这样在另外一个文件中用from spam import *就这能导入列表中规定的两个名字

　　

4、模块的__name__属性

全局变量__name__来查看模块名

模块当做脚本运行  __name__ == '__main__'

当做模块导入时，  __name__ == '模块名'

# spam02.py
if __name__ == '__main__':
    print('我是本程序')
else:
    print('来自另一模块')

#  输出结果  我是本程序

　　

5、模块搜索路径

当模块spam导入时，解释器首先查找同名的内建模块，如果不存在，就从sys.path给出的目录列表中依次寻找spam.py文件

注: 自定义的模块名不应该与系统内置模块重名

import  sys

sys.path.append("D:\\")     # 可追加新目录
sys.path.insert(0, "D:\\")   # 排在前面的目录，优先被搜索

sys.path中还可能包含.zip归档文件和.egg文件，Python会把.zip归档文件当成一个目录去处理

# 首先制作归档文件：zip module.zip foo.py bar.py

import sys
sys.path.append('module.zip')
import foo,bar

#也可以使用zip中目录结构的具体位置
sys.path.append('module.zip/lib/python')

至于.egg文件是由setuptools创建的包，这是按照第三方python库和扩展时使用的一种常见格式，

.egg文件实际上只是添加了额外元数据(如版本号，依赖项等)的.zip文件　

注：只能从.zip文件中导入.py，.pyc等文件，使用C编写的共享库和扩展块无法直接从.zip文件中加载

从.zip中加载文件不会创建.pyc或者.pyo文件，因此一定要事先创建他们，来避免加载模块时性能下降

6、编译Python文件

为了提高模块的加载速度，Python缓存编译的版本，每个模块在__pycache__目录的以module.version.pyc的形式命名，

通常包含了python的版本号，如在CPython版本3.5，关于spam.py的编译版本将被缓存成__pycache__/spam.cpython-35.pyc

这种命名约定允许不同的版本，不同版本的Python编写模块共存。

编译分析：

• Python检查源文件的修改时间与编译的版本进行对比，如果过期就需要重新编译。这是完全自动的过程。

• 编译的模块是平台独立的，相同的库可以在不同的架构的系统之间共享，

• .pyc使一种跨平台的字节码，类似于JAVA和.NET，是由Python虚拟机来执行

• .pyc的内容跟Python的版本相关，不同的版本编译后的pyc文件不同，2.5编译的pyc文件不能到3.5上执行，并且.pyc文件是可以反编译

• 编译文件.pyc的出现仅仅是用来提升模块的加载速度

提示：

• 模块名区分大小写，foo.py与FOO.py代表的是两个模块

• 在速度上从.pyc文件中读取指令来执行不会比从.py文件中读指令执行更快，只有在模块被加载时，.pyc文件才是更快的

• 只要使用import语句时才将文件自动编译为.pyc文件，在命令行或标准输入中指定运行脚本则不会生成这类文件，

• 可以使用compieall模块为一个目录中的所有模块创建.pyc文件

7、标准模块

Python提供了一个标准模块库，一些模块被内置到解释器中，提供了不属于核心语言核心部分的操作的访问

这些模块集合是依赖于底层平台的配置项，如winreg模块只能用于windows系统，sys模块内建在每一个Python解释器

二、包

1、包的概述

包是一种管理Python模块命名空间的形式，采用"点模块名称"，比如一个模块的名称是A.B，那么他表示一个包A中的子模块B

无论是import 形式还是from...import形式，凡是在导入语句中(而不是在使用时)遇到带点的，都要第一时间提高警惕：

这是关于包才有的导入语法

包的本质就是一个包含__init.py__文件的目录

包A和包B下有同名模块也不会冲突，如A.a与B.a来自两个命名空间

glance/              #Top-level package

├── __init__.py      # Initialize the glance package
├── api              # Subpackage for api
│   ├── __init__.py
│   ├── policy.py
│   └── versions.py
├── cmd              # Subpackage for cmd
│   ├── __init__.py
│   └── manage.py
└── db               # Subpackage for db
    ├── __init__.py
    └── models.py

# 文件内容

# policy.py
def get():
    print('from policy.py')

# versions.py
def create_resource(conf):
    print('from version.py: ',conf)

# manage.py
def main():
    print('from manage.py')

# models.py
def register_models(engine):
    print('from models.py: ',engine)　

注意事项

(1) 关于包相关的导入语句也分为import和from ... import ...两种，但是无论哪种，无论在什么位置，在导入时都必须遵循一个原则：

凡是在导入时带点的，点的左边都必须是一个包，否则非法。可以带有一连串的点，如item.subitem.subsubitem，但都必须遵循这个原则

(2)  对于导入后，在使用时就没有这种限制了，点的左边可以是包,模块，函数，类(它们都可以用点的方式调用自己的属性)

(3) 对比import item 和from item import name的应用场景：如果我们想直接使用name那必须使用后者。

2、import packet.module

我们在与包glance同级别的文件中测试

import glance.db.models
glance.db.models.register_models('mysql')

　　

3、from packet import module

需要注意的是from后import导入的模块，必须是明确的一个不能带点，否则会有语法错误，如：from a import b.c是错误语法

from glance.db import models
models.register_models('mssql')

from glance.db.models import register_models
register_models('MongoDB')

4、__init.py__文件

不管是哪种方式，只要是第一次导入包或者是包的任何其他部分，都会依次执行包下的__init__.py文件，

这个文件可以为空，但是也可以存放一些初始化包的代码

换句话说，如果要将一个文件夹目录当做package的话，必须要在该目录下加一个__init__.py的文件

5、from packet.packet import *

想从包api导入所有文件，实际上该语句只会导入包api下__init.py__文件中定义的名字，可以在这个文件中定义__all__

x = 10

def func():
   print('from api.__init.py')

__all__ = ['x', 'func', 'policy']

此时我们在于glance同级的文件中执行from glance.api import * 就导入__all__中的内容

6、绝对导入和相对导入

我们的最顶级包glance是写给别人用的，然后在glance包内部也会有彼此之间互相导入的需求，这时候就有绝对导入和相对导入两种方式：

绝对导入：以glance作为起始

相对导入：用.或者..的方式最为起始（只能在一个包中使用，不能用于不同目录内）

小结：

• 可以用import导入内置或者第三方模块，但是要绝对避免使用import来导入自定义包的子模块

• 使用from... import ...的绝对或者相对导入,且包的相对导入只能用from的形式

• 单独导入包名称时，如import glance不会导入包中所有包含的所有子模块