Python编程-模块和包

一、模块

1.什么是模块？

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

2.为何要使用模块？

如果你退出python解释器然后重新进入，那么你之前定义的函数或者变量都将丢失，因此我们通常将程序写到文件中以便永久保存下来，需要时就通过python test.py方式去执行，此时test.py被称为脚本script。

随着程序的发展，功能越来越多，为了方便管理，我们通常将程序分成一个个的文件，这样做程序的结构更清晰，方便管理。这时我们不仅仅可以把这些文件当做脚本去执行，还可以把他们当做模块来导入到其他的模块中，实现了功能的重复利用。

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

使用模块还可以避免函数名和变量名冲突。相同名字的函数和变量完全可以分别存在不同的模块中，因此，我们自己在编写模块时，不必考虑名字会与其他模块冲突。但是也要注意，尽量不要与内置函数名字冲突。

3.模块的分类

• 自定义模块
• 第三方模块
• 内置模块

4.使用模块

（1）导入模块方式

import module
from module.xx.xx import xx
from module.xx.xx import xx as rename
from module.xx.xx import *

导入模块其实就是告诉Python解释器去解释那个py文件

• 导入一个py文件，解释器解释该py文件
• 导入一个包，解释器解释该包下的 init.py 文件

导入模块时是根据那个路径作为基准来进行的呢？

import sys
print sys.path

如果sys.path路径列表没有你想要的路径，可以通过 sys.path.append('路径') 添加:

import sys
import os
project_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.append(project_path)

（2）import

示例文件：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语句时才执行

注意：

import语句是可以在程序中的任意位置使用的,且针对同一个模块很import多次,为了防止你重复导入，python的优化手段是：第一次导入后就将模块名加载到内存了，后续的import语句仅是对已经加载大内存中的模块对象增加了一次引用，不会重新执行模块内的语句。

import test #只在第一次导入时才执行test.py内代码,此处的显式效果是只打印一次'from the test.py',当然其他的顶级代码也都被执行了,只不过没有显示效果.
import test
import test
import test

运行结果：
from the spam.py

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

每个模块都是一个独立的名称空间，定义在这个模块中的函数，把这个模块的名称空间当做全局名称空间，这样我们在编写自己的模块时，就不用担心我们定义在自己模块中全局变量会在被导入时，与使用者的全局变量冲突。

测试一:money与spam.money不冲突

import spam
money=10
print(spam.money)

执行结果：
from the spam.py
1000

测试二：read1与spam.read1不冲突

import spam
def read1():
    print('========')
spam.read1()

执行结果:
from the spam.py
spam->read1->money 1000

测试三：执行spam.change()操作的全局变量money仍然是spam中的

import spam
money=1
spam.change()
print(money)

执行结果：
from the spam.py
1

总结：

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

1.为源文件(spam模块)创建新的名称空间，在spam中定义的函数和方法若是使用到了global时访问的就是这个名称空间。

2.在新创建的命名空间中执行模块中包含的代码，见初始导入import spam

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

这个名字和变量名没什么区别，都是‘第一类的’，且使用spam.名字的方式可以访问spam.py文件中定义的名字，spam.名字与test.py中的名字来自两个完全不同的地方。

提示:导入模块时到底执行了什么？
In fact function definitions are also ‘statements’ that are ‘executed’; the execution of a module-level function definition enters the function name in the module’s global symbol table.
事实上函数定义也是“被执行”的语句，模块级别函数定义的执行将函数名放入模块全局名称空间表，用globals()可以查看

（3）别名

import spam as sm
print(sm.money)

导入模块时，还可以使用别名，这样，可以在运行时根据当前环境选择最合适的模块。比如Python标准库一般会提供StringIO和cStringIO两个库，这两个库的接口和功能是一样的，但是cStringIO是C写的，速度更快，所以，你会经常看到这样的写法：

try:
    import cStringIO as StringIO
except ImportError: # 导入失败会捕获到ImportError
    import StringIO

这样就可以优先导入cStringIO。如果有些平台不提供cStringIO，还可以降级使用StringIO。导入cStringIO时，用import ... as ...指定了别名StringIO，因此，后续代码引用StringIO即可正常工作。

为已经导入的模块起别名的方式对编写可扩展的代码很有用，假设有两个模块xmlreader.py和csvreader.py，它们都定义了函数read_data(filename):用来从文件中读取一些数据，但采用不同的输入格式。可以编写代码来选择性地挑选读取模块，例如:

if file_format == 'xml':
    import xmlreader as reader
elif file_format == 'csv':
    import csvreader as reader
data=reader.read_date(filename)

（4）from ... import...

对比import spam，会将源文件的名称空间'spam'带到当前名称空间中，使用时必须是spam.名字的方式。

而from语句相当于import，也会创建新的名称空间，但是它将spam中的名字直接导入到当前的名称空间中，在当前名称空间中，直接使用名字就可以了。

测试一：导入的函数read1，执行时仍然回到spam.py中寻找全局变量money

from spam import read1
money=1000
read1()

执行结果:
from the spam.py
spam->read1->money 1000

测试二:导入的函数read2，执行时需要调用read1(),仍然回到spam.py中找read1()

from spam import read2
def read1():
    print('==========')
read2()

执行结果:
from the spam.py
spam->read2 calling read
spam->read1->money 1000

注意：如果当前有重名read1或者read2，那么会有覆盖效果

测试三:导入的函数read1，被当前位置定义的read1覆盖掉了

from spam import read1
def read1():
    print('==========')
read1()

执行结果:
from the spam.py
==========

需要特别强调的一点是：python中的变量赋值不是一种存储操作，而只是一种绑定关系

from spam import money,read1
money=100                 #将当前位置的名字money绑定到了100
print(money)              #打印当前的名字
read1()                   #读取spam.py中的名字money,仍然为1000

from the spam.py
100
spam->read1->money 1000

（5）from spam import *

把spam中所有的不是以下划线(_)开头的名字都导入到当前位置，大部分情况下我们的python程序不应该使用这种导入方式，因为*你不知道你导入什么名字，很有可能会覆盖掉你之前已经定义的名字。而且可读性极其的差，在交互式环境中导入时没有问题。

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

执行结果:
from the spam.py
1000
<function read1 at 0x1012e8158>
<function read2 at 0x1012e81e0>
<function change at 0x1012e8268>

如何控制导入的模块呢？

可以使用__ all __来控制*（用来发布新版本）

在spam.py中新增一行

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

（6）特别注意

考虑到性能的原因，每个模块只被导入一次,放入字典sys.module中，如果你改变了模块的内容，你必须重启程序，python不支持重新加载或卸载之前导入的模块，有的同学可能会想到直接从sys.module中删除一个模块不就可以卸载了吗，注意了，你删了sys.module中的模块对象仍然可能被其他程序的组件所引用，因而不会被清楚。

特别的对于我们引用了这个模块中的一个类，用这个类产生了很多对象，因而这些对象都有关于这个模块的引用。

如果只是你想交互测试的一个模块，使用importlib.reload(), import importlib; importlib.reload(modulename)，这只能用于测试环境。

测试：

def func1():
    print('func1')

import time,importlib
import aa

time.sleep(20)
# importlib.reload(aa)
aa.func1()

在20秒的等待时间里，修改aa.py中func1的内容，等待test.py的结果。

打开importlib注释，重新测试

5.作用域

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

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

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

类似-xxx和--xxx这样的函数或变量就是非公开的（private），不应该被直接引用，比如_abc，--abc等；

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

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。

6.把模块当做脚本执行

用来控制.py文件在不同的应用场景下执行不同的逻辑

def fib(n):    # write Fibonacci series up to n
    a, b = 0, 1
    while b < n:
        print(b, end=' ')
        a, b = b, a+b
    print()

def fib2(n):   # return Fibonacci series up to n
    result = []
    a, b = 0, 1
    while b < n:
        result.append(b)
        a, b = b, a+b
    return result

if __name__ == "__main__":
    import sys
    fib(int(sys.argv[1]))

运行方式：
python fib.py 50

7.深入了解搜索路径

在第一次导入某个模块时（比如spam），会先检查该模块是否已经被加载到内存中（当前执行文件的名称空间对应的内存），如果有则直接引用，如果没有，解释器则会查找同名的内建模块，如果还没有找到就从sys.path给出的目录列表中依次寻找spam.py文件。

模块的查找顺序是：内存中已经加载的模块->内置模块->sys.path路径中包含的模块

注意：

搜索时按照sys.path中从左到右的顺序查找，位于前的优先被查找，sys.path中还可能包含.zip归档文件和.egg文件，python会把.zip归档文件当成一个目录去处理。

至于.egg文件是由setuptools创建的包，这是按照第三方python库和扩展时使用的一种常见格式，.egg文件实际上只是添加了额外元数据(如版本号，依赖项等)的.zip文件。

需要强调的一点是：

只能从.zip文件中导入.py，.pyc等文件。使用C编写的共享库和扩展块无法直接从.zip文件中加载（此时setuptools等打包系统有时能提供一种规避方法），且从.zip中加载文件不会创建.pyc或者.pyo文件，因此一定要事先创建他们，来避免加载模块是性能下降。

8.编译python文件

为了提高模块的加载速度，Python缓存编译的版本，每个模块在__pycache__目录的以module.version.pyc的形式命名，通常包含了python的版本号，如在CPython版本3.3，关于spam.py的编译版本将被缓存成__pycache__/spam.cpython-33.pyc，这种命名约定允许不同的版本，不同版本的Python编写模块共存。

Python检查源文件的修改时间与编译的版本进行对比，如果过期就需要重新编译。这是完全自动的过程。并且编译的模块是平台独立的，所以相同的库可以在不同的架构的系统之间共享，即pyc使一种跨平台的字节码，类似于JAVA或.NET,是由python虚拟机来执行的，但是pyc的内容跟python的版本相关，不同的版本编译后的pyc文件不同，2.5编译的pyc文件不能到3.5上执行，并且pyc文件是可以反编译的，因而它的出现仅仅是用来提升模块的加载速度的。

提示：

• 模块名区分大小写，foo.py与FOO.py代表的是两个模块
• 你可以使用-O或者-OO转换python命令来减少编译模块的大小
• 在速度上从.pyc文件中读指令来执行不会比从.py文件中读指令执行更快，只有在模块被加载时，.pyc文件才是更快的
• 只有使用import语句是才将文件自动编译为.pyc文件，在命令行或标准输入中指定运行脚本则不会生成这类文件，因而我们可以使用compieall模块为一个目录中的所有模块创建.pyc文件

二、包

• 无论是import形式还是from...import形式，凡是在导入语句中（而不是在使用时）遇到带点的，都要第一时间提高警觉：这是关于包才有的导入语法
• 包是目录级的（文件夹级），文件夹是用来组成py文件（包的本质就是一个包含__init__.py文件的目录）
• import导入文件时，产生名称空间中的名字来源于文件，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,但都必须遵循这个原则。
• 对于导入后，在使用时就没有这种限制了，点的左边可以是包，模块，函数，类(它们都可以用点的方式调用自己的属性)。
• 对比import item 和from item import name的应用场景：如果我们想直接使用name那必须使用后者。

2.import

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

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

3.from ... import ...

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

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

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

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

4.--init--.py文件

不管是哪种方式，只要是第一次导入包或者是包的任何其他部分，都会依次执行包下的--init--.py文件(我们可以在每个包的文件内都打印一行内容来验证一下)，这个文件可以为空，但是也可以存放一些初始化包的代码。

5.from glance.api 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--中的内容（versions仍然不能导入）。

5.绝对导入和相对导入

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

绝对导入：以glance作为起始

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

例如：我们在glance/api/version.py中想要导入glance/cmd/manage.py

在glance/api/version.py

#绝对导入
from glance.cmd import manage
manage.main()

#相对导入
from ..cmd import manage
manage.main()

测试结果：注意一定要在于glance同级的文件中测试

from glance.api import versions

注意：在使用pycharm时，有的情况会为你多做一些事情，这是软件相关的东西，会影响你对模块导入的理解，因而在测试时，一定要回到命令行去执行，模拟我们生产环境。

6.单独导入包

单独导入包名称时不会导入包中所有包含的所有子模块

如：在与glance同级的test.py中

import glance
glance.cmd.manage.main()

执行结果：
AttributeError: module 'glance' has no attribute 'cmd'

解决方法：

#glance/__init__.py
from . import cmd

#glance/cmd/__init__.py
from . import manage

执行：

在于glance同级的test.py中

import glance
glance.cmd.manage.main()

千万别问：--all--不能解决吗，--all--是用于控制from...import *