Python 常用包、模块定义详解

╰半夏微凉° 2023-06-06 03:34 46阅读 0赞

在Python 中引用是非常简单的事情，这里需要清楚三个概念就可以了包、模块、类。

模块对应的是一个.py 文件，那么module\_name 就是这个文件去掉.py 之后的文件名，py 文件中可以直接定义一些变量、函数、类。

那么包我们可以看作一个包含\_\_init\_\_.py 和一系列.py 文件的文件夹，这样做的目的是为了区别包和普通字符串。

import module_name
    
    from package_name import module_name
    
    from package_name import *

那么如何import 时，python 解释器如何才能找到该模块放置的文件位置呢？python 寻找模块的优先级如下：

1、   当前文件目录
    
    2、   环境变量PYTHONPATH
    
    3、   sys.path(list 类型)

sys.path 是list 类型，我们可以通过insert(), append() 方法来增加模块导入的搜索路径，如：

import sys
    
    path = “……” # 需要增加的路径
    
    sys.path.insert(0, path)

在import模块时，该模块的顶层代码将会被执行一次。如果该模块被import多次，例如import A, import B.其中B模块本身也有import A，那么只在第一次被import的时候顶层代码会被执行。

模块能像包含函数定义一样，可包含一些可执行语句。这些可执行语句通常用来进行模块的初始化工作。这些语句只在模块第一次被导入时被执行。这非常重要，有些人以为这些语句会多次导入多次执行，其实不然。

模块在被导入执行时，python解释器为加快程序的启动速度，会在与模块文件同一目录下生成.pyc文件。我们知道python是解释性的脚本语言，而.pyc是经过编译后的字节码，这一工作会自动完成，而无需程序员手动执行。

什么时候你应该使用 from *module* import？

*  如果你要经常访问模块的属性和方法，且不想一遍又一遍地敲入模块名，使用 from *module* import。
 *  如果你想要有选择地导入某些属性和方法，而不想要其它的，使用 from *module* import。
 *  如果模块包含的属性和方法与你的某个模块同名，你必须使用 import *module* 来避免名字冲突。

除了这些情况，剩下的只是风格问题了，你会看到用两种方式编写的 Python 代码。

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:top;">&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="2" style="vertical-align:top;">尽量少用&nbsp;from module import *&nbsp;，因为判定一个特殊的函数或属性是从哪来的有些困难，并且会造成调试和重构都更困难。</td> 
  </tr> 
 </tbody> 
</table>

其它要点：

### 包 ###

在创建许许多多模块后，我们可能希望将某些功能相近的文件组织在同一文件夹下，这里就需要运用包的概念了。包对应于文件夹，使用包的方式跟模块也类似，唯一需要注意的是，当文件夹当作包使用时，文件夹需要包含\_\_init\_\_.py文件，主要是为了避免将文件夹名当作普通的字符串。\_\_init\_\_.py的内容可以为空，一般用来进行包的某些初始化工作或者设置\_\_all\_\_值，\_\_all\_\_是在*from package-name import \**这语句使用的，全部导出定义过的模块。

那么我们平常新建文件的时候，都是建一个.py文件（类似java，但是python不用建立类，是以模块为载体）至于怎样组织包就要功能需要了

在C/C++/Java中，main是程序执行的起点，Python中，也有类似的运行机制，但方式却截然不同：Python使用缩进对齐组织代码的执行，所有没有缩进的代码（非函数定义和类定义），都会在载入时自动执行，这些代码，可以认为是Python的main函数。

每个文件（模块）都可以任意写一些没有缩进的代码，并且在载入时自动执行，为了区分主执行文件还是被调用的文件，Python引入了一个变量\_\_name\_\_，当文件是被调用时，\_\_name\_\_的值为模块名，当文件被执行时，\_\_name\_\_为'\_\_main\_\_'。这个特性，为测试驱动开发提供了极好的支持，我们可以在每个模块中写上测试代码，这些测试代码仅当模块被Python直接执行时才会运行，代码和测试完美的结合在一起。

典型的Python文件结构：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly96eWM4OC5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70][]

[python import模块方法][python import]

**python**包含子目录中的模块方法比较简单，关键是能够在sys.path里面找到通向模块文件的路径。  
下面将具体介绍几种常用情况:  
（1）主程序与模块程序在同一目录下:  
如下面程序结构:

`-- src
        |-- mod1.py
        `-- test1.py
        若在程序test1.py中导入模块mod1, 则直接使用import mod1或from mod1 import *;
    
    （2）主程序所在目录是模块所在目录的父(或祖辈)目录
    如下面程序结构:
    `-- src
        |-- mod1.py
        |-- mod2
        |   `-- mod2.py
        `-- test1.py

若在程序test1.py中导入模块mod2, 需要在mod2文件夹中建立空文件\_\_init\_\_.py文件(也可以在该文件中自定义输出模块接口); 然后使用 from mod2.mod2 import \* 或import mod2.mod2.  
  
（3）主程序导入上层目录中模块或其他目录(平级)下的模块  
如下面程序结构:

`-- src
        |-- mod1.py
        |-- mod2
        |   `-- mod2.py
        |-- sub
        |   `-- test2.py
        `-- test1.py

若在程序test2.py中导入模块mod1和mod2。首先需要在mod2下建立\_\_init\_\_.py文件(同(2))，src下不必建立该文件。然后调用方式如下:  
   下面程序执行方式均在程序文件所在目录下执行，如test2.py是在cd sub;之后执行python test2.py  
而test1.py是在cd src;之后执行python test1.py; 不保证在src目录下执行python sub/test2.py成功。

import sys
       sys.path.append("..")
       import mod1
       import mod2.mod2

（4）从(3)可以看出，导入模块关键是能够根据sys.path环境变量的值，找到具体模块的路径。这里仅介绍上面三种简单情况。

## Python 包 ##

### 　　包 定义 ###

为了组织好模块，会将多个模块分为包。Python 处理包也是相当方便的。简单来说，**包就是文件夹，但该文件夹下必须存在 \_\_init\_\_.py 文件**。

常见的包结构如下：

![20191009171725259.png][]

最简单的情况下，只需要一个空的 \_\_init\_\_.py 文件即可。当然它也可以执行包的初始化代码，或者定义稍后介绍的 \_\_all\_\_ 变量。当然包底下也能包含包，这和文件夹一样，还是比较好理解的。

### 　　导入包 ###

包的导入仍使用 import 、 from ... import 语句，使用 “圆点模块名” 的结构化模块命名空间。 下面来看一个包的例子来了解下具体的运作。（官方文档中的例子）

假设你现在想要设计一个模块集（一个“包”）来统一处理声音文件和声音数据。存在几种不同的声音格式（通常由它们的扩展名来标识，例如： .wav, .aiff, .au ）于是，为了在不同类型的文件格式之间转换，你需要维护一个不断增长的包集合。可能你还想要对声音数据做很多不同的操作（例如混音，添加回声，应用平衡 功能，创建一个人造效果）所以你要加入一个无限流模块来执行这些操作。你的包可能会是这个样子（通过分级的文件体系来进行分组）：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly96eWM4OC5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70 1][]

用户可以每次只导入包里的特定模块，例如： import sound.efforts.echo   这样就导入了 sound.effects.echo 子模块。它必须通过完整的名称来引用：

sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

导入包时有一个可以选择的方式： from sound.effects import echo   这样就加载了 echo 子模块，并且使得它在没有包前缀的情况下也可以使用，所以它可以如下方式调用：

echo.echofilter(input, output, delay=0.7, atten=4)

还有另一种变体用于直接导入函数或变量： from sound.effects.echo import echofilter   这样就又一次加载了 echo 字模块，但这样就可以直接调用它的 echofilter() 函数：

echo.echofilter(input, output, delay=0.7, atten=4)

需要注意的是  from package import item    方式导入包时，这个子项(item)既可以是子包也可以是其他命名，如函数、类、变量等。若无，会引发ImportError异常。

而用类似 import item.subitem.subsubitem 这样的语法时，这些子项必须是包，最后的子项可以是包或模块，但不能是类、函数、变量等。

** 　　　从 \* 导入包**

import \* 这样的语句理论上是希望文件系统找出包中所有的子模块，然后导入它们。这可能会花长时间，并出现边界效应等。Python 解决方案是提供一个明确的包索引。

这个索引由 \_\_init\_\_.py  定义 \_\_all\_\_ 变量，该变量为一列表，如上例 sound/effects 下的 \_\_init\_\_.py 中，可定义  \_\_all\_\_ = \["echo","surround","reverse"\]

这意味着，  from sound.effects import \*   会从对应的包中导入以上三个子模块； 尽管提供 import \* 的方法，仍不建议在生产代码中使用这种写法。

** 　　　包内引用**

如果是子包内的引用，可以按相对位置引入子模块 以 echo 模块为例，可以引用如下：

1 from . import reverse              # 同级目录 导入 reverse
    2 from .. import frormats            # 上级目录 导入 frormats
    3 from ..filters import equalizer    # 上级目录的filters模块下 导入 equalizer

** 　　　多重目录包搜索**

包支持一个更为特殊的特性， \_\_path\_\_  在包的 \_\_init\_\_.py 文件代码执行前，该变量初始化一个目录名列表。作用于子包和模块的搜索功能。该功能可以用于扩展包中的模块集，不过不常用。

参考：[https://python3-cookbook.readthedocs.io/zh\_CN/latest/chapters/p10\_modules\_and\_packages.html][https_python3-cookbook.readthedocs.io_zh_CN_latest_chapters_p10_modules_and_packages.html]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly96eWM4OC5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70]: /images/20230601/327fc06013724420adb858e33a2a3182.png
[python import]: http://www.cnitblog.com/seeyeah/archive/2009/03/15/55440.html
[20191009171725259.png]: /images/20230601/77cd7691f6474a7ca6f8f3af851e7bfc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly96eWM4OC5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70 1]: /images/20230601/2cb7e1dd31934bb99b35a58abdae5285.png
[https_python3-cookbook.readthedocs.io_zh_CN_latest_chapters_p10_modules_and_packages.html]: https://python3-cookbook.readthedocs.io/zh_CN/latest/chapters/p10_modules_and_packages.html