【python】39_模块与包

1. 模块

模块就是工具包,要想使用这个工具包中的工具(就好比函数),就需要导入这个模块。
模块是非常简单的Python文件，单个Python文件就是一个模块，两个文件就是两个模块。

模块分为三类:

1. 内置模块,python内部提供的功能

2. 第三方模块,下载、安装、使用。
   pip install 模块名称（给哪个python解释器安装模块，就用哪个解释器中的pip）

   例如：在cmd中，给python37安装xlwt模块（先把python37中pip的目录加入到环境变量）
   这里提示我的pip版本有点低，根据提示更新即可。
   
   pip 版本更新成功。
   
   安装成功之后，可以到python37目录中的Lib下的site-packages中查看模块。
   

   这个目录存放安装成功之后的第三方模块。
   

3. 自定义模块
   我们知道一个py文件就是一个模块。
   这里我们自己新建一个py文件名为selfDefine，在这个文件里定义两个函数func1和func2
   
   再在新的test.py文件中，导入这个自定义的selfDefine模块，并调用其中的func1函数
   
   执行后，得到了selfDefine模块中函数的调用结果。
   
   所以，在这里selfDefine这个py文件就是我们的自定义模块。当然这里的代码展示比较简单

1.1 模块的导入

模块的导入方式有以下5种：

1. import module1,module2（推荐使用）
当解释器遇到import语句,如果模块在当前的搜索路径就会被导入

2. import 模块名.函数名
为什么必须加上模块名调用呢?
因为可能存在这样一种情况:在多个模块中含有相同名称的函数,如果只是通过函数名来调用,解释器无法知道到底要调用哪个函数。所以如果像上述这样引入模块的时候,调用函数必须加上模块名。

3.from 模块名 import 函数/变量名（推荐使用）
如果只需要用到模块中的某个函数/变量/类,如何导入呢?
通过这种方式引入的时候,调用函数时只能给出函数名,不能给出模块名,但是当两个模块中含有相同名称函数的时候,后面一次引入会覆盖前一次引入。

4. import 长模块名 as 短模块名
from 模块名 import 长函数名 as 短函数名
如果导入的模块名/函数名/变量名过长,该如何操作呢?
可以参考下面这些例子:
import numpy as np
import os.path as pth
from random import randint as rint

5.from 模块名 import *
如果把一个模块的所有内容全都导入,如何操作呢?
这提供了一个简单的方法来导入一个模块中的所有项目。然而这种声明不该被过多地使用。

【补充】相对导入和绝对导入
相对导入：
如果一个模块要导入另一个模块，并且这两个模块在同一个子目录下，则可以使用
from . import 模块
如果要导入的模块在上一级子目录中,则可以使用
from . . import 模块
但注意 一定要有子目录,不能在根目录下使用from . import 模块，会报错。
绝对导入：
就是一级一级目录写清楚，from 模块.模块.模块 import 模块

1.2 模块的属性

1.模块中的 __all__有什么作用?
用from xxx import *导入所有信息时， 判断模块中是否有__all__属性， 没有的话， 所有信息均可导入。 有的话，只有__all__列表里面指定的变量可以导入。
website.py

name = 'potizo'
passwd = '123'

def login():
    print('login success')

def register():
    print('register success')

__all__ = ['login','name']

在__all__属性.py文件中导入website的所有信息，再调用login（）、register（）、name和passwd。可以看到，只有在__all__属性中的变量能够被调用，没有在其中的变量无法被调用。

（可以参考random模块中的__all__用法）

2.模块中的 __file__有什么作用?
website.py

name = 'potizo'
passwd = '123'

def login():
    print('login success')

def register():
    print('register success')

__all__ = ['login','name']
print(__file__)   ##打印文件的绝对路径

if __name__ == '__main__':
    print('内部测试')

all.py

from website import *
print(name)
login()

执行结果：

可以看到虽然在__all__.py中没有执行print(file) ，但是在导入模块时，相当于执行了py文件中的内容，即执行了website.py中的print(file)，并打印出了website.py的绝对路径。

3.模块中的 __doc__有什么作用?
website.py

name = 'potizo'
passwd = '123'

def login():
    print('login success')

def register():
    print('register success')

__all__ = ['login','name']


if __name__ == '__main__':
    print(__doc__)   ##打印模块的帮助文档

执行结果:

1.3 如何定位模块

导入一个模块,Python解析器对模块位置的搜索顺序是:

1. 当前目录
   注：自定义模块或者包时，名称不能与导入的模块名称相同，否则就会直接在当前目录中查找。 例如要导入json模块，那么在当前目录下就不要起一个名为json的py文件，否则会导入这个py文件。
2. 如果不在当前目录,Python则搜索在shell变量PYTHONPATH下的每个目录。
3. 如果都找不到,Python会察看默认路径。UNIX下,默认路径一般为/usr/local/lib/python/
4. 模块搜索路径存储在system模块的sys.path变量中。
   
   查找的路径要去掉蓝色线条的，因为这两个是pycharm自带的。
   
   如果在cmd下执行这个文件，就不会含有上面蓝色线条的路径。红色线条的路径是内置模块与第三方模块的存放路径，如果我们有自定义模块，建议存放在当前目录中。
   
   如果自定义的模块不在上述查找路径中，使用sys.path.append( ),将路径加入其中即可

2.包

包将有联系的模块组织在一起，有效避免模块名称冲突问题，让应用组织结构更加清晰。

2.1 包的目录结构

一个普通的python应用程序目录结构：

注意这里的__init__.py文件，在py2中一定要添加，py3中不强求但是建议也要加。

官方文档中的包举例：

包里可以嵌套包，但都是有__init__.py文件的。导入包的过程，其实就是执行包内的__init__.py初始化文件。

2.2 从 * 导入包

import * 理论上是希望文件系统找出包中所有的子模块，然后导入它们。
但是会花长时间，并出现边界效应等。Python 解决方案是提供一个明确的包索引。这个索引由 init.py 定义 all 变量，该变量为一列表， 只会导入指定的内容。

方法1：一定要在__init__.py告诉包包含的模块;
例如，我们自定义一个包package_a

包中有两个模块。module_a1模块中的内容是

module_a2模块中的内容是

如果我们只想让module_a1被调用,而module_a2不被调用
就需要在__init__.py文件中写入以下内容:

即只有module_a1别人可以调用,而module_a2不能被调用。

也可以在文件中直接导入模块中的变量，例如在__init__.py文件中写下如下内容:

再在文件中直接导入

也是okay的

当然，如果__init__.py文件中什么都不写，意味着当前包里面的所有模块都导入

方法2：不需要__init__.py告诉包包含的模块

直接在文件中，导入时用from 包 import 模块这个方法即可。或者用import 包.模块 as 新名称

3.模块制作

假如你自己写了一个自我感觉很不错的程序，那么如何将这个程序打包封装成模块，之后就可以很方便地引用自己的模块去实现相关要求呢？

3.1 模块制作:

• 定义模块
  在Python中,每个Python文件都可以作为一个模块,模块的名字就是文件的名字。
• 调用模块
• 测试模块
  在实际开中,当一个开发人员编写完一个模块后,为了让模块能够在项目中达到想要的效果,这个开发人员会自行在py文件中添加一些测试信息。

这里有个问题:
测试代码,应该是单独执行文件时才应该执行的,不应该是其他的文件中引用而执行, 如何解决这个问题呢?
解决方法:
python在执行一个文件时有个 __name__变量
可以根据__name__变量的结果能够判断出,是直接执行的python脚本还是被引入执行的,从而能够有选择性的执行测试代码.

3.2 模块发布

3.2.1 准备发布

1. 为模块文件创建一个文件夹，并将模块文件复制到这个文件中（一般，文件夹的名字和模块的名字一样）
   例如 我要发布一个名为gif的模块
   

2. 在文件夹中创建一个名为『setup.py』的文件，内容如下：

    #从Python发布工具导入"setup"函数
    from distutils.core import setup
    setup(
        name='模块的名称',
        version='模块的版本',
        author='作者名',
        author_email='作者邮箱地址',
        url='官方网址',
        description='模块介绍'
    )
   

例如

3.2.2 构建发布 & 发布预览

1. 构建模块并一个发布文件
   python setup.py build
   
   python setup.py sdist
   
2. 发布预览
   
3. 将发布安装到你的Python本地副本中：
   python setup.py install
   
   这个tar.gz文件就是我们的模块，如果别人需要使用，直接发给对方安装即可。这里我们自己安装尝试一下，是否可以成功导入。

先解压文件

解压成功之后，进入到目录中

执行python setup.py install命令

进入解释器测试，可以成功导入模块