16-包和目录规范

一、包的介绍

随着模块数目的增多，把所有模块不加区分地放到一起也是极不合理的，于是Python为我们提供了一种把模块组织到一起的方法，即创建一个包。包就是一个含有__init__.py文件的文件夹，文件夹内可以组织子模块或子包，例如

aaa/                 #顶级包
├── __init__.py     
├── bbb              #子包
│   ├── __init__.py
│   ├── process.py
│   
└── foo.py           #子模块

需要强调的是

#1. 在python3中，即使包下没有__init__.py文件，import 包仍然不会报错，而在python2中，包下一定要有该文件，否则import 包报错

#2. 创建包的目的不是为了运行，而是被导入使用，记住，包只是模块的一种形式而已，包的本质就是一种模块

接下来我们就以包aaa为例来介绍包，包内各文件以及执行文件内容如下：

# 包aaa下的 init.py 文件

from aaa.foo import x
from aaa.foo_f2 import change
from aaa.foo import get

#=======================================

# 包aaa下的 foo.py 文件

x = 1
def change():
    global x
    x = 0
def get():
    print(x)

#========================================

# 执行文件 run.py 代码

from aaa import x
from aaa import change
from aaa import get

print(x)                 # 1

change()                 # 0

get()                    # 0
print(x)                 # 1

from aaa import x
print(x)                # 1
from aaa.foo import x
print(x)                # 0

二、包的使用

2.1 导入包与__init__.py

包属于模块的一种，因而包以及包内的模块均是用来被导入使用的，而绝非被直接执行，首次导入包（如import pool）同样会做三件事：

1、执行包下的__init__.py文件

2、产生一个新的名称空间用于存放__init__.py执行过程中产生的名字

3、在当前执行文件所在的名称空间中得到一个名字aaa，该名字指向__init__.py的名称空间，例如aaa.x和aaa.yyy中的xxx和yyy都是来自于aaa下的__init__.py，也就是说导入包时并不会导入包下所有的子模块与子包

强调：

1.关于包相关的导入语句也分为import和from ... import ...两种，但是无论哪种，无论在什么位置，在导入时都必须遵循一个原则：
凡是在导入时带点的，点的左边都必须是一个包，否则非法。可以带有一连串的点，如import 顶级包.子包.子模块,但都必须遵循这个原则。
但对于导入后，在使用时就没有这种限制了，点的左边可以是包,模块，函数，类(它们都可以用点的方式调用自己的属性)。

2、包A和包B下有同名模块也不会冲突，如A.a与B.a来自俩个命名空间

3、import导入文件时，产生名称空间中的名字来源于文件，import 包，产生的名称空间的名字同样来源于文件，
即包下的__init__.py，导入包本质就是在导入该文件

2.2 绝对导入与相对导入

针对包内的模块之间互相导入，导入的方式有两种

1、绝对导入：以顶级包为起始

PS：因为顶级包在执行文件中被导入，所以执行文件的sys.path中必有顶级包所在路径

#aaa下的__init__.py
from aaa import foo

2、相对导入：.代表当前文件所在的目录，..代表当前目录的上一级目录，依此类推

#aaa下的__init__.py
from . import foo

同理，针对aaa.bbb.process.py，则需要

#操作aaa下的__init__.py，保证aaa.bbb
from . import futures         #或from aaa import futures

#操作bbb下的__init__.py，保证aaa.bbb.process
from . import process         #或from aaa.bbb import process

在包内使用相对导入还可以跨目录导入模块，比如process.py中想引用foo.py的名字x

# 操作bbb下的process
from .. import foo

注：import也能使用绝对导入，导入过程中同样会依次执行包下的__init__.py,只是基于import导入的结果，使用时必须加上该前缀

针对包内部模块之间的相互导入推荐使用相对导入，需要特别强调：

1、相对导入只能在包内部使用，用相对导入不同目录下的模块是非法的

2、无论是import还是from-import，但凡是在导入时带点的，点的左边必须是包,否则语法错误

2.3 from 包 import *

​ 在使用包时同样支持from pool.futures import * ，毫无疑问*代表的是futures下__init__.py中所有的名字，通用是用变量__all__来控制*代表的意思

​ 最后说明一点，包内部的目录结构通常是包的开发者为了方便自己管理和维护代码而创建的，这种目录结构对包的使用者往往是无用的，此时通过操作__init__.py可以“隐藏”包内部的目录结构，降低使用难度，比如想要让使用者直接使用

import aaa

aaa.get()
aaa.change()
pool.x

需要操作pool下的__init__.py

from .foo import get
from .foo import change
from .foo import x

三 包名称空间详解

# 包aaa下的 init.py 文件

from aaa.foo import x
from aaa.foo_f2 import change
from aaa.foo import get

#=======================================

# 包aaa下的 foo.py 文件

x = 1
def change():
    global x
    x = 0
def get():
    print(x)

#========================================

# 执行文件 run.py 代码

from aaa import x
from aaa import change
from aaa import get

print(x)                 # 1

change()                 # 0

get()                    # 0
print(x)                 # 1

from aaa import x
print(x)                # 1
from aaa.foo import x
print(x)                # 0

3.1 第一次导入时，各名称空间下变量变化

 

3.2 当调用包下子模块中的函数change时，各名称空间下变量变化

3.3 分别由模块aaa和模块aaa.foo中导入x时，各名称空间下变量变化

四、目录规范

Foo/
|-- core/                         # 存放业务逻辑相关代码
|   |-- core.py
|
|-- api/                          # 存放接口文件，接口主要用于为业务逻辑提供数据操作。
|   |-- api.py
|
|-- db/                           # 存放操作数据库相关文件，主要用于与数据库交互
|   |-- db_handle.py
|
|-- lib/                          #  存放程序中常用的自定义模块
|   |-- common.py
|
|-- conf/                         # 存放配置文件
|   |-- settings.py
|
|-- run.py                        # 程序的启动文件，一般放在项目的根目录下，因为在运行时会默认将运行文件所在的文件夹作为sys.path的第一个路径，这样就省去了处理环境变量的步骤
|-- setup.py                      # 安装、部署、打包的脚本。
|-- requirements.txt              # 存放软件依赖的外部Python包列表。
|-- README                        # 项目说明文件

README 内容：

1、软件定位，软件的基本功能；

2、运行代码的方法: 安装环境、启动命令等；

3、简要的使用说明；

4、代码目录结构说明，更详细点可以说明软件的基本原理；

5、常见问题说明。