模块与包

介绍

一 模块介绍
二 使用模块之import
三 使用模块之from ... import...
四 模块的重载 (了解)
五 py文件区分两种用途:模块与脚本
六 模块搜索路径
七 编译python文件（了解）
八 包介绍
九 包的使用
十 软件开发规范

 

一、模块介绍

　　1.什么是模块

　　　　

#常见的场景：一个模块就是一个包含了一组功能的python文件,比如spam.py，模块名为spam，可以通过import spam使用。

#在python中，模块的使用方式都是一样的，但其实细说的话，模块可以分为四个通用类别：　

　　1 使用python编写的.py文件

　　2 已被编译为共享库或DLL的C或C++扩展

　　3 把一系列模块组织到一起的文件夹（注：文件夹下有一个__init__.py文件，该文件夹称之为包）

　　4 使用C编写并链接到python解释器的内置模块

　　2.为何使用模块

　　　　

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

#2、拿来主义，提升开发效率
同样的原理，我们也可以下载别人写好的模块然后导入到自己的项目中使用，这种拿来主义，可以极大地提升我们的开发效率

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

　　3.spam 模块的使用

#spam.py
print('from the spam.py')

money=1000

def read1():
    print('spam模块：',money)

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

def change():
    global money
    money=0

二、使用模块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、导入模块时发生的三件事

#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、导入模块的独立名称空间

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

#spam.py
def money():
    mo=100
    print('rom the spam.py%s\n'%mo)

#test.py
import spam     #测试自己编写的python 脚本
money=10
print(spam.money)

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

示例文件 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
每个模块都是一个独立的名称空间，定义在这个模块中的函数，把这个模块的名称空间当做全局名称空间，

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

　　4、为模块起别名

    为已经导入的模块起别名的方式对编写可扩展的代码很有用。
格式：import 模块名 as 别名  eq：import spam as sm

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。。

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

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

　　2.、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__来控制*（用来发布新版本），在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
1 import time,importlib
2 import aa
3
4 time.sleep(20)
5 # importlib.reload(aa)
6 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 <arguments>
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标准库的模块名重复，除非你是故意的，傻叉。

七、编译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

八、包

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作为起始

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

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()
复制代码

7、包的分发（了解）

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