Python自动化运维之模块与包的使用

Posted 2020-10-01

一、模块
1、什么是模块？
一个模块就是一个包含了python定义和声明的文件，文件名就是模块名字加上.py的后缀。
2、为何要使用模块？
如果你退出python解释器然后重新进入，那么你之前定义的函数或者变量都将丢失，因此我们通常将程序写到文件中以便永久保存下来，需要时就通过python test.py方式去执行，此时test.py被称为脚本script。

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

3、如何使用模块？
3.1、import
实例文件：spam.py ，文件名：spam.py ,模块名：spam

#spam.py
print(‘from the spam.py‘)
money=1000
def read1():
    print(‘spam->read1‘,money)
def read2():
    print(‘spam->read2‘)
    read1()
def change():
    global money #声明为全局名称空间
    money=0 #重新给money赋值

3.1.1、模块可以包含可执行的语句和函数的定义，这些语句的目的是初始化模块，它们只在模块名第一次遇到导入import语句时才执行
　　import语句是可以在程序中的任意位置使用的,且针对同一个模块很import多次,为了防止你重复导入，python的优化手段是：第一次导入后就将模块名加载到内存了，后续的import语句仅是对已经加载大内存中的模块对象增加了一次引用，不会重新执行模块内的语句，如下：

import spam #只在第一次导入时才执行spam.py内代码,此处的显式效果是只打印一,
import spam #次‘from the spam.py‘,当然其他的顶级代码也都被执行了,只不过没有显示效果。
import spam
import spam

执行结果：

from the spam.py

我们可以从sys.module中找到当前已经加载的模块，sys.module是一个字典，内部包含模块名与模块对象的映射，该字典决定了导入模块时是否需要重新导入。
3.1.2、每个模块都是一个独立的名称空间，定义在这个模块中的函数，把这个模块的名称空间当做全局名称空间，这样我们在编写自己的模块时，就不用担心我们定义在自己模块中全局变量会在被导入时，与使用者的全局变量冲突。
#测试一:money与spam.money不冲突

import spam
money = 123123
print(spam.money)
-执行结果：
from the spam.py
1000
#测试二：read1与spam.read1不冲突
import spam
def read1():
    print("---------->")
spam.read1()

执行结果：

from the spam.py
spam->read1 1000

#测试三：执行spam.change()操作的全局变量money仍然是spam中的
import spam
money = 999
spam.change() #更改的是spam里的money
print(money)

执行结果：

from the spam.py
999

3.1.3、总结：
首次导入模块spam时会做三件事：
第一件事：创建名称空间，用来存放spam.py中定义的名字；
第二件事：基于刚刚创建的名称空间来执行spam.py；
第三件事：创建名字spam指向该名称空间，spam.名字的操作，都是以spam.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)

3.1.5、在一行导入多个模块

import os,sys,re

3.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
read1()
执行结果：
from the spam.py
spam->read1 1000

 
测试二:导入的函数read2，执行时需要调用read1(),仍然回到spam.py中找read1()

#test.py
from spam import read2
def read1():
    print(‘==========‘)
read2()

 执行结果：

from the spam.py
spam->read2
spam->read1 1000

测试三:导入的函数read1，被当前位置定义的read1覆盖掉了

#test.py
from spam import read1
def read1():
    print("===========>")
read1() #重名时，会覆盖导入的名称

执行结果：

from the spam.py
===========>

需要特别强调的一点是：python中的变量赋值不是一种存储操作，而只是一种绑定关系，如下：

from spam import money,read1
money = 999 #将当前位置的名字money绑定到了999
print(money) #打印当前的名字
read1() #调用spam.py中的名字money,仍然为1000

执行结果：

from the spam.py
999
spam->read1 1000

3.2.2、也支持as

from spam import read1 as read

3.2.3、也支持导入多行

from spam import (money,read1,read2)

　　3.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 0x00000000028CA9D8>
<function read2 at 0x00000000028CA950>
<function change at 0x00000000028CAA60>

可以使用__all__来控制*（用来发布新版本）
在spam.py中新增一行
__all__=[‘money‘,‘read1‘] #这样在另外一个文件中用from spam import *就这能导入列表中规定的两个名字，不在列表里的无法调用
3.2.5、考虑到性能的原因，每个模块只被导入一次,放入字典sys.modules中，如果你改变了模块的内容，你必须重启程序，python不支持重新加载或卸载之前导入的模块。有的同学可能会想到直接从sys.modules中删除一个模块不就可以卸载了吗，注意了，你删了sys.modules中的模块对象仍然可能被其他程序的组件所引用，因而不会被清楚。特别的对于我们引用了这个模块中的一个类，用这个类产生了很多对象，因而这些对象都有关于这个模块的引用。
3.3、把模块当做脚本执行
我们可以通过模块的全局变量__name__来查看模块名：
当做脚本运行：

__name__ 等于‘__main__‘

当做模块导入：

__name__=

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

if __name__ == ‘__main__‘:
print(__name__) #被当成脚本文件执行时
if __name__ == ‘__main__‘:
    print("此时被当做脚本去执行")

执行结果：

__main__

此时被当做脚本去执行
被当成模块导入的时候：

import spam

#当导入模块时，就会执行模块，模块有两个打印效果，此时spam不是当成脚本运行了，so，就不会执行下面的代码。
执行结果：

spam #打印了模块名

3.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归档文件当成一个目录去处理。
#首先制作归档文件：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文件，因此一定要事先创建他们，来避免加载模块是性能下降。

3.5、编译Python文件
　　为了提高模块的加载速度，Python缓存编译的版本，每个模块在__pycache__目录的以module.version.pyc的形式命名，通常包含了python的版本号，如在CPython版本3.6，关于spam.py的编译版本将被缓存成__pycache__/spam.cpython-36.pyc，这种命名约定允许不同的版本，不同版本的Python编写模块共存。
　　Python检查源文件的修改时间与编译的版本进行对比，如果过期就需要重新编译。这是完全自动的过程。并且编译的模块是平台独立的，所以相同的库可以在不同的架构的系统之间共享，即pyc使一种跨平台的字节码，类似于JAVA火.NET,是由python虚拟机来执行的，但是pyc的内容跟python的版本相关，不同的版本编译后的pyc文件不同，2.5编译的pyc文件不能到3.6上执行，并且pyc文件是可以反编译的，因而它的出现仅仅是用来提升模块的加载速度的。
提示：
　　1、模块名区分大小写，foo.py与FOO.py代表的是两个模块；
　　2、你可以使用-O或者-OO转换python命令来减少编译模块的大小；
3.6、标准模块
python提供了一个标准模块库，一些模块被内置到解释器中，这些提供了不属于语言核心部分的操作的访问，但它们是内置的，无论是为了效率还是提供对操作系统原语的访问。这些模块集合是依赖于底层平台的配置项，如winreg模块只能用于windows系统。特别需要注意的是，sys模块内建在每一个python解释器
sys.ps1
sys.ps2
这俩只在命令行有效，得出的结果，标识了解释器是在交互式模式下。
变量sys.path是一个决定了模块搜索路径的字符串列表，它从环境变量PYTHONOATH中初始化默认路径，如果PYTHONPATH没有设置则从内建中初始化值，我们可以修改它

sys.path.append：
import os
os.path.normpath(path)  #规范化路径，转换path的大小写和斜杠
a=‘/Users/jieli/test1/\\\a1/\\\\aa.py/../..‘
print(os.path.normpath(a))

打印结果：

\Users\jieli\test1

#具体应用

import os,sys
possible_topdir = os.path.normpath(os.path.join(
    os.path.abspath(__file__),
    os.pardir, #上一级
    os.pardir,
    os.pardir
))
sys.path.insert(0,possible_topdir)

3.7、dir()函数
内建函数dir是用来查找模块中定义的名字，返回一个有序字符串列表

import spam
dir(spam)

如果没有参数,dir()列举出当前定义的名字
dir()不会列举出内建函数或者变量的名字，它们都被定义到了标准模块builtin中，可以列举出它们，

import builtins
dir(builtins)

本文出自 “炫维” 博客，请务必保留此出处http://xuanwei.blog.51cto.com/11489734/1953467