走入计算机的第二十七天（模块与包的调用）

Posted 2020-09-25 方杰0410

一 模块（module）的概念

在计算机程序的开发过程中，随着程序代码越写越多，在一个文件里代码就会越来越长，越来越不容易维护。

为了编写可维护的代码，我们把很多函数分组，分别放到不同的文件里，每个文件包含的代码就相对较少，很多编程语言都采用这种组织代码的方式。在Python中，一个.py文件就称之为一个模块（Module）。

使用模块的好处：最大的好处是大大提高了代码的可维护性。

其次，编写代码不必从零开始。当一个模块编写完毕，就可以被其他地方引用。我们在编写程序的时候，也经常引用其他模块，包括Python内置的模块和来自第三方的模块。

为何要使用模块？

    如果你退出python解释器然后重新进入，那么你之前定义的函数或者变量都将丢失，因此我们通常将程序写到文件中以便永久保存下来，需要时就通过python test.py方式去执行，此时test.py被称为脚本script。

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

另外，使用模块还可以避免函数名和变量名冲突。相同名字的函数和变量完全可以分别存在不同的模块中，因此，我们自己在编写模块时，不必考虑名字会与其他模块冲突。但是也要注意，尽量不要与内置函数名字冲突。

二 导入模块

   当import要调用python中的模块时，sys.path会帮你寻找到解释器相对应的路径，从当前目录下开始寻找。

   假如在当前目录下存在与要引入模块同名的文件，就会把要引入的模块屏蔽掉。

   当import foo时，首先会立刻创建一个新的名称空间，用来存放所有foo.py中定义的名字；然后会在该名称空间内执行foo.py内所。
   有的代码，最后需要知道的是import关键字，就是定义了一个名字，只不过此刻我们用import定义的是一个模块名字foo，该名字就是指向foo.py的名称空间，而foo.的方式就是从该名称空间里找名字，可以使用foo.__dict__来查看这些名字。

  在新建的名称空间里执行源文件（foo.py）代码时，所有对全局名称空间的引用或修改，都是以foo.py为准，而不是当前文件（test.py）的全局名称空间，每个模块都是一个独立的名称空间，定义在这个模块中的函数，把这个模块的名称空间当做全局名称空间，这样我们在编写自己的模块时，就不用担心我们定义在自己模块中全局变量会在被导入时，与使用者的全局变量冲突

1 #测试一:money与spam.money不冲突
 2 #test.py
 3 import spam 
 4 money=10
 5 print(spam.money)
 6 
 7 \'\'\'
 8 执行结果：
 9 from the spam.py
10 1000
11 \'\'\'




 1 #测试二：read1与spam.read1不冲突
 2 #test.py
 3 import spam
 4 def read1():
 5     print(\'========\')
 6 spam.read1()
 7 
 8 \'\'\'
 9 执行结果:
10 from the spam.py
11 spam->read1->money 1000
12 \'\'\'




1 #测试三：执行spam.change()操作的全局变量money仍然是spam中的
 2 #test.py
 3 import spam
 4 money=1
 5 spam.change()
 6 print(money)
 7 
 8 \'\'\'
 9 执行结果：
10 from the spam.py
11 1
12 \'\'\'

View Code

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

 

1 #test.py 
2 import spam #只在第一次导入时才执行spam.py内代码,此处的显式效果是只打印一次\'from the spam.py\',当然其他的顶级代码也都被执行了,只不过没有显示效果. 
3 import spam 
4 import spam 
5 import spam 
6 
7 \'\'\' 
8 执行结果： 
9 from the spam.py 
10 \'\'\'

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

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

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

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

1 提示:导入模块时到底执行了什么？
2 
3 In fact function definitions are also ‘statements’ that are ‘executed’; the execution of a module-level function definition enters the function name in the module’s global symbol table.
4 事实上函数定义也是“被执行”的语句，模块级别函数定义的执行将函数名放入模块全局名称空间表，用globals()可以查看

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

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

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

1 import spam as sm
2 print(sm.money)

    为已经导入的模块起别名的方式对编写可扩展的代码很有用，假设有两个模块xmlreader.py和csvreader.py，它们都定义了函数read_data(filename):用来从文件中读取一些数据，但采用不同的输入格式。可以编写代码来选择性地挑选读取模块，例如

1 if file_format == \'xml\':
2     import xmlreader as reader
3 elif file_format == \'csv\':
4     import csvreader as reader
5 data=reader.read_date(filename)

3.1.5 在一行导入多个模块

1 import sys,os,re

 三  from…import 语句

其中， from…import* 语句提供了一个简单的方法来导入一个模块中的所有项目。然而这种声明不该被过多地使用。大多数情况， Python程序员不使用这种方法，因为引入的其它来源的命名，很可能覆盖了已有的定义

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

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

 1 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
\'\'\'

View Code

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

#测试三:导入的函数read1，被当前位置定义的read1覆盖掉了
#test.py
from spam import read1
def read1():
    print(\'==========\')
read1()
\'\'\'
执行结果:
from the spam.py
==========
\'\'\'

View Code

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

 

1 from spam import money,read1
 2 money=100 #将当前位置的名字money绑定到了100
 3 print(money) #打印当前的名字
 4 read1() #读取spam.py中的名字money,仍然为1000
 5 
 6 \'\'\'
 7 from the spam.py
 8 100
 9 spam->read1->money 1000
10 \'\'\'

View Code

 

也支持as

1 from spam import read1 as read

也支持导入多行

1 from spam import (read1,
2                   read2,
3                   money)

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

1 from spam import * #将模块spam中所有的名字都导入到当前名称空间
 2 print(money)
 3 print(read1)
 4 print(read2)
 5 print(change)
 6 
 7 \'\'\'
 8 执行结果:
 9 from the spam.py
10 1000
11 <function read1 at 0x1012e8158>
12 <function read2 at 0x1012e81e0>
13 <function change at 0x1012e8268>
14 \'\'\'

可以使用__all__来控制*（用来发布新版本）

在spam.py中新增一行

__all__=[\'money\',\'read1\'] #这样在另外一个文件中用from spam import *就这能导入列表中规定的两个名字

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

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

   特别的对于我们引用了这个模块中的一个类，用这个类产生了很多对象，因而这些对象都有关于这个模块的引用。

   如果只是你想交互测试的一个模块，使用 importlib.reload(), e.g. import importlib; importlib.reload(modulename)，这只能用于测试环境。

def func1():
    print(\'func1\')

1 import time,importlib
2 import aa
3 
4 time.sleep(20)
5 # importlib.reload(aa)
6 aa.func1()

  在20秒的等待时间里，修改aa.py中func1的内容，等待test.py的结果。

  打开importlib注释，重新测试

四  把模块当做脚本执行

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

   当做模块导入：
   __name__=

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

 1 #fib.py
 2 
 3 def fib(n):    # write Fibonacci series up to n
 4     a, b = 0, 1
 5     while b < n:
 6         print(b, end=\' \')
 7         a, b = b, a+b
 8     print()
 9 
10 def fib2(n):   # return Fibonacci series up to n
11     result = []
12     a, b = 0, 1
13     while b < n:
14         result.append(b)
15         a, b = b, a+b
16     return result
17 
18 if __name__ == "__main__":
19     import sys
20     fib(int(sys.argv[1]))
21 
22 
23 执行
24 
25 1 #python fib.py <arguments>
26 2 python fib.py 50 #在命令行

五  搜索模块的路径

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

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

如果没有，解释器则会查找同名的内建模块，如果还没有找到就从sys.path给出的目录列表中依次寻找spam.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,路径放到前面的优先于标准库被加载。

1 >>> import sys
2 >>> sys.path.append(\'/a/b/c/d\')
3 >>> sys.path.insert(0,\'/x/y/z\') #排在前的目录，优先被搜索

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

1 #首先制作归档文件：zip module.zip foo.py bar.py
2 
3 import sys
4 sys.path.append(\'module.zip\')
5 import foo,bar
6 
7 #也可以使用zip中目录结构的具体位置
8 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提供了一个标准模块库，一些模块被内置到解释器中，这些提供了不属于语言核心部分的操作的访问，但它们是内置的，无论是为了效率还是提供对操作系统原语的访问。这些模块集合是依赖底       层平台的配置项，如winreg模块只能用于windows系统。特别需要注意的是，sys模块内建在每一个python解释器

  sys.ps1
  sys.ps2
   这俩只在命令行有效，得出的结果，标识了解释器是在交互式模式下。
   变量sys.path是一个决定了模块搜索路径的字符串列表，它从环境变量PYTHONOATH中初始化默认路径，如果PYTHONPATH没有设置则从内建中初始化值，我们可以修改它
sys.path.append

 1 import os
 2 os.path.normpath(path)  #规范化路径，转换path的大小写和斜杠
 3 
 4 a=\'/Users/jieli/test1/\\\\\\a1/\\\\\\\\aa.py/../..\'
 5 print(os.path.normpath(a))
 6 \'\'\'
 7 打印结果：
 8 \\Users\\jieli\\test1
 9 \'\'\'
10 
11 
12 #具体应用
13 import os,sys
14 possible_topdir = os.path.normpath(os.path.join(
15     os.path.abspath(__file__),
16     os.pardir, #上一级
17     os.pardir,
18     os.pardir
19 ))
20 sys.path.insert(0,possible_topdir)

View Code

七  dir()函数

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

如果没有参数,dir()列举出当前定义的名字

dir()不会列举出内建函数或者变量的名字，它们都被定义到了标准模块builtin中，可以列举出它们，
import builtins
dir(builtins)

八  包(package)

Packages are a way of structuring Python’s module namespace by using “dotted module names”

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

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

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

3. import导入文件时，产生名称空间中的名字来源于文件，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

View Code

1 #文件内容
 2 
 3 #policy.py
 4 def get():
 5     print(\'from policy.py\')
 6 
 7 #versions.py
 8 def create_resource(conf):
 9     print(\'from version.py: \',conf)
10 
11 #manage.py
12 def main():
13     print(\'from manage.py\')
14 
15 #models.py
16 def register_models(engine):
17     print(\'from models.py: \',engine) 

View Code

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

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

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

 

 

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

 

1 import glance.db.models
2 glance.db.models.register_models(\'mysql\') 

 

 

  2   需要注意的是from后import导入的模块，必须是明确的一个不能带点，否则会有语法错误，如：from a import b.c是错误语法

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

1 from glance.db import models
2 models.register_models(\'mysql\')
3 
4 from glance.db.models import register_models
5 register_models(\'mysql\')

3 __init__.py文件

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

4  from glance.api import *

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

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

1 #在__init__.py中定义
2 x=10
3 
4 def func():
5     print(\'from api.__init.py\')
6 
7 __all__=[\'x\',\'func\',\'policy\']

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

  九   绝对导入和相对导入

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

绝对导入：以glance作为起始

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

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

1 在glance/api/version.py
2 
3 #绝对导入
4 from glance.cmd import manage
5 manage.main()
6 
7 #相对导入
8 from ..cmd import manage
9 manage.main()

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

1 from glance.api import versions 

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

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

比如我们想在glance/api/versions.py中导入glance/api/policy.py，有的同学一抽这俩模块是在同一个目录下，十分开心的就去做了，它直接这么做

1 #在version.py中
2 
3 import policy
4 policy.get()

没错，我们单独运行version.py是一点问题没有的，运行version.py的路径搜索就是从当前路径开始的，于是在导入policy时能在当前目录下找到

但是你想啊，你子包中的模块version.py极有可能是被一个glance包同一级别的其他文件导入，比如我们在于glance同级下的一个test.py文件中导入version.py，如下

1 from glance.api import versions
 2 
 3 \'\'\'
 4 执行结果:
 5 ImportError: No module named \'policy\'
 6 \'\'\'
 7 
 8 \'\'\'
 9 分析:
10 此时我们导入versions在versions.py中执行
11 import policy需要找从sys.path也就是从当前目录找policy.py,
12 这必然是找不到的
13 \'\'\'

十  单独导入包

单独导入包名称时不会导入包中所有包含的所有子模块，如

#在与glance同级的test.py中
import glance
glance.cmd.manage.main()

\'\'\'
执行结果：
AttributeError: module \'glance\' has no attribute \'cmd\'

\'\'\' 

解决方法：

1 #glance/__init__.py
2 from . import cmd
3 
4 #glance/cmd/__init__.py
5 from . import manage

执行：

1 #在于glance同级的test.py中
2 import glance
3 glance.cmd.manage.main()

千万别问：__all__不能解决吗，__all__是用于控制from...import * ，fuck