Python之路(五）——包与模块

本节内容

1. 模块定义
2. 模块导入语法
3. 模块导入过程
4. 模块与调用者的关系
5. 包定义
6. 查找模块
7. *与__all__
8. 动态加载模块
9. 软件目录结构规范

一、模块定义

每个*.py文件就是一个模块，用于封装一组业务逻辑相近的代码。模块名默认为文件名(无.py）

二、模块导入语法

• import 模块名[ as 别名 ]                      <推荐>
• from 模块名 import 对象名1[对象名2...N]  |  *(全部对象)

三、模块导入语过程

　　1. 找到这个需导入的模块

　　2. 判断这个模块是否被导入过:

　　　　否:

　　　　　　2.2 创建一个属于这个模块的命名空间

　　　　　　2.3 判断：用户是否定义变量(as 别名)来引用这个模块的内存地址

　　　　　　　　是：那么使用别名来引用这个模块的内存地址，即：模块名为别名

　　　　　　　　否：使用模块名来引用这个模块的内存地址

　　　　　　2.4 使用模块名创建一个命名空间，在此命名空间中执行模块内容

　　　　是：

　　　　　　解释器不会重新执行模块内的语句，后续的import语句仅仅是对已经加载到内存中的模块的对象增加一次引用

四、模块与调用者的关系

调用者使用 "模块名.模块中对象" 方式来执行模块中的对象

# 注：主程序t1与模块t2在同一目录下 t1->t2

#t2.py
    # print("t2加载时候即执行")
    # var2 = "t2"
    # def foo1():
    #     print("t2--> foo1")
    #
    # def foo2():
    #     print("t2--> foo2")

#调用方式一  import 模块名
# import t2
# t2.foo1()
# var2 = "t1"
# print(t2.var2)
# # t2加载时候即执行
# # t2--> foo1
# # t2 不同名，so不覆盖

# 调用方式二  from 模块名 import 对象
# from t2 import var2
# from t2 import foo1
# var2 = "t1"
# foo1()
# print(var2)
#t2加载时候即执行
# t2--> foo1
# t1 同名覆盖
# 调用方式二.1 from 模块名 import * 加载模块中所有对象

五、包的定义

一个文件夹且含有__init__.py文件。模块(文件）可放入其中统一管理

__init__.py

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

六、查找模块

模块的查找顺序是：内存中已经加载的模块->内置模块->sys.path路径中包含的模块

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

import sys
print(sys.path) #列表第一项为主程序文件所在路径
sys.path.append("c:\\") #可以添加搜索路径
print(sys.path)

主程序，模块A，模块B位于不同包（文件夹）下互相调用方法(*重点*）

#
# 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
#
#test_glance.py #glance 同级别

测试一

#测试一、调用模块，被调用模块都不在同一包中

# version.py 调用 manage.py 中的main 函数
# 
# version.py 内容：
#绝对导入
from glance.cmd import manage #主程序只能找到glance
manage.main()

#相对导入
from ..cmd import manage #..表示glance.api
manage.main()

测试二

#测试二、单独导入包名称时不会导入包中所有包含的所有子模块
#test_glance.py内容：

# import glance
# glance.cmd.manage.main() # AttributeError: module 'glance' has no attribute 'cmd'

#解决办法：传递导入
# # glance/__init__.py
# from . import cmd
#
# # glance/cmd/__init__.py
# from . import manage

测试三

#测试三、主程序(test_glance.py）->version.py->manage.py
#文件内容说明：
#1.test-glance.py
from glance.api import version

#2.glance\__init__.py
# print("加载包 ",__name__)
# __all__= ['glance01', 'glance02']

#3.glance\api\version.py
from ..cmd import manage
manage.main()

#4.glance\cmd\manage.py
def main():
    print(__name__ + " " + 'main')

#运行结果：
# 加载包  glance
# glance.cmd.manage main

七、*与__all__

• from 模块名 import *　　导入模块中所有对象
• from 包名 import *　　    导入包中所有模块

__all__： 管控*：

• 模块中写入，表示from 模块名 import * 时被导入的对象
• 包__init__.py写入，表示 from 包名 import * 时导入的模块

在glance包中新建两个文件：glance01.py ,glance02.py

测试一

#测试一、from 模块名 import *
#主version.py->policy.py

#verison.py内容：
# from policy import *

bar() #bar
#foo() #NameError: name 'foo' is not defined

# policy.py内容：
def foo():
    print("foo")

def bar():
    print("bar")

__all__ = ['bar'] 

测试二

#测试二、from 包名 import *

#test_glance.py 程序中加载模块
#1. glance\__init.py内容： print("加载包 ",__name__)

from glance import *
#加载包  glance
# glance01.foo() # NameError: name 'glance01' is not defined 默认全部不加载

#2. glance\__init.py内容： 
# print("加载包 ",__name__) 
# __all__= ['glance01', 'glance02']

glance01.foo()
glance02.foo()
glance02.bar()

# 加载包  glance
# foo
# glance02->foo
# bar

测试三

#测试三、
from glance.glance01 import *
from glance.glance02 import *
foo()
bar()
# 加载包  glance
# glance02->foo
# bar
# from glance.glance02 import *
# from glance.glance01 import *
# foo()
# bar()
# 加载包  glance
# foo
# bar

八、动态加载模块

有时得到的是模块名称（字符串），那么如何加载模块？（即：动态加载模块）

# 方法一、__import__()
m = __import__("test.t2")  # 返回与调用者同级
print(m) # <module 'test' from 'E:\\Computer\\Python\\Code\\day01\\test\\__init__.py'>
m.t2.test1()

# 方法二、 importlib
import importlib
t2 = importlib.import_module("test.t2")
t2.test1()　

九、软件目录结构规范

本节全部摘自《https://www.cnblogs.com/alex3714/articles/5765046.html》

为什么要设计好目录结构?

"设计项目目录结构"，就和"代码编码风格"一样，属于个人风格问题。对于这种风格上的规范，一直都存在两种态度:

1. 一类同学认为，这种个人风格问题"无关紧要"。理由是能让程序work就好，风格问题根本不是问题。
2. 另一类同学认为，规范化能更好的控制程序结构，让程序具有更高的可读性。

我是比较偏向于后者的，因为我是前一类同学思想行为下的直接受害者。我曾经维护过一个非常不好读的项目，其实现的逻辑并不复杂，但是却耗费了我非常长的时间去理解它想表达的意思。从此我个人对于提高项目可读性、可维护性的要求就很高了。"项目目录结构"其实也是属于"可读性和可维护性"的范畴，我们设计一个层次清晰的目录结构，就是为了达到以下两点:

1. 可读性高: 不熟悉这个项目的代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配置文件在哪儿等等。从而非常快速的了解这个项目。
2. 可维护性高: 定义好组织规则后，维护者就能很明确地知道，新增的哪个文件和代码应该放在什么目录之下。这个好处是，随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。

所以，我认为，保持一个层次清晰的目录结构是有必要的。更何况组织一个良好的工程目录，其实是一件很简单的事儿。

目录组织方式

关于如何组织一个较好的Python工程目录结构，已经有一些得到了共识的目录结构。在Stackoverflow的这个问题上，能看到大家对Python目录结构的讨论。

这里面说的已经很好了，我也不打算重新造轮子列举各种不同的方式，这里面我说一下我的理解和体会。

假设你的项目名为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

简要解释一下:

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

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

下面，再简单讲一下我对这些目录的理解和个人要求吧。

关于README的内容

这个我觉得是每个项目都应该有的一个文件，目的是能简要描述该项目的信息，让读者快速了解这个项目。

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

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

我觉得有以上几点是比较好的一个README。在软件开发初期，由于开发过程中以上内容可能不明确或者发生变化，并不是一定要在一开始就将所有信息都补全。但是在项目完结的时候，是需要撰写这样的一个文档的。

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

关于requirements.txt和setup.py

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也未尝不可。

requirements.txt

这个文件存在的目的是:

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

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

 

关于配置文件的使用方法

注意，在上面的目录结构中，没有将conf.py放在源码目录下，而是放在docs/目录下。

很多项目对配置文件的使用做法是:

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

这种做法我不太赞同:

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

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

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

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

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