大话python模块与包

前言

　　眼看着老掌门年纪越来越大，掌门之位的传承也成了门派中的一件大事。这天，老掌门把小掌门叫到跟前，语重心长地说道：孩子啊，以后你就要继任掌门之位了，我就传授此生所学的绝世功法与你，以后可要悉心学习，潜心修炼。藏经洞便是功法所在之处，今日你去取了便是。小掌门听完这内心可犯了嘀咕，藏经洞他可是去过，里面的书籍千千万还乱成一团。在这些书堆中找出一两本功法无异于大海捞针啊。“这次对于藏经洞整改也是交给你的任务，门派历史悠久，教派文化源远流长，自从上次“万教论道“后，藏经洞内的摆放也是乱作一窝粥，这次书籍的整理问题就交给你了” 老掌门对小掌门微微一笑，转身回屋了。

模块与包

　　这下小掌门可犯了难，漫漫书洞浩如烟海，整理起来又岂非易事，于是小掌门去找门派扫地僧去寻求帮助。“老朽且教你一招，此招名为白夜飞花，精于此功可夜行如白昼，落叶飞花信手拈来。不过此功也有冒险之处，你可知那缥缈峰的傻姑，其名原为傻秋，早些年因此功走火入魔，这个稍后再细说，下面就说说精要。”扫地僧收起扫帚灿灿笑道。

什么是模块

　　"老掌门分给你的任务是整理书籍,首先你就得对这些书籍进行分类汇总。在藏经洞中你可以用书架或者木盒，把每一类的书籍给装起来，这个书架或者木盒就好比于那些苦逼的程序员所用的模块，一般他们所说的模块包括为四类：”

　　 使用python编写的代码（.py文件）

　　 已被编译为共享库或DLL的C或C++扩展

　　 包好一组模块的包

　　 使用C编写并链接到python解释器的内置模块

而你的木盒或者书架，就可以分为内功心法，功法，炼丹要术，医药典籍等等。对于模块来说，其目的就是：

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

这木盒或书架的作用就是方便管理了，扫地僧煞有介事地说道。

模块的使用

　　“对于书架或者木盒如何操作，那些苦逼程序员的做法也很值得我们借鉴。对于模块使用他们可有一套流程。这你得给老朽沏壶好茶与你慢慢细说”扫地僧捋起长须笑道。

　　import

　　我就给先你说说import  一般程序中导入包可这样引用

　　示例文件目录（tips：情景描述，实际开发时文件夹or文件名尽量不要用中文）：

　　

　　

def func():
    print("欲练此功，必先...")

python之禅.py文件内容

模块的引入：import xxx    or   from  xxx  import   xxx

如我们在修炼.py中导入“python之禅”模块，"修炼.py"内容如下：

 import python之禅

 python之禅.func()

运行，如下效果

同时，我们还可以对导入模块进行重命名，如下

import   as

import python之禅 as gumupai #import xxx as 重命名

gumupai.func()

运行结果如上

也可以导入多个文件，import 模块1，模块2，模块3...

import python之禅,玉笛清心咒,炼火诀

gumupai.func()

from ... import ...

对比import python之禅，会将源文件的名称空间'python之禅'带到当前名称空间中，使用时必须是'python之禅.名字'的方式

而from 语句相当于import，也会创建新的名称空间，但是将'python之禅'中的名字直接导入到当前的名称空间中，在当前名称空间中，直接使用名字就可以了

 from python之禅 import func

 func()

from ... import *

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

我们先修改 'python之禅.py' 内容如下：

 surprise="恭喜获得python传承"

 def my_fun():
     print("大道至简")

 def func():
     print("欲练此功，必先...")

python之禅内容

'修炼.py' 内容如下

 from python之禅 import *

 func()
 print(surprise)

运行：

在python之禅中新增一行

__all__=['my_fun','func']#这样在另外一个文件中用from python.之禅 import *就这能导入列表中规定的两个名字

如果在   'python之禅.py'   中的变量或者函数名加上_,则 from python之禅  import * 时不能被导入

把模块当作脚本执行

我们可以通过模块的全局变量__name__来查看模块名：
当做脚本运行：
__name__ 等于'__main__'

当做模块导入：
__name__= 模块名

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

from python之禅 import *

if __name__ == '__main__':
    func()
    my_fun()

模块搜索路径

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

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

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

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

sys.path的初始化的值来自于：

The directory containing the input script (or the current directory when no file is specified).
PYTHONPATH (a list of directory names, with the same syntax as the shell variable PATH).
The installation-dependent default.

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

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

 >>> import sys
 >>> sys.path.append('/a/b/c/d')
 >>> sys.path.insert(,'/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(,r'C:\Users\Administrator\PycharmProjects\a')

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

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

以下是官网解释

当一个命名为my_module的模块被导入时
    解释器首先会从内建模块中寻找该名字
    找不到，则去sys.path中找该名字

sys.path从以下位置初始化
执行文件所在的当前目录
PTYHONPATH（包含一系列目录名，与shell变量PATH语法一样）
依赖安装时默认指定的

注意：在支持软连接的文件系统中，执行脚本所在的目录是在软连接之后被计算的，换句话说，包含软连接的目录不会被添加到模块的搜索路径中

在初始化后，我们也可以在python程序中修改sys.path,执行文件所在的路径默认是sys.path的第一个目录，在所有标准库路径的前面。这意味着，当前目录是优先于标准库目录的，需要强调的是：我们自定义的模块名不要跟python标准库的模块名重复，除非你是故意的

关于包

“咦，前辈，你不是教我招式给我出主意的吗，怎么给我聊起凡间那些程序员了”，小掌门嘀咕着。“别急别急，等我讲完包，你的问题也就解决了”扫地僧闻了闻茶笑着道

“你的书架或者包是相当于模块，而包就相当于模块或者包所在的区域，老朽就接着以包来给你讲”

包是一种通过使用‘.模块名’来组织python模块名称空间的方式。

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

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

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

强调：

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

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

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

现在我们修改下文件结构

 from 内功心法 import  python之禅

 if __name__ == '__main__':
     python之禅.func()
     python之禅.my_fun()

练习.py内容

from . import  内功心法
print("武学精要的init")

武学精要/__init__.py

from . import python之禅
print("内功心法的init")

内功心法/__init__.py

运行"练习.py"

在上方__init__.py中，用到了from . import xxx  ，下面接着说相对导入与绝对导入

相对导入与绝对导入

绝对导入：以工作目录（武学精要）作为起始

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

我们用到的from . import 内功心法  其实就是相对导入

再说绝对导入，我们修改下__init__.py文件

from 武学精要 import  内功心法
print("武学精要的init")

武学精要/__init__.py

from 武学精要.内功心法 import python之禅
print("内功心法的init")

内功心法/__init__.py

运行“练习.py”

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

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

软件开发流程规范

“行了，模块与包老朽也算给你简单地讲完了，你的书应该知道怎么处理了吧。”扫地僧面带醉意地伸了个懒腰。“先附上一般门派套路，夜晚到我房间来教你白夜飞花”

“老朽刚用通天境看了看你的下次轮回，应该是个苦逼的码农，自求多福吧”老朽要去扫院子了