what's the python之自定义模块和包

模块自定义

　　上节说了有关模块的知识，当时所说的模块都是内置模块，如今来看本身定制的模块，即模块也能够自定义。

　　模块的自定义就是指写一段python文件，通常状况下里面包含了可执行的语句和函数的定义，其实自定义的模块和内置模块的效果同样，都是使之后程序的操做更加方便，不用重复敲同样的代码，直接导入模块就可使用。导入方式与内置模块相同，import+文件名，固然，自定义的模块增长了许多其余的导入方式，下文咱们会详细介绍。

须要特别注意的是：咱们自定义的模块名不该该与系统内置模块重名。

　　如今咱们来自定义一个模块：

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

money=1000

def read1():
    print('my_moudle->read1->money',money)

def read2():
    print('my_moudle->read2 calling read1')
    read1()

def change():
    global money
    money=0

 

接下来就是示例模块的导入操做：

#另外一个文件
import my_moudle #只在第一次导入时才执行my_moudle.py内代码,此处的显式效果是只打印一次'from the my_moudle.py',固然其余的顶级代码也都被执行了,只不过没有显示效果.
import my_moudle#都没被执行
import my_moudle#都没被执行
import my_moudle#都没被执行

'''
执行结果：
from the my_moudle.py
'''

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

 

　　每个模块都是独立的命名空间，程序在导入模块的时候就已经开辟了一个独立的名称空间，这样也就是说若是咱们在程序的全局中给一个变量赋值，但刚好模块中也存在这个变量时，模块中的该变量的值不会被更改，咱们赋值的那个变量存在于全局中，也就是说不管咱们在文件中怎么操做，都不会改变模块中的内容。

注：实际上是有一个方式能够改变模块中的内容的，但咱们不会去那么作，由于这意味着你辛苦建立的模块会被别人篡改，就存在着很大的风险

下面咱们进行一个小测试，自定义的模块即上文中的my_moudle

#测试一:money与my_moudle.money不冲突
#demo.py
import my_moudle 
money=10
print(my_moudle.money)#全局中的赋值不会改变模块中相同变量的值

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


#测试二：read1与my_moudle.read1不冲突
#demo.py
import my_moudle
def read1():
    print('========')
my_moudle.read1()#就算新定义了一个与模块中的函数同名的函数，也不会改变什么，只是在全局中存在了一个新的函数

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






#测试三：执行my_moudle.change()操做的全局变量money仍然是my_moudle中的
#demo.py
import my_moudle
money=1
my_moudle.change()
print(money)#此时模块中的变量值被改变，这就是改变模块内容的方法，不推荐使用

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

View Code

 

模块能够起别名，方式为import my_moudle as mmd，以后的使用中就能够用mmd来代替my_moudles

这有什么用呢？来看下面两种应用场景：

　　应用场景一：

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

#mysql.py（第一个文件，咱们定义的myspl模块）
def sqlparse():
    print('from mysql sqlparse')

#oracle.py（第二个文件，咱们定义的oracle模块）
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()#这样作就能够在以后的程序中只用db做为模块名，而db的功能实际上是根据用户选择的模块相同
#即咱们用了一个相似于虚拟的名字，但却能够根据状况不一样随时变身而后行使不一样的能力

　　应用场景二：

　　　　为已经导入的模块起别名的方式对编写可扩展的代码颇有用，假设有两个模块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)
#神奇吧，咱们只用reader可是却能够发挥不一样的效果

注：模块在导入时不只能够一行导入一个模块，还能够一行导入多个，如：import sys,os,re

 

模块导入的另外一种方法：from+模块名+import+要导入的内容

　　咱们知道import my_moudle的导入方式，会将源文件的名称空间'my_moudle'带到当前名称空间中，当前名称空间中有全部源文件名称空间的内容，而且使用时必须是my_moudle.名字的方式。而from 语句至关于import，也会建立新的名称空间，可是是将my_moudle中import后面要导入到内容直接导入到当前的名称空间中，在当前名称空间中，直接使用导入到内容的名字就能够了。

下面咱们来测试这种方式导入的模块的一些特性：（与直接导入模块有相同之处也有不一样支持）

#测试一：导入的函数read1，执行时仍然回到my_moudle.py中寻找全局变量money

from my_moudle import read1
money=1000
read1()
'''
执行结果:
from the my_moudle.py
spam->read1->money 1000
与import my_moudle的性质相同
'''


#测试二:导入的函数read2，执行时须要调用read1(),仍然回到my_moudle.py中找read1()
#demo.py
from my_moudle import read2
def read1():#在全局中又定义的read1，但对模块无影响
    print('==========')
read2()

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



#测试三:导入的函数read1，被当前位置定义的read1覆盖掉了
#demo.py
from my_moudle import read1
def read1():
    print('==========')
read1()
'''
执行结果:
from the my_moudle.py
==========
'''
#注意，这里的read1被更改了，也就是说这种导入模块的方式是有被覆盖的潜在可能的，因此咱们要视需求选择导入的方式

View Code

注：python中的变量赋值不是一种存储操做，而只是一种绑定关系。因此变量的值被修改就是变量更改了其绑定的值，而内存中没有被绑定的值就会被回收，从内存中抹去

　　这种导入方法也支持取别名，也支持一行导入多个，与直接导入模块相同

 

模块的还有一种导入方式是from+模块名+import+*，这个方式就是将模块中除了下划线开头的名字的内容，其余的都导入到当前位置。固然，做为模块的那个文件，若是有不想被人调用的东西，在文件中加入__all__=[不想被导入的内容，如：‘money’，‘read1’]，这样就不会被以from+模块名+import+*的方式导入。可是！大部分状况下咱们的python程序不该该使用这种导入方式，由于*你不知道你导入什么名字，颇有可能会覆盖掉你以前已经定义的名字。并且可读性极其的差，在交互式环境中导入时没有问题。因此啊，尽可能使用上面两种导入方式吧。

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

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

 

　　模块也能够当作脚本运行，咱们能够经过模块的全局变量__name__来查看模块名：

当模块作为脚本运行时：
print(__name__)#'__main__'

当作为模块导入到当前文件时：
print(__name__)= 模块名

做用：用来控制.py文件在不一样的应用场景下执行不一样的逻辑

def fib(n):   
    a, b = 0, 1
    while b < n:
        print(b, end=' ')
        a, b = b, a+b
    print()

if __name__ == "__main__":
    print(__name__)
    num = input('num :')
    fib(int(num))

 

模块搜索路径

　　python解释器在启动时会自动加载一些模块，可使用sys.modules查看。在第一次导入某个模块时（好比my_moudle），会先检查该模块是否已经被加载到内存中（当前执行文件的名称空间对应的内存），若是有则直接引用。若是没有，解释器则会查找同名的内建模块，若是尚未找到就从sys.path给出的目录列表中依次寻找my_moudle.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归档文件当成一个目录去处理。

 

#首先制做归档文件：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文件，所以必定要事先建立他们，来避免加载模块是性能降低。

 

 编译Python文件

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

　　Python检查源文件的修改时间与编译的版本进行对比，若是过时就须要从新编译。这是彻底自动的过程。而且编译的模块是平台独立的，因此相同的库能够在不一样的架构的系统之间共享，即pyc使一种跨平台的字节码，是由python虚拟机来执行的，可是pyc的内容跟python的版本相关，不一样的版本编译后的pyc文件不一样，2.5编译的pyc文件不能到3.5上执行，而且pyc文件是能够反编译的，于是它的出现仅仅是用来提高模块的加载速度的。

 

了解部分：

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

python -m my_moudle.py

　　2 若是源文件不存在，那么缓存的结果也不会被使用，若是想在没有源文件的状况下来使用编译后的结果，则编译后的结果必须在源目录下 

提示：

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

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

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

-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

了解

附：dir()能够用来查找模块中定义的名字，返回一个有序字符串列表。dir()不会列举出内建函数或者变量的名字，它们都被定义到了标准模块builtin中，能够列举出它们，

 

---

 

 包

　　包其实也是模块的一种类型，不过不一样的是包不是指一个文件，而是文件夹的类型

　　包是一种经过使用“.模块名”来组织python模块名称空间的方式。

１. 不管是import形式仍是from...import形式，凡是在导入语句中（而不是在使用时）遇到带点的，都要第一时间提升警觉：这是关于包才有的导入语法

2. 包是目录级的（文件夹级），文件夹是用来组成py文件（包的本质就是一个包含__init__.py文件的目录）

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

强调：

　　1. 在python3中，即便包下没有__init__.py文件，import 包仍然不会报错，而在python2中，包下必定要有该文件，不然import 包报错

　　2. 建立包的目的不是为了运行，而是被导入使用，记住，包只是模块的一种形式而已，包即模块

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

假设咱们有这么一个包：

文件中的内容以下：

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

 

下面咱们来学习有关包的知识点。

import和from+文件夹的名字+import+文件名

举例说明：

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



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

from glance.db.models import register_models
register_models('mysql')
#须要注意的是from后import导入的模块，必须是明确的一个不能带点，不然会有语法错误，如：from a import b.c是错误语法

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

 

from glance.api import *

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

此处是想从包api中导入全部，实际上该语句只会导入包api下__init__.py文件中定义的名字，咱们能够在这个文件中定义__all___:

#在__init__.py中定义
x=10

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

__all__=['x','func','policy']
#policy是与__init__同级的文件，这里引入policy但不引入version是为了举例说明
#此时咱们在于glance同级的文件中执行from glance.api import *就导入__all__中的内容（versions仍然不能导入）。

注意：

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

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

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

 

绝对导入和相对导入

咱们的最顶级包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()

注：在使用pycharm时，有的状况会为咱们多作一些事情，这是软件相关的东西，会影响咱们对模块导入的理解，于是在测试时，必定要回到命令行去执行，模拟咱们生产环境

特别须要注意的是：能够用import导入内置或者第三方模块（已经在sys.path中），可是要绝对避免使用import来导入自定义包的子模块(没有在sys.path中)，应该使用from... import ...的绝对或者相对导入,且包的相对导入只能用from的形式。

这里利用图片对绝对导入和相对导入作一份相对详细的解释：

 

 

单独导入包

　　单独导入包名称时不会导入包中全部包含的全部子模块，解决的方法是在包的子文件夹中的子文件写入导的过程，如：

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

 

有关__all__和from...import*的使用方法