Python包的编写和使用

号称史上最详细的Python包编写方案，逐步深入，理解透彻

---

上一篇博客中，那么多功能写到一个模块里面不嫌麻烦吗？说好的细分呢？模块之间重名了怎么办？拆分成包的形式咯~~~

1、拆分功能

将功能拆分，每一个功能写成一个模块，放入文件夹中

>>> import calculate
>>> calculate
<module 'calculate' (namespace)>
>>> calculate.add.add(*range(100))
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 'calculate' has no attribute 'add'
>>> dir(calculate)
['__doc__', '__loader__', '__name__', '__package__', '__path__', '__spec__']
>>> calculate.__package__
'calculate'
>>> calculate.__doc__
>>> calculate.__name__
'calculate'

add方法出错了？使用dir()查看，似乎calculate包并没有add方法，这是怎么回事？没有加__init__.py文件！
如果一个包没有__init__.py文件，就会被看成一个普通的文件夹，虽说普通文件夹也能够import，但是并不能实现什么功能。

2、添加__init__.py文件

添加了__init__.py文件后，再进行导入，生成了cache文件夹

>>> import calculate
>>> calculate
<module 'calculate' from 'D:\\calculate\\__init__.py'>
>>> calculate.add.add(*range(100))
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 'calculate' has no attribute 'add'
>>> dir(calculate)
['__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__']

为什么还是提示没有add方法！明明已经有__init__.py文件了！

经查阅资料，__init__.py 控制着包的导入行为，假如__init__.py为空，那么仅仅导入包是什么都做不了的，也不能访问包下面的模块；只有当在__init__.py将模块逐一import，导入包后才能有效地使用包中的模块。
当然，没有在__init__.py中import模块的包，还是可以通过from 包 import 模块的方式导入模块。

所以在__init__.py为空的时候，还是可以通过（也只能通过）以下方法使用各个模块。

>>> from calculate import add
>>> dir(add)
['__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', '_add_two', 'add', 'reduce']
>>> add.add(*range(100))
4950

要注意，包、模块、方法是三个级别的东西，譬如上面的calculate是包，import导入的是add模块，模块.add中的add是函数方法。等级一定要清晰明了，不然会出错。当然，也可以直接导入模块里面的函数方法，这样使用过程中就不用冗长的前缀了。

>>> from calculate.add import add
>>> from calculate.minus import minus
>>> add(1,9)
10
>>> minus(1,9)
-8

3、from 包 import *

>>> from calculate import *
>>> dir(calculate)
['__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__']
>>> from calculate import add
>>> dir(calculate)
['__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', 'add']

一般来说，导入包中所有的模块可以使用from 包 import *，但是看上面一段代码，似乎并没能导入全部模块之后，而单独导入某一个模块是成功的。这是为什么？最终还是要归结于__init__.py的内容。

4、添加__init__.py文件内容

想要实现from 包 import *的功能，只需要在__init__.py文件中添加模块的__all__属性

__all__ = ['add', 'minus', 'multi', 'divide']

将所有的模块名称以列表的形式赋值给__all__属性，就可以导入所有模块。

>>> import calculate
>>> dir(calculate)
['__all__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__']
>>> calculate.__all__
['add', 'minus', 'multi', 'divide']
>>> from calculate import *
>>> dir(calculate)
['__all__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', 'add', 'divide', 'minus', 'multi']

总之，以*导入时，package内的module是受__init__.py限制的。

5、再次思考

but，问题又来了，现在我们使用calculate模块功能的方法是这样的：

>>> from calculate import *
>>> calculate.add
<module 'calculate.add' from 'D:\\calculate\\add.py'>
>>> calculate.add.add(*range(100))
4950

没觉得有哪里不妥吗！！！我们在使用Python内置标准模块的时候，没有哪个模块是让你先from 包 import *然后再按照包、模块、函数的顺序调用的吧！！！从用户角度使用我们自己编写的包：

>>> import calculate
>>> calculate.add(*range(100))
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 'calculate' has no attribute 'add'

和之前的情况一样，出错了！！！为什么我们自己编写的包不能按照最简便的方式调用？问题出在哪了！
既然模块的编写没有问题的话，只可能还是__init__.py的问题了！

6、修改__init__.py

>>> import calculate
>>> dir(calculate)
['__all__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', 'add', 'divide', 'minus', 'multi']
>>> calculate.add
<function add at 0x00ED2930>
>>> calculate.add(*range(100))
4950
>>> calculate.minus(10,5)
5

看！这样调用方式是不是就有点样子了。import之后，可以直接调用这个包的函数方法，越过模块一级的调用。

如何实现呢？参照系统模块的编写方法，按照如下方式修改__init__.py：

from calculate.add import add
from calculate.minus import minus
from calculate.multi import multi
from calculate.divide import divide

从包中的每一个模块导入其中的函数，从而能够使得函数方法能够被直接调用。

注意，一定要写包的名称calculate.作为前缀，不然会找不到模块！

包的编写内容比较繁杂，主要是__init__.py这一重要文件决定了包的导入和使用方式，需要细心设计，站在用户的角度设计出易于调用的包。

（By XuZhiyuan 2016-06-18 10点 @Hohai Sunny）