python(27)：模块

Posted 2020-12-27 勺子惜白

一、模块介绍

1.Python中的模块

有过C语言编程经验的朋友都知道在C语言中如果要引用sqrt函数，必须用语句#include <math.h>引入math.h这个头文件，否则是无法正常进行调用的。

那么在Python中，如果要引用一些其他的函数，该怎么处理呢？

在Python中有一个概念叫做模块（module），这个和C语言中的头文件以及Java中的包很类似，比如在Python中要调用sqrt函数，必须用import关键字引入math这个模块，下面就来了解一下Python中的模块。

说的通俗点：模块就好比是工具包，要想使用这个工具包中的工具(就好比函数)，就需要导入这个模块

 

2.import

在Python中用关键字import来引入某个模块，比如要引用模块math，就可以在文件最开始的地方用import math来引入。

形如:

import module1,mudule2...

当解释器遇到import语句，如果模块在当前的搜索路径就会被导入。

在调用math模块中的函数时，必须这样引用：

　　模块名.函数名

因为在多个模块中含有相同名称的函数，此时如果只是通过函数名来调用，解释器无法知道到底要调用哪个函数。所以如果像上述这样引入模块的时候，调用函数必须加上模块名

    import math

    #这样会报错
    print sqrt(2)

    #这样才能正确输出结果
    print math.sqrt(2)

有时候我们只需要用到模块中的某个函数，只需要引入该函数即可，此时可以用下面方法实现：

from 模块名 import 函数名1,函数名2....

不仅可以引入函数，还可以引入一些全局变量、类等

注意:

通过这种方式引入的时候，调用函数时只能给出函数名，不能给出模块名，但是当两个模块中含有相同名称函数的时候，后面一次引入会覆盖前一次引入。也就是说假如模块A中有函数function( )，在模块B中也有函数function( )，如果引入A中的function在先、B中的function在后，那么当调用function函数的时候，是去执行模块B中的function函数。

如果想一次性引入math中所有的东西，还可以通过from math import *来实现

 

3.from…import

Python的from语句让你从模块中导入一个指定的部分到当前命名空间中

语法如下：

 from modname import name1[, name2[, ... nameN]]

 例如，要导入模块fib的fibonacci函数，使用如下语句：

from fib import fibonacci

注意：

不会把整个fib模块导入到当前的命名空间中，它只会将fib里的fibonacci单个引入

 

4.from … import *

把一个模块的所有内容全都导入到当前的命名空间也是可行的，只需使用如下声明：

from modname import *

注意：

这提供了一个简单的方法来导入一个模块中的所有项目。然而这种声明不该被过多地使用。

 

5. as

    In [1]: import time as tt

    In [2]: time.sleep(1)
    ---------------------------------------------------------------------------
    NameError                                 Traceback (most recent call last)
    <ipython-input-2-07a34f5b1e42> in <module>()
    ----> 1 time.sleep(1)

    NameError: name ‘time‘ is not defined

    In [3]: 

    In [3]: 

    In [3]: tt.sleep(1)

    In [4]: 

    In [4]: 

    In [4]: from time import sleep as sp

    In [5]: sleep(1)
    ---------------------------------------------------------------------------
    NameError                                 Traceback (most recent call last)
    <ipython-input-5-82e5c2913b44> in <module>()
    ----> 1 sleep(1)

    NameError: name ‘sleep‘ is not defined

    In [6]: 

    In [6]: 

    In [6]: sp(1)

    In [7]:

 

6.定位模块

当你导入一个模块，Python解析器对模块位置的搜索顺序是：当前目录；如果不在当前目录，Python则搜索在shell变量PYTHONPATH下的每个目录；如果都找不到，Python会察看默认路径。UNIX下，默认路径一般为/usr/local/lib/python/。

模块搜索路径存储在system模块的sys.path变量中。变量里包含当前目录，PYTHONPATH和由安装过程决定的默认目录。

 

二、模块制作

1.定义自己的模块

在Python中，每个Python文件都可以作为一个模块，模块的名字就是文件的名字。

比如有这样一个文件test.py，在test.py中定义了函数add：

#test.py

def add(a,b):
    return a+b

 

2.调用自己定义的模块

那么在其他文件中就可以先import test，然后通过test.add(a,b)来调用了，当然也可以通过from test import add来引入

    #main.py    

    import test

    result = test.add(11,22)
    print(result)

 

3.测试模块

在实际开中，当一个开发人员编写完一个模块后，为了让模块能够在项目中达到想要的效果，这个开发人员会自行在py文件中添加一些测试信息，例如：

    #test.py

    def add(a,b):
        return a+b

    # 用来进行测试
    ret = add(12,22)
    print(‘int test.py file,,,,12+22=%d‘%ret)

如果此时，在其他py文件中引入了此文件的话，想想看，测试的那段代码是否也会执行呢！

    #main.py

    import test

    result = test.add(11,22)
    print(result)

至此，可发现test.py中的测试代码，应该是单独执行test.py文件时才应该执行的，不应该是其他的文件中引用而执行

为了解决这个问题，python在执行一个文件时有个变量__name__。可以根据__name__变量的结果能够判断出，是直接执行的python脚本还是被引入执行的，从而能够有选择性的执行测试代码

 

四、python中的包

1. 引入包

包将有联系的模块组织在一起，即放到同一个文件夹下，并且在这个文件夹创建一个名字为__init__.py 文件，那么这个文件夹就称之为包。这可以有效避免模块名称冲突问题，让应用组织结构更加清晰。

2. __init__.py文件

__init__.py 控制着包的导入行为。

 __init__.py为空，仅仅是把这个包导入，不会导入包中的模块。

可以在__init__.py文件中编写内容，当导入时，这些语句就会被执行。

3.__all__

在__init__.py文件中，定义一个__all__变量，它控制着 from 包名 import *时导入的模块。如果一个文件中有__all__变量，那么也就意味着这个变量中的元素，不会被from xxx import *时导入。

4. 扩展：嵌套的包

假定我们的包的例子有如下的目录结构：

Phone/
    __init__.py
    common_util.py
    Voicedta/
        __init__.py
        Pots.py
        Isdn.py
    Fax/
        __init__.py
        G3.py
    Mobile/
        __init__.py
        Analog.py
        igital.py
    Pager/
        __init__.py
        Numeric.py

Phone 是最顶层的包，Voicedta 等是它的子包。 我们可以这样导入子包（你也可使用 from-import 实现不同需求的导入）：

import Phone.Mobile.Analog
Phone.Mobile.Analog.dial()

第一种方法是只导入顶层的子包，然后使用属性/点操作符向下引用子包树：

from Phone import Mobile
Mobile.Analog.dial(‘555-1212‘)

此外，我们可以还引用更多的子包：

from Phone.Mobile import Analog
Analog.dial(‘555-1212‘)

事实上，你可以一直沿子包的树状结构导入：

from Phone.Mobile.Analog import dial
dial(‘555-1212‘)

在我们上边的目录结构中，我们可以发现很多的 __init__.py 文件。这些是初始化模块，from-import 语句导入子包时需要用到它。 如果没有用到，他们可以是空文件。

包同样支持 from-import all 语句：

from package.module import *

然而，这样的语句会导入哪些文件取决于操作系统的文件系统。所以我们在__init__.py 中加入 __all__ 变量。该变量包含执行这样的语句时应该导入的模块的名字。它由一个模块名字符串列表组成.。

 

五、模块发布

1.mymodule目录结构体如下：

.
├── setup.py
├── suba
│   ├── aa.py
│   ├── bb.py
│   └── __init__.py
└── subb
    ├── cc.py
    ├── dd.py
    └── __init__.py

2.编辑setup.py文件

py_modules需指明所需包含的py文件

from distutils.core import setup

setup(name="dongGe", version="1.0", description="dongGe‘s module", author="dongGe", py_modules=[‘suba.aa‘, ‘suba.bb‘, ‘subb.cc‘, ‘subb.dd‘])

3.构建模块

python setup.py build

构建后目录结构：

.
├── build
│   └── lib.linux-i686-2.7
│       ├── suba
│       │   ├── aa.py
│       │   ├── bb.py
│       │   └── __init__.py
│       └── subb
│           ├── cc.py
│           ├── dd.py
│           └── __init__.py
├── setup.py
├── suba
│   ├── aa.py
│   ├── bb.py
│   └── __init__.py
└── subb
    ├── cc.py
    ├── dd.py
    └── __init__.py

4.生成发布压缩包

python setup.py sdist

打包后,生成最终发布压缩包dongGe-1.0.tar.gz , 目录结构：

.
├── build
│   └── lib.linux-i686-2.7
│       ├── suba
│       │   ├── aa.py
│       │   ├── bb.py
│       │   └── __init__.py
│       └── subb
│           ├── cc.py
│           ├── dd.py
│           └── __init__.py
├── dist
│   └── dongGe-1.0.tar.gz
├── MANIFEST
├── setup.py
├── suba
│   ├── aa.py
│   ├── bb.py
│   └── __init__.py
└── subb
    ├── cc.py
    ├── dd.py
    └── __init__.py

 

六、模块安装、使用

1.安装的方式

在命令行模式下，找到模块的压缩包、解压、进入文件夹、执行命令python setup.py install。

注意：如果在install的时候，执行目录安装，可以使用python setup.py install --prefix=安装路径

2.模块的引入

在程序中，使用from import 即可完成对安装的模块使用

from 模块名 import 模块名或者*