Python -- 模块

Python模块

一、什么是模块

在Python中有一个概念叫做模块（module），这个和C语言中的头文件以及Java中的包很类似，比如在Python中要调用sqrt函数，必须用import关键字引入math这个模块，下面就来了解一下Python中的模块。

说的通俗点：模块就好比是工具包，要想使用这个工具包中的工具(就好比函数)，就需要导入这个模块。在Python中用关键字import来引入某个模块。

 

二、导入模块的几种方式

1、import module1,mudule2...
    引用方式：模块名.函数名
2、from modname import fun1,fun2....
    引用方式：fun1
    注：通过这种方式引入的时候，调用函数时只能给出函数名，不能给出模块名，但是当两个模块中含有相同名称函数的时候，后面一次引入会覆盖前一次引入。也就是说假如模块A中有函数function( )，在模块B中也有函数function( )，如果引入A中的function在先、B中的function在后，那么当调用function函数的时候，是去执行模块B中的function函数。    
3、from modname import *
4、import modname as 别名 

 

三、模块搜索顺序 

当你导入一个模块，Python解析器对模块位置的搜索顺序是：
1、当前目录
2、如果不在当前目录，Python则搜索在shell变量PYTHONPATH下的每个目录。
3、如果都找不到，Python会察看默认路径。UNIX下，默认路径一般为/usr/local/lib/python/
4、模块搜索路径存储在system模块的sys.path变量中。变量里包含当前目录，PYTHONPATH和由安装过程决定的默认目录。

import sys
print(sys.path)

['', 
'd:\\ProgramData\\Anaconda3\\python36.zip', 
'd:\\ProgramData\\Anaconda3\\DLLs',
'd:\\ProgramData\\Anaconda3\\lib',
'd:\\ProgramData\\Anaconda3',
'd:\\ProgramData\\Anaconda3\\lib\\site-packages',
'd:\\ProgramData\\Anaconda3\\lib\\site-packages\\Babel-2.5.0-py3.6.egg', 'd:\\ProgramData\\Anaconda3\\lib\\site-packages\\win32', 'd:\\ProgramData\\Anaconda3\\lib\\site-packages\\win32\\lib', 'd:\\ProgramData\\Anaconda3\\lib\\site-packages\\Pythonwin', 'd:\\ProgramData\\Anaconda3\\lib\\site-packages\\IPython\\extensions', 'C:\\Users\\Administrator\\.ipython']

 

四、重新导入模块

模块被导入后， import module 不能重新导入模块，重新导入需用reload重新导入模块
    测试模块内容

    调用模块中的方法

修改测试模块

重新加载模块

 

五、模块的制作

<1>定义自己的模块

在Python中，每个Python文件都可以作为一个模块，模块的名字就是文件的名字。

比如有这样一个文件test.py，在test.py中定义了函数add( )。

test.py

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

<2>调用自己定义的模块

那么在其他文件中就可以先import test，然后通过test.add(a,b)来调用了，当然也可以通过from test import add来引入

main.py

import test

result = test.add(11,22)
print(result)

<3>测试模块

在实际开中，当一个开发人员编写完一个模块后，为了让模块能够在项目中达到想要的效果，这个开发人员会自行在py文件中添加一些测试信息，例如：test.py

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

# 用来进行测试
ret = add(12,22)
print('int test.py file,,,,12+22=%d'%ret)

如果此时，在其他py文件中引入了此文件的话，想想看，测试的那段代码是否也会执行呢！

main.py

import test

result = test.add(11,22)
print(result)

运行现象：

至此，可发现test.py中的测试代码，应该是单独执行test.py文件时才应该执行的，不应该是其他的文件中引用而执行

为了解决这个问题，python在执行一个文件时有个变量__name__

直接运行此文件

在其他文件中import此文件

总结：

• 可以根据__name__变量的结果能够判断出，是直接执行的python脚本还是被引入执行的，从而能够有选择性的执行测试代码

 

六、模块中的__all__

__all__是一个字符串list，用来定义模块中对于from XXX import *时要对外导出的符号，即要暴露的接口，但它只对import *起作用，对from XXX import XXX不起作用。

1. 没有__all__

2. 模块中有__all__

总结

• 如果一个文件中有__all__变量，那么也就意味着rom xxx import *导入时，只会导入__all__中的元素。

 

七、模块发布（参考Python -- 包）

模块发布

        将模块写好后，我们可以将这些模块放在setup.py包中进行发布。接下来，将分步骤讲解如何发布模块，具体步骤如下。

1.mymodule目录结构体如下：

.
├── setup.py
├── suba
│   ├── aa.py
│   ├── bb.py
│   └── __init__.py
└── subb
    ├── cc.py
    ├── dd.py
    └── __init__.py

2.编辑setup.py文件

py_modules需指明所需包含的py文件

from distutils.core import setup

setup(name="dongGe", 
    version="1.0", 
    description="dongGe's module", 
    author="dongGe", 
    py_modules=['suba.aa', 'suba.bb', 'subb.cc', 'subb.dd']
)

3.构建模块

执行命令：python setup.py build

构建后目录结构

.
├── build
│   └── lib.linux-i686-2.7
│       ├── suba
│       │   ├── aa.py
│       │   ├── bb.py
│       │   └── __init__.py
│       └── subb
│           ├── cc.py
│           ├── dd.py
│           └── __init__.py
├── setup.py
├── suba
│   ├── aa.py
│   ├── bb.py
│   └── __init__.py
└── subb
    ├── cc.py
    ├── dd.py
    └── __init__.py

4.生成发布压缩包

执行命令：python setup.py sdist

打包后,生成最终发布压缩包dongGe-1.0.tar.gz , 目录结构

.
├── build
│   └── lib.linux-i686-2.7
│       ├── suba
│       │   ├── aa.py
│       │   ├── bb.py
│       │   └── __init__.py
│       └── subb
│           ├── cc.py
│           ├── dd.py
│           └── __init__.py
├── dist
│   └── dongGe-1.0.tar.gz
├── MANIFEST
├── setup.py
├── suba
│   ├── aa.py
│   ├── bb.py
│   └── __init__.py
└── subb
    ├── cc.py
    ├── dd.py
    └── __init__.py

上述目录结构包含如下选项：

（1）、MANIFEST：这个文件包含发布的文件列表。

（2）、dist/itheima-1.0.tar.gz：发布包

（3）、setup.py：用来存放元数据。

至此，模块完成了发布。