Python入门（十六）——模块、包复习

1 模块

一个.py文件，实现某一类功能

• Python标准库
• 第三方模块
• 自己定义的模块

1.2 模块调用方式 import …

'''假设calculate.py中放的是计算内容，包括cal() 方法，和变量x = 0的初始定义 '''
#该模块是bin.py
import calculate
calculate.cal()
calculate.x

通过以上方式进行模块中内容的调用，现在思考import语句得作用：
import在找到路径对应的模块之后会将其全替换为模块内的代码。
如果在模块内加入打印语句，只执行import的话会发现打印语句进行了执行。

1.3 模块的调用方式二 from…import…

该方式比直接导入一个模块的效率要高一些，只导入一个方法或者一个变量

from calculate import add
add(2, 4)

该方法有一个问题：如果下面有重名的add函数定义，则按照Python解释变量的含义，add函数这个变量讲被最新的地址赋值，因此导入的add函数就不起作用了。
所以最好还是用之前的那种方法

1.4 把模块所有内容调用 from…import *

1.5 改名

from … import … as …
import… as …,

2 包：组织模块

与文件夹的区别：包含__init__.py文件

2.1 调用同一级包中的模块

from 包 import 模块
from 包1.包2 import 模块
from 包1.包2.模块 import 方法

import 包 ： 只执行__init__.py文件，其他没调用，可以加一个打印验证

2.2 示例说明如何进行包间调用模块

Foo/
|-- bin/
| |-- foo.py
|
|-- mode/
| |-- main.py
| |-- mylog.py

• 假设mylog模块写入函数进行日志记录
• main中用import mylog
• bin中的foo用from mode import main

结果报错找不到mylog中记日志的函数。是因为直接将import mylog放到foo.py中，它在当前目录无法找到，因此报错。

进行以下修改：

• 将main中改为from mode import mylog
• bin中的foo还是from mode import main
• 发现可以正常执行

此时有个疑问： bin中的foo还是from mode import main在当前目录无法找到呀！
此时print(sys.path)查看之后发现pycharm将项目路径加入，这就提供以下可以适用任何系统的方式：

3. 正确的适用于任何系统的包间调用方式

 1. 在任何调用模块中一定要加入项目下的第一层目录
from 包.包... import 模块
即使只本模块自己调用
 2. 在其他包的模块调用某一包中模块的时候
from 那个模块所在项目的根包.包... import 模块
 3. 在程序入口加入将项目路径加入sys.path的代码
\_\_file\_\_变量表示当前模块的相对路径
abspath = os.path.abspath(\_\_file\_\_)获取当前模块的绝对路径
利用
dir1 = os.path.dirname(abspath) 朝上找到项目路径(多次用,本例用两次即可）
BASE_DIR = os.path.dirname(dir1) 
利用
sys.path.append(BASE_DIR)
即可。

可以用一句话：sys.path.append(os.path.dirname(os.path.dirnam(\_\_file\_\_)))

4 模块内部测试入口规范

先理解：
__name__变量：本模块自己执行，值为’__main__’
其他模块执行该模块，在其模块跑该模块的代码至__name__时发现其值为模块名。
因此可以在本模块内部执行：

if __name__ == '__main__':
	测试command

5 目录组织结构规范：便于维护

此处引用：Python之路,Day4 - Python基础4 (new版) - 金角大王 - 博客园

假设你的项目名为foo, 我比较建议的最方便快捷目录结构这样就足够了:
'''
Foo/
|-- bin/
|   |-- foo
|
|-- foo/
|   |-- tests/
|   |   |-- __init__.py
|   |   |-- test_main.py
|   |
|   |-- __init__.py
|   |-- main.py
|
|-- docs/
|   |-- conf.py
|   |-- abc.rst
|
|-- setup.py
|-- requirements.txt
|-- README
简要解释一下:

bin/: 存放项目的一些可执行文件，当然你可以起名script/之类的也行。
foo/: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。
      (2) 其子目录tests/存放单元测试代码； (3) 程序的入口最好命名为main.py。
docs/: 存放一些文档。
setup.py: 安装、部署、打包的脚本。
requirements.txt: 存放软件依赖的外部Python包列表。
README: 项目说明文件。
'''

除此之外，有一些方案给出了更加多的内容。比如LICENSE.txt,ChangeLog.txt文件等，我没有列在这里，因为这些东西主要是项目开源的时候需要用到。如果你想写一个开源软件，目录该如何组织，可以参考这篇文章。

5.1 关于README的内容

它需要说明以下几个事项:

1. 软件定位，软件的基本功能。
2. 运行代码的方法: 安装环境、启动命令等。
3. 简要的使用说明。
4. 代码目录结构说明，更详细点可以说明软件的基本原理。
5. 常见问题说明。

可以参考Redis源码中Readme的写法，这里面简洁但是清晰的描述了Redis功能和源码结构。

5.2 关于requirements.txt和setup.py

5.2.1 setup.py

一般来说，用setup.py来管理代码的打包、安装、部署问题。业界标准的写法是用Python流行的打包工具setuptools来管理这些事情。这种方式普遍应用于开源项目中。
不过这里的核心思想不是用标准化的工具来解决这些问题，而是说，一个项目一定要有一个安装部署工具，能快速便捷的在一台新机器上将环境装好、代码部署好和将程序运行起来。

刚开始接触Python写项目的时候，安装环境、部署代码、运行程序这个过程全是手动完成，遇到过以下问题:

1. 环境时经常忘了最近又添加了一个新的Python包，结果一到线上运行，程序就出错了。
2. Python包的版本依赖问题，有时候我们程序中使用的是一个版本的Python包，但是官方的已经是最新的包了，通过手动安装就可能装错了。
3. 如果依赖的包很多的话，一个一个安装这些依赖是很费时的事情。
4. 新同学开始写项目的时候，将程序跑起来非常麻烦，因为可能经常忘了要怎么安装各种依赖。

setup.py可以将这些事情自动化起来，提高效率、减少出错的概率。"复杂的东西自动化，能自动化的东西一定要自动化。"是一个非常好的习惯。

setuptools的文档比较庞大，刚接触的话，可能不太好找到切入点。学习技术的方式就是看他人是怎么用的，可以参考一下Python的一个Web框架，flask是如何写的: setup.py

当然，简单点自己写个安装脚本（deploy.sh）替代setup.py也未尝不可。

5.3.2 requirements.txt

这个文件存在的目的是:

1.方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中，避免在setup.py安装依赖时漏掉软件包。
2.方便读者明确项目使用了哪些Python包。

这个文件的格式是每一行包含一个包依赖的说明，通常是flask>=0.10这种格式，要求是这个格式能被pip识别，这样就可以简单的通过 pip install -r requirements.txt来把所有Python包依赖都装好了。具体格式说明： 点这里。

5.3 关于配置文件的使用方法

注意，在上面的目录结构中，没有将conf.py放在源码目录下，而是放在docs/目录下。
很多项目对配置文件的使用做法是:

1.配置文件写在一个或多个python文件中，比如此处的conf.py。
2.项目中哪个模块用到这个配置文件就直接通过import conf这种形式来在代码中使用配置。

这种做法我不太赞同:

1.这让单元测试变得困难（因为模块内部依赖了外部配置）
另一方面配置文件作为用户控制程序的接口，应当可以由用户自由指定该文件的路径。
2.程序组件可复用性太差，因为这种贯穿所有模块的代码硬编码方式，使得大部分模块都依赖conf.py这个文件。

所以，我认为配置的使用，更好的方式是，

1.模块的配置都是可以灵活配置的，不受外部配置文件的影响。
2.程序的配置也是可以灵活控制的。

能够佐证这个思想的是，用过nginx和mysql的同学都知道，nginx、mysql这些程序都可以自由的指定用户配置。

所以，不应当在代码中直接import conf来使用配置文件。上面目录结构中的conf.py，是给出的一个配置样例，不是在写死在程序中直接引用的配置文件。可以通过给main.py启动参数指定配置路径的方式来让程序读取配置内容。当然，这里的conf.py你可以换个类似的名字，比如settings.py。或者你也可以使用其他格式的内容来编写配置文件，比如settings.yaml之类的。