Python 模块相关

一、什么是模块、包

按照逻辑有组织的Python代码片段称为模块（module），对应单个文件，test.py就是一个模块，test为模块名字。

包（package）是一个有层次的文件目录结构，对应一个目录，该目录下含有__init__.py 文件和其他模块。

二、关于引入import

在安装python时，自带标准库中的所有模块都被加入到了sys.path 里面了，用下面方法可以看到模块所在位置：

>>>import sys
>>>import pprint
>>>pprint.pprint(sys.path)

['',
 'C:\\Windows\\system32\\python27.zip',
 'C:\\Python27\\DLLs',
 'C:\\Python27\\lib',
 'C:\\Python27\\lib\\plat-win',
 'C:\\Python27\\lib\\lib-tk',
 'C:\\Python27',
 'C:\\Python27\\lib\\site-packages',
 'C:\\Python27\\lib\\site-packages\\PIL']

凡在上面列表所包括位置内的 .py 文件都可以作为模块引入。可以将自己编写的test.py放到这些目录下面，这样就能够直接import引入，被Python解释器知道了。

将模块文件放到指定位置是一种不错的方法，但不方便管理，能不能放到别处呢？当然能，用sys.path.append(new_path)或sys.path.insert(0,new_path)就是不管把文件放哪里，都可以把其位置告诉 Python 解释器。

#!/usr/bin/env Python
# coding=utf-8
lang = "python"

编写以上文件命名为test.py。

用sys.path.append(new_path)方式告诉Python解释器。

>>> import sys
>>> sys.path.append("~/文档/test.py")
>>> import test
>>> test.lang
'python'

在import test后该目录下生成test.pyc文件，解释器的作用就是将.py 的文件转化为 .pyc文件，而.pyc 文件是由字节码(bytecode)构成的，然后计算机执行 .pyc 文件。

有了 .pyc 文件后，每次运行就不需要重新让解释器来编译 .py 文件了，除非 .py 文件修改了。这样，Python 运行的就是那个编译好了的 .pyc 文件。

如何确定是被当做程序执行还是被当做模块引入？将 test.py 文件进行改造。

#!/usr/bin/env Python
# coding=utf-8
def lang():
    return "Python"
if __name__ == "__main__":
    print lang()

被当做程序执行：

C:\Users\bowen03\Desktop>python test.py
Python

被当做模块引入：

>>> import sys
>>> sys.path.append("C:\\Users\\bowen03\\Desktop\\test.py")
>>> import test
>>> test.lang()
'Python'

同样一个.py文件，可以把它当做程序来执行，也可以将它作为模块引入。

>>> __name__
'__main__'
>>> test.__name__
'test'

如果要作为程序执行，则__name__ == "__main__" ，如果作为模块引入，则test.__name__ == "test" ，即变量__name__的值是模块名称。用这种方式可以区分是执行程序还是作为模块引入了。

在一般情况下，如果仅仅是用作模块引入，可以不写if __name__ == "__main__" 。

将改造后的test.py重命名为sample.py(文件放置在~/Python目录下)，用sys.path.insert(new_path)方式告诉Python解释器

bowen03@bowen03-Precision-Tower-3620:~$ python
Python 2.7.12 (default, Nov 19 2016, 06:48:10) 
[GCC 5.4.0 20160609] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> import pprint
>>> pprint.pprint(sys.path)
['',
 '/usr/lib/python2.7',
 '/usr/lib/python2.7/plat-x86_64-linux-gnu',
 '/usr/lib/python2.7/lib-tk',
 '/usr/lib/python2.7/lib-old',
 '/usr/lib/python2.7/lib-dynload',
 '/home/bowen03/.local/lib/python2.7/site-packages',
 '/usr/local/lib/python2.7/dist-packages',
 '/usr/lib/python2.7/dist-packages',
 '/usr/lib/python2.7/dist-packages/PILcompat',
 '/usr/lib/python2.7/dist-packages/gtk-2.0']
>>> sys.path.insert(0,"~/Python")
>>> pprint.pprint(sys.path)
['~/Python',
 '',
 '/usr/lib/python2.7',
 '/usr/lib/python2.7/plat-x86_64-linux-gnu',
 '/usr/lib/python2.7/lib-tk',
 '/usr/lib/python2.7/lib-old',
 '/usr/lib/python2.7/lib-dynload',
 '/home/bowen03/.local/lib/python2.7/site-packages',
 '/usr/local/lib/python2.7/dist-packages',
 '/usr/lib/python2.7/dist-packages',
 '/usr/lib/python2.7/dist-packages/PILcompat',
 '/usr/lib/python2.7/dist-packages/gtk-2.0']
>>> from Python import sample
>>> sample.lang()
'Python'

但是，以上两种方法在退出python环境后自己添加的路径就会自动消失！再开启时，还得重新告知。两种方法的实际应用：

# --------------------------------------------------------
# Fast R-CNN
# Copyright (c) 2015 Microsoft
# Licensed under The MIT License [see LICENSE for details]
# Written by Ross Girshick
# --------------------------------------------------------

"""Set up paths for Fast R-CNN."""

import os.path as osp
import sys

def add_path(path):
    if path not in sys.path:
        sys.path.insert(0, path)

this_dir = osp.dirname(__file__)
#this_dir = '/home/bowen03/PycharmProjects/test'

# Add caffe to PYTHONPATH
caffe_path = osp.join(this_dir, '..', 'caffe-fast-rcnn', 'python')
#caffe_path = '/home/bowen03/PycharmProjects/test/../caffe-fast-rcnn/python'
#相当于'/home/bowen03/PycharmProjects/caffe-fast-rcnn/python'
add_path(caffe_path)

# Add lib to PYTHONPATH
lib_path = osp.join(this_dir, '..', 'lib')
#lib_path = '/home/bowen03/PycharmProjects/test/../lib'
#相当于'/home/bowen03/PycharmProjects/lib'
add_path(lib_path)

从而方便了lib目录下面的各种引用。

永久添加路径到sys.path中，除了最开始时说的将写好的.py文件放到 sys.path下（一般是放在/site-packages目录下）， 还可以设置PYTHONPATH环境变量。

将~/Python，也就是/home/bowen03/Python设置环境变量。

vim /etc/profile

在打开文件的最后添加

export PYTHONPATH=$PYTHONPATH:/home/bowen03/Python

或

export PYTHONPATH=$PYTHONPATH:~/Python

三、不同层级目录的引入import

从上一部分可以看出，导入模块关键是能够根据sys.path环境变量的值，找到具体模块的路径。

下面结合具体介绍几种常见的引入：

（1）主程序与模块程序在同一目录下:
如下面程序结构:
`-- src
    |-- mod1.py
    `-- test1.py
    若在程序test1.py中导入模块mod1, 则直接使用import mod1或from mod1 import *;

（2）主程序所在目录是模块所在目录的父(或祖辈)目录
如下面程序结构:
`-- src
    |-- mod1.py
    |-- mod2
    |   `-- mod2.py
    `-- test1.py
    若在程序test1.py中导入模块mod2, 需要在mod2文件夹中建立空文件__init__.py文件(也可以在该文件中自定义输出模块接口); 然后使用 from mod2.mod2 import * 或import mod2.mod2.
（3）主程序导入上层目录中模块或其他目录(平级)下的模块
如下面程序结构:
`-- src
    |-- mod1.py
    |-- mod2
    |   `-- mod2.py
    |-- sub
    |   `-- test2.py
    `-- test1.py
    若在程序test2.py中导入模块mod1和mod2。首先需要在mod2下建立__init__.py文件(同(2))，src下不必建立该文件。然后调用方式如下:

import sys
sys.path.append("..")
import mod1
import mod2.mod2