模块与包

    一模块

1.模块的定义：

　　凡是后缀是.py的方式都是属于一个模块。

2 为何要使用模块？

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

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

3.模块的使用:

基本的实例：

自定义一个script，再进行调用

'''
spam文件
'''

print('from the spam')

def read():
    print('from the read')

#执行文件
import spam

spam.read()

import spam查找模块的顺序：先找内存:sys.modules-----》再找内建---------->最后找sys.path

 3.1当第一次导入了模块，就已经存在了内存，反复导入模块，都是从内存里面引用的。当你把模块删除了，那么就无法运行。

 

import spam #当第一次导入模块，那么就只执行这一次，下面的导入都不会在执行。
import spam
import spam
import spam
import spam
import spam

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

 

3.2每一个定义的模块都有一个自己的名称空间，都不会和全局的名称空间有关联。所以在全局定义的变量，是不会影响模块里面名称空间

 

#spam文件
x = 10000
print('from the spam')

def read():
    print('from the read')

#调用spam的文件
import spam
x = 1
spam.x

'''
结果：
10000
from the spam
'''

 

3.3总结：首次导入模块spam时会做的三件事：

1.为源文件（spam模块）创建新的名称空间，在spam中定义的函数和方法若是使用到了globa

时访问的就是这个名称空间

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

提示：导入模块时到底执行了什么？

事实上韩式定义也是'被执行'的语句，模块级别韩式定义的执行将函数名放入模块全局名称空间表，用globals()可以查看

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

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

文件中定义的名字，span.名字与test.py中的名字来自两个完全不同的地方。

 

3.4为模块起别名：import spam as s

  为已经导入的模块起别名的方式对编写可扩展的代码很有用，假设有两个模块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)

3.5在一行导入多个模块

import sys,os,time

 

3.6 from.....import....的使用

在from语句想到与import，也会创建新的名称空间，但是将spam中的名字直接导入到当前的

名称空间中，在当前名称空间中，直接使用名字就可了

from spam import read1   #直接调用该函数方法就可以
read() #执行spam模块中的read()函数

 

这样在当前的位置直接使用read1和read2就好了。执行时,仍然以spam.py文件为全局名称空间

 

from spam import read2
read2()
'''
在执行read2的时候，也还是回到spam的名称空间去找，先找到read2，再去执行函数里面的内容，不会阻碍read1的执行
'''

 

 

 

如果在执行的文件中，有一个和模块中的函数名重名的话，就会执行执行文件中的函数

from spam import read2

def read2():
    print('test read2')
read2()
'''
结果：
test read2
'''

 

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

 

from spam import * #将spam里面所有的名字导入到当前文件中
print(money)
read1()
read2()
change()

'''
结果：
11111111111111111
1000
spam->read1->money 1000
read2->
spam->read1->money 1000
from the change 0
'''

 

 

 

可以使用__all__来控制*(用于发布新版本)

在spam.py文件中新增一行

__all__ =  ['money','read1']#在执行的文件中只能调用我在列表中规定的着两个元素。

 

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

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

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

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

 

3.7把模块当做脚本执行

我们可以通过模块的全局变量__name__来查看模块名：

当做脚本运行：

__name__ == '__main__':
当做模块导入：
__name__ = 
作用：用来控制.py文件呢在不同的应用场景下执行不同的逻辑
if __name__ == '__main__':

3.8模块搜索路径

python解释器在启动时会自动加载一些模块，可以使用sys.modules查看

在第一次导入某个模块时（比如spam），会先检查该模块是否已经被加载到内存中（当前执行文件的名称空间对应的内存），如果有则直接引用

如果没有，解释器则会查找同名的内建模块，如果还没有找到就从sys.path给出的目录列表中依次寻找spam.py文件。

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

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

 

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

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

 

 注意：搜索时按照sysy.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')

 

 

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

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

 

 二包

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

无论是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)

 

 2.1注意事项

1.关于包相关的导入语句也分为import和from ... import ...两种，但是无论哪种，无论在什么位置，在导入时都必须遵循一个原则：凡是在导入时带点的，点的左边都必须是一个包，否则非法。可以带有一连串的点，如item.subitem.subsubitem,但都必须遵循这个原则。

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

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

 2.2import

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

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

 

2.3from....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')

 

2.4__init__.py文件

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

2.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仍然不能导入）。

2.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 

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

 

特别需要注意的是：可以用import导入内置或者第三方模块，但是要绝对避免使用import来导入自定义包的子模块，应该使用from... import ...的绝对或者相对导入,且包的相对导入只能用from的形式。

 

from glance.api import versions

'''
执行结果:
ImportError: No module named 'policy'
'''

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

 

2.7单独导入包

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

 

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