python复杂程序的组织讲座

刺骨的言语ヽ痛彻心扉 2022-12-07 12:43 172阅读 0赞

### python复杂程序的组织讲座 ###

当程序简单时，将代码写进一个文件即可。但当项目的复杂度增加时，会出现代码过多导致文件过大的问题。因此，模块和包就能方便管理和维护代码。模块和包都是复杂程序组织的一种方式，一般来说，一般复杂度较低使用模块（module），复杂度较高使用包（package）来管理代码。

一个包（package）可以由多个模块组成，一个模块，由多个函数、变量组成，若是采用面向对象编程编程范式（paradigm）由多个类，每个类由多个变量、函数组成。表现为项目（project）的目录结构。这样做的原因：

1）可读性高：帮助他人了解项目的目录结构，从而非常快速的了解这个项目组织结构。

2）可维护性高：有助于维护者降低维护难度，，随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。

模块概述

模块（Module）是包含函数和其他语句的脚本文件，是一组Python代码的集合，以“.py”为后缀名，也就是Python程序的后缀名。用作模块的Python程序与一般Python程序并没有什么区别。

使用模块中的代码，也很简单，那就是通过导入（import）模块，然后使用模块中提供的函数或者数据。

下面具体介绍之。

**python****中的自定义模块及其使用**

python中的自定义模块，就不是python自带的模块，而是通过自己来创建出来的。

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

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

使用模块的意义

提高了代码的可维护性。其次，编写代码不必从零开始。当一个模块编写完毕，就可以被其他地方引用。还可以避免函数名和变量名冲突。相同名字的函数和变量完全可以分别存在不同的模块中，因此，我们自己在编写模块时，不必考虑名字会与其他模块冲突。

创建模块就是将文件保存为扩展名为.py的文件。

注意事项：

模块名要遵循Python变量命名规范，不要使用中文、特殊字符

模块名不要和系统模块名冲突，先查看系统是否已存在该模块，检查方法是在Python交互环境执行import 模块名，若成功则说明系统存在此模块。如import abc是成功的，系统存在该模块。

python自定义模块及其使用的简单例子

建立名为**myM.py**文件，作为自定义模块文件，内容如下：

def add(a, b):

return a + b

def sub(a, b):

return a - b

建立使用 import myM的名为的**testA.py**测试文件，内容如下：

import myM

print("add(1, 2)的结果", myM.add(1, 2))

print("sub(2, 3)的结果:", myM.sub(2, 3))

将testA.py文件和myM.py文件保存在同一目录（文件夹）中，运行testA.py结果如下图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NuZHMxMjM_size_16_color_FFFFFF_t_70][]

建立使用from myM import add的名为的**testB.p**y测试文件，内容如下：

from myM import add

print("add(1, 2): 的结果",add(1, 2))

将testB.py文件和hello.py文件保存在同一目录（文件夹）中，运行testB.py结果如下图：

![20200916085302331.png][]

**import语句的语法**

格式一：

import 模块名 \[as 别名\]

说明：1）将整个模块导入。2）\[as 别名\]部分可无，取别名简化引用。 3）使用导入模块中的成员的格式：模块名\[或别名\]. 成员

成员包括属性（变量)或函数。

格式二：

from 模块名 import成员名或\*

说明：1)导入模块中的某个成员，\*代表所有成员

若导入包中模块，将上面语法中的模块名改为 包名.模块名

**提示**：import xxx和from xxx import yyy，两者的区别在于：

import xxx，需要通过xxx.yyy的方式使用导入模块中的变量、函数、类等。

from xxx import yyy，可以直接以yyy调用。

**包（Package）**

当复杂度上升时，为了避免模块名冲突，Python又引入了按目录来组织模块的方法，称为包（Package）。参见下图：

![20200917083207551.png][]

一个Python包能有子包和模块。

引入了包以后，只要顶层的包名不冲突，同名的模块就不冲突，如上图中两个AA.py模块不会冲突。注意，每一个包目录下面都会有一个\_\_init\_\_.py的文件（init前后有两个下划线），这个文件是必须存在的，否则，Python就把这个目录当成普通目录，而不是一个包。\_\_init\_\_.py可以是空文件，也可以有代码。当导入包时，python会自动执行 "\_\_init\_\_.py" 里的代码，可作包和模块的初始化。

简单而言，模块（module）是指py文件，包（package）是指目录（含有\_\_init\_\_.py文件的目录）。

导入包的方法与导入模块的方法类似。可以使用点（.）符号从一个包里边导入模块，参见上图，如果想使用A1X模块包含的函数sel()，做法如下：

import A.A1.A1X

A.A1.A1X.sel()

也可以如下简洁方式：

from A.A1 import A1X

A1X.sel()

或者

from A.A1.A1X import sel

sel()

创建包

包可以理解为包含多个模块的文件夹，但是本质仍然为模块。

创建包分为两步：

1）新建文件夹，文件夹名则为包名

2）在文件夹新建名为\_\_init\_\_.py的文件，可以是空文件，也可以有代码。前文讲到，该文件也是一个模块，模块名为包名。

导入包的方法与导入模块的方法类似。

**import语句导入不同路径下的模块**

在调用程序文件（主程序）中导入被导入模块（模块程序）时，若被导入模块的存储路径与调用程序文件的相同，或者将被导入的模块放入系统默认的模块查找路径【注】中，不需要考虑路径，否则需要注意指明路径。

**【注：**Windows系统默认路径为Python安装目录及其子目录，如lib、lib\\site-packages、dlls等。

Linux默认路径为/usr/lib、/usr/lib64及其子目录。】

**（1）主程序与模块程序在同一目录下：**

如下面程序结构：

![20200916144029723.png][]

若在程序test1.py中导入模块mod1, 则直接使用 import  mod1或from mod1 import \*;

**（2）主程序所在目录是模块所在目录的父(或祖辈)目录**

如下面程序结构：

![20200916144118287.png][]

若在程序test1.py中导入模块mod2, 需要在modA文件夹中建立空文件\_\_init\_\_.py文件(也可以在该文件中自定义输出模块接口); 然后使用 from modA.mod2 import \* 或import modA.mod2.

**（3）主程序导入上层目录中模块或其他目录(平级)下的模块**

如下面程序结构：

![20200916144118304.png][]

若在程序test2.py中导入模块mod1和mod2。首先需要在mod2下建立\_\_init\_\_.py文件(同(2))，src下不必建立该文件。然后调用方式如下：

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

**sys.path简介**

sys.path是python的搜索模块的路径集，是一个list 。

python程序中使用 import XXX 时，python解析器会在当前目录、已安装和第三方模块中搜索 xxx，如果都搜索不到就会报错。  
使用sys.path.append()方法可以临时添加搜索路径，方便更简洁的import其他包和模块。这种方法导入的路径会在python程序退出后失效。  
加入上层目录和绝对路径  
import sys  
sys.path.append('..') \#表示导入当前文件的上层目录到搜索路径中  
sys.path.append('D:/test/model') \# 绝对路径

加入当前目录  
import os,sys  
sys.path.append(os.getcwd() \# os.getcwd()用于获取当前工作目录

可用下列查看python系统默认的模块查找路径  
import sys  
for i in sys.path:  
    print(i)

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NuZHMxMjM_size_16_color_FFFFFF_t_70]: /images/20221123/71797773ee5542aa9860cd55952d73f6.png
[20200916085302331.png]: /images/20221123/2f1e781d7d204a5b97b84b61f0b6afd2.png
[20200917083207551.png]: /images/20221123/ff77d72643514ce88073fc8533638381.png
[20200916144029723.png]: /images/20221123/6257739547b6407ba2ef7edcf030777b.png
[20200916144118287.png]: /images/20221123/148cebe773ac41e7899a362459b1f107.png
[20200916144118304.png]: /images/20221123/3cb2cc2b7ffe45d88f3b897ae66f20a4.png