5. 模块与包

模块与包

1. 模块

1.1 什么是模块？

常见场景：一个模块就是一个包含了python定义和声明的文件，import导入的模块可分为四个通用类别：

1. 使用python编写的.py文件
2. 把一系列模块组织到一起的文件夹(文件夹下有一个init.py文件，该文件夹称之为包)
3. 已被编译为共享库或DLL的C或C++扩展
4. 使用C编写并链接到python解释器的内置模块

随着程序功能增多，从文件级别组织程序，结构更清晰且方便管理；
下载别人写好的模块导入到项目中使用，拿来主义可极大地提升开发效率；
可把模块文件当做脚本执行；还可把模块导入到其他模块中，实现功能的重复利用；

1.2 使用模块’import spam’

'''模块文件名spam.py，模块名spam
1. spam.py执行过程中产生的名字都存放于一个独立的名称空间组(内置&全局&局部)，不与当前名称空间存在冲突关系
2. 当前名称空间仅仅拿到一个名字spam，指向`1`新产生的名称空间组；引用spam.py中名字的方式：`spam.名字`
'''
import time,sys,spam   # from spam.py；一行可导入多个模块，但不推荐
import spam     # 重复导入只增加之前结果的引用计数，并不会重新执行模块代码(不再显示 `from spam.py`)


print(spam)# <module 'spam' from '/Users/bqshiji/Desktop/VS_Code/Python_MD/16. 模块与包/spam.py'>
print(spam.money)     # ==> 1000；
money=1               # spam.money 与 money 在不同内存空间，不存在冲突关系
print(spam.read1)     # ==> <function read1 at 0x104466510>


def read1():print('from current')
spam.read1()
spam.read2()     # 执行read2()，调用源文件名称空间的 read1()


'''起别名：`import spam as sm` ==> `sm.名字`引用spam.py中名字'''
engine=input('>>: ')
if engine == 'mysql':
    import mysql as sql
elif engine == 'oracle':
    import oracle as sql


sql.parse()    # 下面的代码不必考虑用户选择什么数据库引擎

1.3 使用模块from spam import money，直接使用被导入模块中的名字

'''引用时不用加前缀，简单；但是容易与当前名称空间的名字冲突'''


from spam import *  # 导入除下划线开头外所有的名字，print(_money) 报错找不到；极容易与当前名称空间冲突
print(jinjie)      # 报错(如果被导入模块中定义了 __all__ 且不为空，*只导入其中定义的名字)，其他方式可导入jinjie
from spam import money       # money = spam.money
from spam import money as m    # m = spam.money
from spam import money,read1,read2,change     # 一行导入多个名字
money=10
print(money,m,money is m)      # ==> 10 1000 false
read1()         # ==> spam模块：1000；运行始终以源文件为准


def read1(): print('from current func')
read2()      # 运行始终以源文件为准，在源文件名称空间中找read1()函数
# spam模块
# spam模块: 1000


money = 1
change()
print(money)    # ==> 1；运行始终以源文件为准，change()改不了当前内存空间的money
print(globals())

1.4 区分python文件的两种用途

1. 当做脚本执行：name == ‘main’

2. 当做模块被导入使用: name == ‘模块名’

   if name == ‘main‘:
   pass

6、模块的搜索路径
内存—-》内置模块—–》sys.path

二 包
1、什么是包
包就是一个包含了init.py文件的文件夹（可以往该文件夹下放一堆子模块）
2、包的使用
注意：但凡是在导入时，出现.,这是导入包才有的语法，.的左边必须是一个包,使用的时候没有这种限制

二 使用模块之import

1、import的使用

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

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

”’
执行结果：
from the spam.py
”’

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

2、首次import做了三件事

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

2.在新创建的命名空间中执行模块中包含的代码，见初始导入import spam
提示:导入模块时到底执行了什么？
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.创建名字spam来引用该命名空间
这个名字和变量名没什么区别，都是‘第一类的’，且使用spam.名字的方式可以访问spam.py文件中定义的名字，spam.名字与test.py中的名字来自两个完全不同的地方。

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

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

# 测试一：money 与 spam.money 不冲突
#test.py
import spam 
money=10
print(spam.money)


'''
执行结果：
from the spam.py
1000
'''

4、为模块名起别名

为已经导入的模块起别名的方式对编写可扩展的代码很有用

import spam as sm
print(sm.money)

有两中sql模块mysql和oracle，根据用户的输入，选择不同的sql功能

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

假设有两个模块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)

5、在一行导入多个模块

import sys,os,re

三 使用模块之from … import…

1、from…import…的使用

from spam import read1,read2

2、from…import 与import的对比

唯一的区别就是：使用from…import…则是将spam中的名字直接导入到当前的名称空间中，所以在当前名称空间中，直接使用名字就可以了、无需加前缀：spam.

from…import…的方式有好处也有坏处

好处：使用起来方便了
坏处：容易与当前执行文件中的名字冲突

验证一：当前位置直接使用read1和read2就好了，执行时，仍然以spam.py文件全局名称空间

测试一：导入的函数read1，执行时仍然回到spam.py中寻找全局变量money
测试二:导入的函数read2，执行时需要调用read1(),仍然回到spam.py中找read1()

验证二：如果当前有重名read1或者read2，那么会有覆盖效果。

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

验证三：导入的方法在执行时，始终是以源文件为准的

3、也支持as

from spam import read1 as read

4、也支持导入多行

from spam import (read1,
                  read2,
                  money)

5、from…import *

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

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

可以使用all来控制*（用来发布新版本），在spam.py中新增一行

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

四 模块的重载 (了解)

考虑到性能的原因，每个模块只被导入一次,放入字典sys.module中，如果你改变了模块的内容，你必须重启程序，python不支持重新加载或卸载之前导入的模块，

有的同学可能会想到直接从sys.module中删除一个模块不就可以卸载了吗，注意了，你删了sys.module中的模块对象仍然可能被其他程序的组件所引用，因而不会被清楚。

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

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

aa.py的初始内容

def func1():
    print('func1')

执行test.py

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‘:

#fib.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 python fib.py 50 #在命令行

六 模块搜索路径

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

模块的查找顺序

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

sys.path的初始化的值来自于：

The directory containing the input script (or the current directory when no file is specified).
PYTHONPATH (a list of directory names, with the same syntax as the shell variable PATH).
The installation-dependent default.

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

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

1 >>> import sys
2 >>> sys.path.append('/a/b/c/d')
3 >>> 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文件，因此一定要事先创建他们，来避免加载模块是性能下降。

官网解释：https://docs.python.org/3/tutorial/modules.html#the-module-search-path
搜索路径：

当一个命名为spam的模块被导入时
解释器首先会从内建模块中寻找该名字
找不到，则去sys.path中找该名字

sys.path从以下位置初始化
1 执行文件所在的当前目录
2 PTYHONPATH（包含一系列目录名，与shell变量PATH语法一样）
3 依赖安装时默认指定的

注意：在支持软连接的文件系统中，执行脚本所在的目录是在软连接之后被计算的，换句话说，包含软连接的目录不会被添加到模块的搜索路径中

在初始化后，我们也可以在python程序中修改sys.path,执行文件所在的路径默认是sys.path的第一个目录，在所有标准库路径的前面。这意味着，当前目录是优先于标准库目录的，需要强调的是：我们自定义的模块名不要跟python标准库的模块名重复，除非你是故意的，傻叉。

八 包介绍

1、什么是包？

官网解释: Packages are a way of structuring Python’s module namespace by using “dotted module names”
包是一种通过使用‘.模块名’来组织python模块名称空间的方式。

具体的：包就是一个包含有init.py文件的文件夹，所以其实我们创建包的目的就是为了用文件夹将文件/模块组织起来

需要强调的是：
　　1. 在python3中，即使包下没有init.py文件，import 包仍然不会报错，而在python2中，包下一定要有该文件，否则import 包报错
　　2. 创建包的目的不是为了运行，而是被导入使用，记住，包只是模块的一种形式而已，包的本质就是一种模块

2、为何要使用包

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

3、注意事项

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

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

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

九 包的使用

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

#文件内容

#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)

包所包含的文件内容

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

2、包的使用之import

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

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

#在与glance同级的test.py中
import glance
glance.cmd.manage.main()

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

解决方法：

1 #glance/__init__.py
2 from . import cmd
3 
4 #glance/cmd/__init__.py
5 from . import manage

执行：
1 #在于glance同级的test.py中
2 import glance
3 glance.cmd.manage.main()

3、包的使用之from … import …

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

1 from glance.db import models
2 models.register_models('mysql')
3 
4 from glance.db.models import register_models
5 register_models('mysql')

5、绝对导入和相对导入

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

绝对导入：以glance作为起始

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

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

1 在glance/api/version.py
2 
3 #绝对导入
4 from glance.cmd import manage
5 manage.main()
6 
7 #相对导入
8 from ..cmd import manage
9 manage.main()

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

1 from glance.api import versions

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

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

1 #在version.py中
2 
3 import policy
4 policy.get()

没错，我们单独运行version.py是一点问题没有的，运行version.py的路径搜索就是从当前路径开始的，于是在导入policy时能在当前目录下找到

但是你想啊，你子包中的模块version.py极有可能是被一个glance包同一级别的其他文件导入，比如我们在于glance同级下的一个test.py文件中导入version.py，如下

 1 from glance.api import versions
 2 
 3 '''
 4 执行结果:
 5 ImportError: No module named 'policy'
 6 '''
 7 
 8 '''
 9 分析:
10 此时我们导入versions在versions.py中执行
11 import policy需要找从sys.path也就是从当前目录找policy.py,
12 这必然是找不到的
13 '''

7、包的分发（了解）

https://packaging.python.org/distributing/

十 软件开发规范