day29-模块和包

一、模块介绍

1、什么是模块

在python中，一个函数封装一个功能，当一个文件中包含很多个函数，而我们在其他程序中经常会用到这个文件中的功能时，那么我们就可以将这个包含多个函数的文件封装成一个模块，供其他程序来引用。
简单来说，一个模块就一系列常用功能函数的集合体，一个.py文件就是一个模块。

模块分三种：
自定义模块、内置模块、第三方库

2、为何要使用模块？

2.1、从文件级别组织程序，更方便管理

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

2.2、拿来主义，提升开发效率

同样的原理，我们也可以下载别人写好的模块然后导入到自己的项目中使用，这种拿来主义，可以极大地提升我们的开发效率
ps：
如果你退出python解释器然后重新进入，那么你之前定义的函数或者变量都将丢失，因此我们通常将程序写到文件中以便永久保存下来，需要时就通过python test.py方式去执行，此时test.py被称为脚本script。

在 Python 中我们可以使用 import 模块名 或 from 模块名 import 功能名 这样的形式来引入某个模块或者模块中的某个函数、类等内容到当前的代码文件中。

下面以spam.py为例来介绍模块的使用

print('from the spam.py')
name = 'spam'

def read1():
    print('spam模块', name)
    
def read2():
    print('spam模块')
    read1()

def change():
    global name
    name = 'Tom'

二、模块使用之import

2.1、import的使用

模块可以包含可执行的语句和函数的定义，这些语句的目的是初始化模块，它们只在模块名第一次遇到导入import语句时才执行（import语句是可以在程序中的任意位置使用的,且针对同一个模块很import多次,为了防止你重复导入，python的优化手段是：第一次导入后就将模块名加载到内存了，后续的import语句仅是对已经加载到内存中的模块对象增加了一次引用，不会重新执行模块内的语句），如下

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

import spam
import spam
import spam
import spam
import spam

结果：只执行一次
from the spam.py

2.2、第一次导入模块时执行三件事

    1、为源文件（spam模块）创建新的名称空间，在spam中定义的函数和方法如果使用了global时访问的就是这个名称空间
    2、在新创建的名称空间中执行模块中包含的代码。
事实上是将模块中定义的函数名放入了模块全局名称空间表中，用globals()可以查看到。
print(globals())
{'__name__': '__main__', '__doc__': None, '__package__': None, '__loader__': <_frozen_importlib_external.SourceFileLoader object at 0x0028B510>, '__spec__': None, '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>, '__file__': 'G:/python3.6/oldboy/test.py', '__cached__': None, 'spam': <module 'spam' from 'G:\\python3.6\\oldboy\\spam.py'>}
    3、创建名字spam来引用该名称空间
这个名字和变量名没有什么区别，都是'第一类的'，并且使用spam.函数名的方法来访问spam.py文件中定义的函数名，spam.函数名与test.py中的变量或函数名来自两个完全不同的地方。

2.3、被导入模块有独立的名称空间

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

import spam

name = 'test'
print(name) #打印当前环境中的变量name，不会受当前环境中name的影响
print(spam.name) #打印spam名称空间中的变量name
# from the spam.py
# test
# spam

def read1():
    print(666)
spam.read1() #运行spam中read1函数，不会受当前环境中的read1函数的影响
# from the spam.py
# spam模块 spam

name = 'test'
spam.change() #调用spam中的change函数，刚spam中的name改为Tom
print(name)   #打印当前环境中的name，值为test
print(spam.name) #打印spam中的name，值为Tom
# from the spam.py
# test
# Tom

2.4、为模块起别名

为模块起别名的作用：
　　1、可以将过长的模块命名改成短的，便于操作。

import spam as sp
sp.read1()

　　2、有利于代码的拓展，优化。

#mysql.py
def sqlparse():
    print('from mysql sqlparse')
#oracle.py
def sqlparse():
    print('from oracle sqlparse')

#test.py
db_type=input('>>: ')
    if db_type == 'mysql':
        import mysql as db
    elif db_type == 'oracle':
        import oracle as db

db.sqlparse()
#不管输入的数据库类型是mysql还是oracle，都将引用的数据库名称设置为db，这样可以使用db.sqlparse()统一调用。    

2.5、导入多个模块

import sys,os,json #可以这样写，但是不推荐

#推荐应该这样：
import sys
import os
import json

2.6、通过字符串导入模块

当模块名是通过字符串的形式传递过来时，可使用__import__或importlib导入

例如，m1下存在t1.py文件，t1.py文件中存在test函数

module_m1 = __import__('m1')
print(module_m1)
#<module 'm1' (namespace)>

module_m1 = __import__('m1.t1')
print(module_m1)
#<module 'm1' (namespace)> 结果还是m1
#__import__方法只能导入模块的顶级模块名称，如果想导入模块内的子模块，可以使用importlib,官方建议使用importlib

import importlib

module_t = importlib.import_module('m1.t1')
print(module_t)
# <module 'm1.t1' from 'C:\\Users\\Administrator\\Desktop\\m1\\t1.py'>

module_t.test()
# test ok

 

 

三、from ... import ...

3.1、from ... import ...的用法：

name = 'test'
from spam import name, read1
print(name) 
    read1()
# from the spam.py
# spam
# spam模块 spam
# 如果当前环境中引用模块和执行模块之间没有name和read1，则会执行spam中的name和read1

from spam import name, read1
name = 'test'
print(name)
    read1()
# from the spam.py
# test
# spam模块 spam
#如果当前环境中引用模块和执行模块之间有name和read1，那么会执行当前环境中的name和read1

也就是说，如果当前环境中存在变量与引用模块的功能名称相同时，则后面的会覆盖前面的

3.2、from...import... 与import对比

唯一的区别就是：使用from...import...则是将spam中的名字直接导入到当前的名称空间中，所以在当前名称空间中，直接使用名字就可以了、无需加前缀：spam.
from...import...的方式有好处也有坏处
好处：使用起来方便了
坏处：容易与当前执行文件中的名字冲突

3.3、也支持as

from spam import read1 as read
read()

3.4 一行导入多个

from spam import read1,read2,name

3.5、from ... import *

from spam import * 把spam中所有的不是以下划线(_)开头的名字都导入到当前位置

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

可以使用__all__来控制* （用来发布新版本），在spam.py中新增一行__all__=['name','read1']
这样在另外一个文件中用from spam import * 就只能导入列表中规定的两个名字

3.6、模块循环导入问题

模块循环/嵌套导入抛出异常的根本原因是由于在python中模块被导入一次之后，就不会重新导入，只会在第一次导入时执行模块内代码

在我们的项目中应该尽量避免出现循环/嵌套导入，如果出现多个模块都需要共享的数据，可以将共享的数据集中存放到某一个地方

在程序出现了循环/嵌套导入后的异常分析、解决方法如下（了解，以后尽量避免）

四、模块的重载（了解）

考虑到性能的原因，每个模块只被导入一次,放入字典sys.module中，如果你改变了模块的内容，你必须重启程序，python不支持重新加载或卸载之前导入的模块，
有的同学可能会想到直接从sys.module中删除一个模块不就可以卸载了吗，注意了，你删了sys.module中的模块对象仍然可能被其他程序的组件所引用，因而不会被删除清楚。
特别是对于我们引用了这个模块中的一个类，用这个类产生了很多对象，因而这些对象都有关于这个模块的引用。
如果只是你想交互测试的一个模块，使用importlib.reload(modulename)，这只能用于测试环境。

aa.py初始内容
def func1():
    print('func1')

执行test文件
import time,importlib
import aa

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

在20秒的等待时间里，修改aa.py中func1的内容，等待test.py的结果。
打开importlib注释，重新测试

五，py文件的两种功能

编写好的一个python文件可以有两种用途：
一：脚本，一个文件就是整个程序，用来被执行
二：模块，文件中存放着一堆功能，用来被导入使用

python为我们内置了全局变量__name__，
当文件被当做脚本执行时：__name__ 等于'__main__'
当文件被当做模块导入时：__name__等于模块名

作用：用来控制.py文件在不同的应用场景下执行不同的逻辑（或者是在模块文件中测试代码）
if __name__ == '__main__':

例子：

if __name__ == '__main__':  
    # 在模块文件中测试read1()函数
    # 此模块被导入时 __name__ == spam 所以不执行
    read1()

六，模块的搜索路径

Python 有一个默认的模块搜索路径，包括当前目录及系统中的一些Python模块的主要安装目录，可以通过下面的方法查看搜索路径：

>>> import sys
>>> sys.path

返回的是一个路径的列表，其中第一个元素是当前执行文件的路径，也就是当前目录

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

模块的查找顺序
　　1、在第一次导入某个模块时（比如spam），会先检查该模块是否已经被加载到内存中（当前执行文件的名称空间对应的内存），如果有则直接引用
ps：python解释器在启动时会自动加载一些模块到内存中，可以使用sys.modules查看
　　2、如果没有，解释器则会查找同名的内置模块
　　3、如果还没有找到就从sys.path给出的目录列表中依次寻找spam.py文件。

需要特别注意的是：我们自定义的模块名不应该与系统内置模块重名。虽然每次都说，但是仍然会有人不停的犯错。

在初始化后，python程序可以修改sys.path，路径放到前面的优先于标准库被加载。

>>> import sys
>>> sys.path.append('/a/b/c/d')
>>> sys.path.insert(0,'/x/y/z') #排在前的目录，优先被搜索

注意：搜索时按照sys.path中从左到右的顺序查找，位于前面的优先被查找，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')

windows下的路径不加r开头，会语法错误

sys.path.insert(0,r'C:\Users\Administrator\PycharmProjects\a')

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

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

如果执行文件在dir目录下的dir1下，这时想要引用dir目录下的dir2下的spam模块

from dir2 import spam

也可以引用spam中的对象

from dir2.spam import func1

需要注意的是，dir2.spam这种方式，.后面必须是模块名，而不能是目录名，例如想引用dir2下的dir3下的spam，不可以使用from dir2.dir3 import spam这种方式。

python导入上级目录中的模块

python导入同级别模块很方便：
　　import xxx

要导入下级目录
　　from dirname import xxx

要导入上级目录，可以使用sys.path：
　　首先sys.path的作用是：当使用import语句导入模块时，解释器会搜索当前模块所在目录以及sys.path指定的路径去找需要import的模块，所以改变思路，直接把上级目录加到sys.path里：sys.path.append('../')

例子：

a.py:
def f1():
    print('in f1')

b.py:
import sys
sys.path.append('../')
from a import f1
f1()

def f2():
    print('in f2')
运行b.py文件中的f1()，可以调用到上级目录中的a模块中的f1，结果：
in f2

七，编译Python文件（了解）

为了提高加载模块的速度，强调强调强调：提高的是加载速度而绝非运行速度。python解释器会在__pycache__目录中下缓存每个模块编译后的版本，格式为：module.version.pyc。通常会包含python的版本号。例如，在CPython3.3版本下，spam.py模块会被缓存成__pycache__/spam.cpython-33.pyc。这种命名规范保证了编译后的结果多版本共存。

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

#python解释器在以下两种情况下不检测缓存
#1 如果是在命令行中被直接导入模块，则按照这种方式，每次导入都会重新编译，并且不会存储编译后的结果（python3.3以前的版本应该是这样）
    python -m spam.py

#2 如果源文件不存在，那么缓存的结果也不会被使用，如果想在没有源文件的情况下来使用编译后的结果，则编译后的结果必须在源目录下
sh-3.2# ls
__pycache__ spam.py
sh-3.2# rm -rf spam.py 
sh-3.2# mv __pycache__/spam.cpython-36.pyc ./spam.pyc
sh-3.2# python3 spam.pyc 
spam
 

#提示：
1.模块名区分大小写，foo.py与FOO.py代表的是两个模块
2.你可以使用-O或者-OO转换python命令来减少编译模块的大小
    -O转换会帮你去掉assert语句
    -OO转换会帮你去掉assert语句和__doc__文档字符串
    由于一些程序可能依赖于assert语句或文档字符串，你应该在在确认需要
    的情况下使用这些选项。
3.在速度上从.pyc文件中读指令来执行不会比从.py文件中读指令执行更快，只有在模块被加载时，.pyc文件才是更快的

4.只有使用import语句是才将文件自动编译为.pyc文件，在命令行或标准输入中指定运行脚本则不会生成这类文件，因而我们可以使用compieall模块为一个目录中的所有模块创建.pyc文件

模块可以作为一个脚本（使用python -m compileall）编译Python源  
python -m compileall /module_directory 递归着编译
如果使用python -O -m compileall /module_directory -l则只一层
  
命令行里使用compile()函数时，自动使用python -O -m compileall
  
详见：https://docs.python.org/3/library/compileall.html#module-compileall

八、包

8.1、什么是包？

    对于文件夹，Python 中可以识别成一个包，前提是这个文件夹中有一个 __init__.py 文件，文件中可以不用写任何内容。
（python2的包中必须要有一个__init__文件，python3中没有也不会报错）

    例如我们创建一个目录dir_a，在这个目录下有 __init__.py 和 a.py 两个代码文件，我们想要引入 a.py 文件就可以用 import dir_a.a这种代码来引入，前提是dir_a目录已经放到了 Python 模块搜索的默认路径下了。

    创建包的目的不是为了运行，而是被导入使用，记住，包只是模块的一种形式而已，包的本质就是一种模块

8.2、为何要使用包

    包的本质就是一个文件夹，那么文件夹唯一的功能就是将文件组织起来
随着功能越写越多，我们无法将所有功能都放到一个文件中，于是我们使用模块去组织功能，而随着模块越来越多，我们就需要用文件夹将模块文件组织起来，以此来提高程序的结构性和可维护性

8.3 注意事项

    1.关于包相关的导入语句也分为import和from ... import ...两种，但是无论哪种，无论在什么位置，在导入时都必须遵循一个原则：凡是在导入时带点的，点的左边都必须是一个包，否则非法。可以带有一连串的点，如item.subitem.subsubitem，但都必须遵循这个原则。但对于导入后，在使用时就没有这种限制了，点的左边可以是包、模块、函数、类(它们都可以用点的方式调用自己的属性)。

    2、import导入文件时，产生名称空间中的名字来源于文件，import包产生的名称空间的名字同样来源于文件，即包下的__init__.py，导入包本质就是在导入该文件

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

8.4、包的使用

8.4.1、示例文件

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

8.4.2、文件内容

执行文件与示范文件在同级目录下

#文件内容
#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)

8.4.3、包的使用之import 

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

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

#在与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()

8.4.4、包的使用之from ... import ...

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

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

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

8.4.5 from glance.api import *

在讲模块时，我们已经讨论过了从一个模块内导入所有*，此处我们研究从一个包导入所有*。
此处是想从包api中导入所有，实际上该语句只会导入包api下__init__.py文件中定义的名字，我们可以在这个文件中定义__all___:

#在__init__.py中定义
x=10

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

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

此时我们在与glance同级的文件中执行from glance.api import *就导入__all__中的内容（versions仍然不能导入）。

练习：

#执行文件中的使用效果如下，请处理好包的导入
from glance import *

get()
create_resource('a.conf')
main()
register_models('mysql')

#在glance.__init__.py中
from .api.policy import get
from .api.versions import create_resource

from .cmd.manage import main
from .db.models import  register_models

__all__=['get','create_resource','main','register_models']

8.4.6、绝对导入和相对导入

我们的最顶级包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 

8.4.7、包以及包所包含的模块都是用来被导入的，而不是被直接执行的。而环境变量都是以执行文件为准的

比如我们想在glance/api/versions.py中导入glance/api/policy.py，有的同学发现这俩模块是在同一个目录下，十分开心的就去做了，它直接这么做

#在version.py中
 
import policy
policy.get()

没错，我们单独运行version.py是一点问题没有的，运行version.py的路径搜索就是从当前路径开始的，于是在导入policy时能在当前目录下找到
但是你想啊，你子包中的模块version.py极有可能是被一个glance包同一级别的其他文件导入，比如我们在于glance同级下的一个test.py文件中导入version.py，如下

from glance.api import versions

'''
执行结果:
ImportError: No module named 'policy'
'''
 
'''
分析:
此时我们导入versions在versions.py中执行
import policy需要找从sys.path也就是从当前目录找policy.py,
这必然是找不到的
'''

8.4.8 绝对导入与相对导入总结

绝对导入与相对导入
绝对导入: 以执行文件的sys.path为起始点开始导入,称之为绝对导入
优点: 执行文件与被导入的模块中都可以使用
缺点: 所有导入都是以sys.path为起始点,导入麻烦

相对导入: 参照当前所在文件的文件夹为起始开始查找,称之为相对导入
符号: .代表当前所在文件的文件加,..代表上一级文件夹,...代表上一级的上一级文件夹
优点: 导入更加简单
缺点: 只能在导入包中的模块时才能使用

注意:
　　1. 相对导入只能用于包内部模块之间的相互导入,导入者与被导入者都必须存在于一个包内
　　2. attempted relative import beyond top-level package # 试图在顶级包之外使用相对导入是错误的,言外之意,必须在顶级包内使用相对导入,每增加一个.代表跳到上一级文件夹,而上一级不应该超出顶级包