模块与包

一 模块

1. 如果模块是被导入，__name__的值为模块名字
2. 如果模块是被直接执行，__name__的值为’__main__’
Py1.py
#！/usr/bin/env python
def test():
    print('__name__ = ',__name__)
if __name__ == '__main__':
    test()
Py2.py
#！/usr/bin/env python
import Py1.py
 
def test():
    print '__name__ = ',__name__
if __name__ == '__main__':
    test()
    print('Py1.py __name__ = ’,Py1.__name__)
执行结果：
__name__=__main__
Py1.py __name__=Py1

 

 

 根据配置导入模块"scrapy.middlware.C1"
import importlib
path = "scrapy.middlware.C1"
md,cls = path.rsplit('.',maxsplit=1)
m = importlib.import_module(md)
getattr(m,cls)

 

1.如何使用模块？

1.1 import

示例文件：spam.py，文件名spam.py,模块名spam

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

money=1000

def read1():
    print('spam->read1->money',1000)

def read2():
    print('spam->read2 calling read')
    read1()

def change():
    global money
    money=0

1.1.1 模块可以包含可执行的语句和函数的定义，这些语句的目的是初始化模块，它们只在模块名第一次遇到导入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
'''

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

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

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

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

#测试二：read1与spam.read1不冲突
#test.py
import spam
def read1():
    print('========')
spam.read1()

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

#测试三：执行spam.change()操作的全局变量money仍然是spam中的
#test.py
import spam
money=1
spam.change()
print(money)

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

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

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

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

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

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

3.1.4 为模块名起别名，相当于m1=1;m2=m1

import spam as sm
print(sm.money)

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

1.1.5 在一行导入多个模块

 import sys,os,re

1.2 from ... import...

3.2.1 对比import spam，会将源文件的名称空间'spam'带到当前文件创建同源文件的名称空间，使用时必须是spam.名字的方式调用，而from 语句相当于import，也会创建新的名称空间，但是是将spam中的名字直接导入到当前的名称空间中，在当前名称空间中，直接使用名字就可以了。

from spam import read1,read2

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

#测试一：导入的函数read1，执行时仍然回到spam.py中寻找全局变量money
#test.py
from spam import read1
money=1000
read1()
'''
执行结果:
from the spam.py
spam->read1->money 1000
'''

#测试二:导入的函数read2，执行时需要调用read1(),仍然回到spam.py中找read1()
#test.py
from spam import read2
def read1():
    print('==========')
read2()

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

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

#测试三:导入的函数read1，被当前位置定义的read1覆盖掉了
#test.py
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
'''

2.2.2 也支持as

from spam import read1 as read

2.2.3 也支持导入多行

 from spam import (read1,
                   read2,
                   money)

2.2.4 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 *就这能导入列表中规定的两个名字

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

2.3 把模块当做脚本执行

我们可以通过模块的全局变量__name__来查看模块名：在模块文件中写入：print(__name__)

作用：用来控制.py文件在不同的应用场景下执行不同的逻辑
if __name__ == '__main__':   #只有模块当成脚本时才执行，在此代码块写一些执行效果的代码，模块一般只写名字的定义（变量名、函数名、类名、导入的模块名）

 

2.4 模块搜索路径

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') #排在前的目录，优先被搜索

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

2.5 编译python文件

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

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

提示：

1.模块名区分大小写，foo.py与FOO.py代表的是两个模块

2.你可以使用-O或者-OO转换python命令来减少编译模块的大小

 -O转换会帮你去掉assert语句
 -OO转换会帮你去掉assert语句和__doc__文档字符串
 由于一些程序可能依赖于assert语句或文档字符串，你应该在在确认需要的情况下使用这些选项。

3.在速度上从.pyc文件中读指令来执行不会比从.py文件中读指令执行更快，只有在模块被加载时，.pyc文件才是更快的

4.只有使用import语句是才将文件自动编译为.pyc文件，在命令行或标准输入中指定运行脚本则不会生成这类文件。

2.7 dir()函数

二 包

包是一种通过使用‘.模块名’来组织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 ...两种，但是无论哪种，无论在什么位置，在导入时都必须遵循一个原则：凡是在导入时带点的，点的左边都必须是一个包。

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

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

2.2 import

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

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

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

2.4 __init__.py文件

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

#在test文件中

from glance.api import policy   #执行glance、api下的__init__文件

import glance.api 　　#执行glance、api下的__init__文件

glance.api.policy　　　#上一步导入policy模块不成功，报错

2.5 from glance.api import *

在讲模块时，我们已经讨论过了从一个模块内导入所有*，此处我们研究从一个包导入所有*。

此处是想从包api中导入所有，实际上该语句只会导入包api下__init__.py文件中定义的名字，我们可以在这个文件中定义__all___，__all__只和*对应。

#在__init__.py中定义
x=10

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

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

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

'policy'模块，policy.get（）就可以调用了。

2.6 绝对导入和相对导入

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

绝对导入：以glance作为起始 

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

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

 在glance/api/__init__.py 
 #绝对导入
 from glance.cmd import manage　　#以test.py的sys.path为准 
  
 #相对导入
 from ..cmd import manage #..代表上一级路径  .代表当前路径  __init__.py的路径为准  

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

import glance.api 
glance.api.manage.main()

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

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

在test中设置固定的导入路径：

import sys,os
base_dir=os.path.dirname(os.path.dirname(os.path.abspath(__file__))) #获取包的路径
sys.path.append(r'%s\aaa' %(base_dir))#经路径添加进sys.path
os.path.abspath(path)  返回path规范化的绝对路径
os.path.dirname(path)  返回path的目录。其实就是os.path.split(path)的第一个元素