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

时间:2022-02-22 17:03:14

模块自定义

  上节说了有关模块的知识,当时所说的模块都是内置模块,现在来看自己定制的模块,即模块也可以自定义。

  模块的自定义就是指写一段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
'''

模块可以起别名,方式为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被更改了,也就是说这种导入模块的方式是有被覆盖的潜在可能的,所以我们要视需求选择导入的方式

注: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模块名称空间的方式。

1. 无论是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来自俩个命名空间

假设我们有这么一个包:

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


文件中的内容如下:

#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的形式。

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

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

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

单独导入包

  单独导入包名称时不会导入包中所有包含的所有子模块,解决的方法是在包的子文件夹中的子文件写入导的过程,如:

#在与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*的使用方法

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