python之模块、包及软件开发的目录规范

1、模块

1.1、什么是模块

模块就是一个功能的集合体，不是用来直接运行的，而是用来被导入使用的

# 模块分为三大来源:
  1、内置的模块
  2、第三方模块
  3、自定义的模块

# 模块分为四种类别:
  1、一个py文件就是一个模块
  2、一个文件夹也是一个模块 => 包
  3、已被编译为共享库或DLL的C或C++扩展
  4、使用C编写并链接到python解释器的内置模块

1.2、为何要用模块

# 使用别人的模块
  1、拿来主义，提升开发效率
# 自定义模块
  1、别人的功能不够用了，需要自己去编写
  2、解决代码冗余

1.3、如何用模块

# 文件名是spam.py，模块名则是spam

# spam.py
print('from the spam.py')

money = 1000


def read1():
    print('spam模块：', money)


def read2():
    print('spam模块')
    read1()


def change():
    global money
    money = 0

1.3.1、import使用

# run.py
import spam
# 首次导入模块发生发生的事情
1、触发被导入的模块的运行，产生一个模块的名称空间，把模块中的名字都丢进去
2、会在当前执行文件中得到一个名字spam，该名字是指向被导入模块的名称空间
# 之后的导入，名字spam直接引用首次导入产生的名称空间，不会再执行模块内的代码了

print(spam.money)
spam.read1()

# 一行导入多个模块
import spam, m1, m2, m3

# 导入模块的顺序
内置模块 -> 第三方模块 -> 自定义模块

# 为导入的模块起别名
import spam as s
s.xxx

1.3.2、from…import…使用

from spam import money
from spam import read1
from spam import read2
print(money)
read1()
read2()

# 注意: 使用from...import...需要注意与当前执行文件名称空间的名字冲突

# 一行导入多个模块
from spam import money, read1, read2

# 为导入的模块起别名
from spam import money as m

# 使用导入模块起别名的小案例
# mysql.py
def get_type():
    print('from mysql...')

# sqlserver.py
def get_type():
    print('from sqlserver...')

# run.py
cmd = input('your cmd: ').strip()
if cmd == 'mysql':
    from mysql import get_type
elif cmd == 'sqlserver':
    from sqlserver import get_type

get_type()  # 用户输入什么就导入对应的模块

# from 模块名 import *
# __all__的问题

# spam.py
__all__ = ['money', 'read1']  # 指定使用import*的时候只可以导入money和read1

# run.py
from spam import *
print(money) # 可以正常输出
read1()  # 可以正常调用
read2()  # 报错
change()  # 报错

1.4、循环导入问题

# 抛出问题: 循环导入出现问题
# run.py (执行文件)
x = 123
import m1

# m1.py
print('正在导入m1')
from m2 import y
x = 'm1'

# m2.py
print('正在导入m2')
from m1 import x
y = 'm2'

1.4.1、循环导入解决方法1

# m1.py
print('正在导入m1')
x = 'm1'  # 确保导入之前把所有的名字都加载到名称空间中
from m2 import y

# m2.py
print('正在导入m2')
y = 'm2'  # 确保导入之前把所有的名字都加载到名称空间中
from m1 import x

1.4.2、循环导入解决方法2

# run.py (执行文件)
x = 123
import m1
import m2
m1.f1()

# m1.py
print('正在导入m1')
def f1():
    from m2 import y  # 在函数内导入
x = 'm1'

# m2.py
print('正在导入m2')
def f2():
    from m1 import x  # 在函数内导入
y = 'm2'

1.5、区分py文件的两种用途

1、直接运行
2、被当作模块导入

当文件被当作脚本直接运行时，__name__值为"__main__"
当文件被当作模块导入时，__name__值为"模块名"

if __name__ == '__main__':
    print('文件被当作脚本执行时要做的事情')

1.6、模块的搜索路径优先级

(1) 先从内存中已经导入的模块里找
# run.py (执行文件)
import abcdef
abcdef.f1()

import time
time.sleep(15)

print('==================')

import abcdef
abcdef.f1()

# abcdef.py
def f1():
    print(123)

(2) 然后再查找内置的模块
import sys
print(sys.modules)

(3) 最后去sys.path列表中存放的多个文件夹里依次检索
包含当前执行文件所在的文件夹

# 被导入文件在a/b/c.py
import sys
sys.path(文件的绝对路径(c:/a/b/))  # 将文件夹b加入到路径sys.path中

import a.b.c as c
c.f1()

from a.b import c
c.f1()

2、包的使用

2.1、什么是包

包是一个含有__init__.py文件的文件夹，本质就是一个模块，是用来被导入使用的

包是一种通过使用".模块名"来组织python模块名称空间的方式。
# 具体的: 包就是一个包含有__init__.py文件的文件夹，所以其实我们创建包的目的就是为了用文件夹将文件/模块组织起来
# 需要强调的是：
　　1. 在python3中，即使包下没有__init__.py文件，import 包仍然不会报错，而在python2中，包下一定要有该文件，否则import 包报错
　　2. 创建包的目的不是为了运行，而是被导入使用，记住，包只是模块的一种形式而已，包的本质就是一种模块

2.2、为何要有包

import aaa
首次导入包这种模块，发生两件事
1、创建模块的名称空间，运行包下的__init__.py的文件，将运行过程中产生的名字都丢入模块的名称空间中
2、在当前位置拿到一个名字aaa，该名字指向__init__.py的名称空间，即aaa.名字，名字是来自于__init__.py中的

包的本质就是一个文件夹，那么文件夹唯一的功能就是将文件组织起来
随着功能越写越多，我们无法将所以功能都放到一个文件中，于是我们使用模块去组织功能，而随着模块越来越多，我们就需要用文件夹将模块文件组织起来，以此来提高程序的结构性和可维护性

注意事项:
1.关于包相关的导入语句也分为import和from ... import ...两种，但是无论哪种，无论在什么位置，在导入时都必须遵循一个原则：凡是在导入时带点的，点的左边都必须是一个包，否则非法。可以带有一连串的点，如item.subitem.subsubitem,但都必须遵循这个原则。但对于导入后，在使用时就没有这种限制了，点的左边可以是包,模块，函数，类(它们都可以用点的方式调用自己的属性)。
2、import导入文件时，产生名称空间中的名字来源于文件，import 包，产生的名称空间的名字同样来源于文件，即包下的__init__.py，导入包本质就是在导入该文件
3、包A和包B下有同名模块也不会冲突，如A.a与B.a来自俩个命名空间

2.3、绝对导入和相对导入

绝对导入: 以执行文件的sys.path为起始点开始导入,称之为绝对导入
   优点: 执行文件与被导入的模块中都可以使用
   缺点: 所有导入都是以sys.path为起始点,导入麻烦
相对导入: 参照当前所在文件的文件夹为起始开始查找,称之为相对导入
# 符号: .代表当前所在文件的文件加,..代表上一级文件夹,...代表上一级的上一级文件夹
   优点: 导入更加简单
   缺点: 只能在导入包中的模块时才能使用
# 注意:
　　1. 相对导入只能用于包内部模块之间的相互导入,导入者与被导入者都必须存在于一个包内
　　2. attempted relative import beyond top-level package # 试图在顶级包之外使用相对导入是错误的,言外之意,必须在顶级包内使用相对导入,每增加一个.代表跳到上一级文件夹,而上一级不应该超出顶级包

3、软件开发的目录规范

# 目录大致结构

项目名称/
|-- core/
|   |-- core.py
|
|-- api/
|   |-- api.py
|
|-- db/
|   |-- db_handle.py
|
|-- lib/
|   |-- common.py
|
|-- conf/
|   |-- settings.py
|
|-- run.py
|-- setup.py
|-- requirements.txt
|-- README