#encoding=utf-8
"""
本模块用于计算公司员工的薪资
"""
company = "北京尚学堂"

def yearSalary(monthSalary):
    """根据传入的月薪，计算出年薪"""
    pass

def daySalary(monthSalary):
    """根据传入的月薪，计算出每天的薪资"""
    pass

如上模块只有功能描述和规范，需要编码人员按照要求实现编码。

我们可以通过__doc__可以获得模块的文档字符串的内容。源代码如下：

#encoding=utf-8
import salary

print(salary.__doc__)
print(salary.yearSalary.__doc__)

运行结果：

本模块用于计算公司员工的薪资

根据传入的月薪，计算出年薪

2. 模块的创建和测试代码

每个模块都有一个名称，通过特殊变量__name__可以获取模块的名称。在正常情况下，模块名字对应源文件名。仅有一个例外，就是当一个模块被作为程序入口时（主程序、交互式提示符下），它的__name__的值为__main__。我们可以根据这个特点，将模块源代码文件中的测试代码进行独立的处理。例如：

import math
print(math.__name__)    #输出'math'

通过__name==“__main__”独立处理模块的测试代码

#encoding=utf-8
"""
本模块用于计算公司员工的薪资
"""
company = "北京尚学堂"


def yearSalary(monthSalary):
    """根据传入的月薪，计算出年薪"""
    return monthSalary*12


def daySalary(monthSalary):
    """根据传入的月薪，计算出每天的薪资"""
    return monthSalary/22.5      #国家规定每个月的平均工作日是22.5


if __name__ =="__main__":       #测试代码
    print(yearSalary(3000))
    print(daySalary(3000))

3. 模块文档字符串和API设计

我们可以在模块的第一行增加一个文档字符串，用于描述模块的相关功能。然后，通过__doc__可以获得文档字符串的内容。

模块文档字符串示例以及导入后如何读取文档字符串

#encoding=utf-8
import MySalary

print(MySalary.__doc__)
print(MySalary.yearSalary.__doc__)

运行结果：

本模块实现根据月薪计算各种薪水的功能

根据月薪，计算年薪

在正常情况下，模块名字对应源文件名。仅有一个例外，就是当一个模块被作为程序入口时（主程序、交互式提示符下），它的__name__的值为__main__。我们可以根据这个特点，将模块源代码文件中的测试代码进行独立的处理。

三、模块的导入

模块化设计的好处之一就是“代码复用性高”。写好的模块可以被反复调用，重复使用。模块的导入就是“在本模块中使用其他模块”。

1. import语句导入

import语句的基本语法格式如下：

import  模块名               #导入一个模块
import  模块1，模块2…      #导入多个模块
import  模块名   as 模块别名     #导入模块并使用新名字

import加载的模块分为四种类型：

使用python编写的代码.py文件
已被编译为共享库或DLL的C或C++扩展
一组模块的包
使用C编写并链接到python解释器的内置模块

我们一般通过import语句实现模块的导入和使用，import本质上是使用了内置函数__import__()。

当我们通过import导入一个模块时，python解释器进行执行，最终会生成一个对象，这个对象就代表了被加载的模块。

import  math

print(id(math))
print(type(math))
print(math.pi)    #通过math.成员名来访问模块中的成员

执行结果是：

31840800
<class 'module'>

由上，我们可以看到math模块被加载后，实际会生成一个module类的对象，该对象被math变量引用。我们可以通过math变量引用模块中所有的内容。

我们通过import导入多个模块，本质上也是生成多个module类的对象而已。

有时候，我们也需要给模块起个别名，本质上，这个别名仅仅是新创建一个变量引用加载的模块对象而已。

import  math  as  m

#import math
#m = math

print(m.sqrt(4)) #开方运算

2. from…import导入

Python中可以使用from…import导入模块中的成员。基本语法格式如下：

from 模块名 import 成员1，成员2，…

如果希望导入一个模块中的所有成员，则可以采用如下方式：

from 模块名 import *

尽量避免from 模块名 import *这种写法。*它表示导入模块中所有的不是以下划线_开头的名字都导入到当前位置。但不知道导入什么名字，很有可能会覆盖掉你之前已经定义的名字。而且可读性极其的差。一般生产环境中尽量避免使用。

使用from…import导入模块指定的成员

from math import pi,sin

print(sin(pi/2))    #输出1.0

3. import语句和from...import语句的区别

import导入的是模块。from...import导入的是模块中的函数/类。

如果进行类比的话，import导入的是“文件”，我们要使用该“文件”下的内容，必须前面加“文件名称”。from...import导入的是文件下的“内容”，我们直接使用这些“内容”即可，前面再也不需要加“文件名称”了。

我们自定义一个模块calculator.py：

"""一个实现四则运算的计算器"""

def add(a,b):
    return a+b

def minus(a,b):
    return a-b


class MyNum():
    def print123(self):
        print(123)

我们在另一个模块test.py测试：

import calculator

a = calculator.add(30,40)
# add(100,200)      #不加模块名无法识别
print(a)

from calculator import *

a = add(100,200)    #无需模块名，可以直接引用里面的函数/类
print(a)

b = MyNum()
b.print123()

4. `_import__()`动态导入

import语句本质上就是调用内置函数__import__()，我们可以通过它实现动态导入。给__import__()动态传递不同的的参数值，就能导入不同的模块

使用__import__()动态导入指定的模块

s = "math"
m = __import__(s)   #导入后生成的模块对象的引用给变量m
print(m.pi)

注意：一般不建议我们自行使用__import__()导入，其行为在python2和python3中有差异，会导致意外错误。如果需要动态导入可以使用importlib模块

import importlib
a = importlib.import_module("math")
print(a.pi)

5. 模块的加载问题

当导入一个模块时，模块中的代码都会被执行。不过，如果再次导入这个模块，则不会再次执行。

Python的设计者为什么这么设计？因为，导入模块更多的时候需要的是定义模块中的变量、函数、对象等。这些并不需要反复定义和执行。“只导入一次import-only-once”就成了一种优化。

一个模块无论导入多少次，这个模块在整个解释器进程内有且仅有一个实例对象。

test02.py的源代码:

print("test模块被加载了...")

test03.py的源代码:

import test02   #会执行test02模块中的语句
import test02   #不会再执行test02模块中的语句

有时候我们确实需要重新加载一个模块，这时候可以使用：importlib.reload()方法：

import test02
import test02
print("####")
import importlib
importlib.reload(test02)

四、包package的使用

1. 包(package)的概念和结构

当一个项目中有很多个模块时，需要再进行组织。我们将功能类似的模块放到一起，形成了“包”。本质上，“包”就是一个必须有__init__.py的文件夹。典型结构如下：

包下面可以包含“模块(module)”，也可以再包含“子包(subpackage)”。就像文件夹下面可以有文件，也可以有子文件夹一样。

上图中，a是上层的包，下面有一个子包：aa。可以看到每个包里面都有__init__.py文件。

2. pycharm中创建包

在pycharm开发环境中创建包，非常简单。在要创建包的地方单击右键：New-->Python package即可。pycharm会自动帮助我们生成带有__init__.py文件的包。

3. 导入包操作和本质

上一节中的包结构，我们需要导入module_AA.py。方式如下：

import a.aa.module_AA

在使用时，必须加完整，比如：a.aa.module_AA.fun_AA()
from a.aa import module_AA

在使用时，直接可以使用模块名。比如：module_AA.fun_AA()
from a.aa.module_AA import fun_AA 直接导入函数

在使用时，直接可以使用函数名。比如：fun_AA()

from package import item 这种语法中，item可以是包、模块，也可以是函数、类、变量。

import item1.item2 这种语法中，item必须是包或模块，不能是其他。

导入包的本质其实是“导入了包的__init__.py”文件。也就是说，import pack1意味着执行了包pack1下面的__init__.py文件。这样，可以在__init__.py中批量导入我们需要的模块，而不再需要一个个导入。

__init__.py的2个核心作用：

作为包的标识，不能删除。
导入包实质是执行__init__.py文件，可以在__init__.py文件中做这个包的初始化、以及需要统一执行代码、批量导入

测试包的__init__.py文件本质用法

a包下的__init__.py文件内容:

import turtle
import math

print("导入a包")

b包下的module_B1.py文件中导入a包，代码如下:

import a
print(a.math.pi)

python非常巧妙的通过__init__.py文件将包转成了模块的操作。

4. **用`*`导入包**

import * 这样的语句理论上是希望文件系统找出包中所有的子模块，然后导入它们。这可能会花长时间等。Python 解决方案是提供一个明确的包索引。

这个索引由 __init__.py 定义 __all__ 变量，该变量为一个列表，如上例 a包下的 __init__.py 中，可定义 __all__ = ["module_A","module_A2"]

这意味着， from sound.effects import * 会从对应的包中导入以上两个子模块；

尽管提供import *的方法，仍不建议在生产代码中使用这种写法。

[Python-8]Python模块

一、模块化(module)程序设计理念

二、模块化编程的流程

1. 模块的API和功能描述要点