python包模块相对导入from和import

python包模块相对导入from和import

1 python程序运行主目录

1.1 描述

无包文件__init__.py下，python通过import module导入模块时，先搜索程序运行主目录。

程序运行主目录为运行的py文件所在目录，而不是执行python.exe时所在目录。

模块搜索路径sys.path参考：python模块基础

1.2 目录结构

# --E:\documents\F盘\
# ----cat1\
# ------string.py
# ------main_str.py
# ------cat1a\
# --------main_str.py

1.3 文件内容

cat1\string.py

# coding=utf-8
import os
print('run:{}'.format(os.path.abspath(__file__)))
index = '9555 in cat1\string.py'

cat1\main_str.py

# coding=utf-8
import sys,os
import string
print('run:{}'.format(os.path.abspath(__file__)))
print('print(sys.path[0]):{}'.format(sys.path[0]))
print('print(string):{}'.format(string))

cat1\cat1a\main_str.py

# coding=utf-8
import sys,os
import string
print('run:{}'.format(os.path.abspath(__file__)))
print('print(sys.path):{}'.format(','.join(sys.path)))
print('print(string):{}'.format(string))

1.4 示例python2.7

本示例在文件模式下执行，非交互模式下执行。

# ################
# 打开cmd，执行下面命令进入程序运行主目录
C:\Users\Administrator>e:&cd E:\documents\F盘\cat1
# 通过python2.7 运行 main_str.py 程序
E:\documents\F盘\cat1>d:\Python27\python main_str.py
run:E:\documents\F盘\cat1\string.py
run:E:\documents\F盘\cat1\main_str.py
# 模块搜索路径 sys.path 的第1路径为程序运行主目录
print(sys.path[0]):E:\documents\F盘\cat1
# 模块搜索路径优先搜索程序运行主目录
# 导入的string模块为程序运行主目录的string模块
print(string):<module 'string' from 'E:\documents\F盘\cat1\string.py'>
# ################
# cd到上级目录
E:\documents\F盘\cat1>cd ..
# 在上级目录 运行 cat1\main_str.py 程序
E:\documents\F盘>d:\Python27\python cat1\main_str.py
run:E:\documents\F盘\cat1\string.pyc
run:E:\documents\F盘\cat1\main_str.py
# 程序运行目录为main_str.py文件所在目录
print(sys.path[0]):E:\documents\F盘\cat1
print(string):<module 'string' from 'E:\documents\F盘\cat1\string.pyc'>
# ################
# 程序运行目录找不到模块，接着在sys.path的剩余路径从左至右查找
E:\documents\F盘>d:\Python27\python cat1\cat1a\main_str.py
run:E:\documents\F盘\cat1\cat1a\main_str.py
print(sys.path):E:\documents\F盘\cat1\cat1a,C:\Windows\SYSTEM32\python27.zip,d:\Python27\DLLs,d:\Python27\lib,d:\Python27\lib\plat-win,d:\Python27\lib\lib-tk,d:\Python27,d:\Python27\lib\site-packages
print(string):<module 'string' from 'd:\Python27\lib\string.pyc'>

1.5 示例python3.7

本示例在文件模式下执行，非交互模式下执行。

# ################
# 打开cmd，执行下面命令进入程序运行主目录
C:\Users\Administrator>e:&cd E:\documents\F盘
# 通过python3.7 运行 main_str.py 程序
E:\documents\F盘>d:\python3\python cat1\main_str.py
run:E:\documents\F盘\cat1\string.pyc
run:E:\documents\F盘\cat1\main_str.py
# 程序运行目录为main_str.py文件所在目录
print(sys.path[0]):E:\documents\F盘\cat1
print(string):<module 'string' from 'E:\documents\F盘\cat1\string.pyc'>

2 python为何用包导入

描述

python没有包导入时，通过搜索路径查找需要导入的模块。使得跨目录的模块导入，都需要配置在搜索路径里面。

NO	内容	描述
1	简化模块搜索路径	全部跨目录的模块导入都使用相同根目录的包导入，只需将根目录配置在搜索路径，从而简化了模块搜索路径的配置和查找。
2	代码更具可读性	包导入路径使得模块信息更详细，模块角色更明显。 比如：第（1）种使用包导入的方法必第（2）种信息更详细。 **（1）import robot.api.**logger **（2）**import logger

示例

不使用包时，导入模块依赖配置的搜索路径。

# ################
# 本地已安装第三方库lib1，没有使用任何包
# --lib1\
# ----tools.py
# ----others.py
# ----main.py
# 本地已安装第三方库lib2，没有使用任何包
# --lib2\
# ----tools.py
# ----others.py
# ----main.py
# 本地开发目录lib3，没有使用任何包
# --lib3\
# ----main.py
# ################
# 在lib3\main.py导入lib1\tools
# 需将lib1\tools配置在模块搜索路径，并且比lib2\tools靠左
import tools
# 在lib3\main.py导入lib2\tools
# 需将lib2\tools配置在模块搜索路径，并且比lib1\tools靠左
import tools

使用相同的根目录的包导入模块，只需配置根目录到搜索路径，根据需求代码明确导入指定模块。

# ################
# libs\
# 本地已安装第三方库lib1，通过__inin__.py使用包模式
# --lib1\
# ----__init.py
# ----tools.py
# ----others.py
# ----main.py
# 本地已安装第三方库lib2，通过__inin__.py使用包模式
# --lib2\
# ----__init.py
# ----tools.py
# ----others.py
# ----main.py
# 本地开发目录lib3，通过__inin__.py使用包模式
# --lib3\
# ----__init.py
# ----main.py
# ################
# 在lib3\main.py导入lib1\tools和lib2\tools
# 将libs配置在模块搜索路径即可
import lib1.tools
import lib2.tools

3 python包相对导入

3.1 python包导入搜索路径

有包文件__init__.py下，不同python版本import 模块时，搜索模块顺序。

NO	版本	描述
1	python2.6	隐式搜索包目录。先从“包含import 语句的文件”所在包，开始搜索模块，再搜索sys.path路径。
2	python3.0	显式搜索包目录。默认跳过“包含import 语句的文件”所在包，需显示使用相对导入语法，从当前包搜索模块。

3.2 python包绝对和相对导入

python3.0有包文件__init__.py时，包模块导入：

NO	内容	描述
1	绝对导入	默认跳过当前包目录，只检查搜索路径的其他目录。
2	相对导入	使用from相对导入语法，显式只搜索当前包目录。

3.3 python相对导入基础

NO	包模块导入
1	python2.6和python3.0，包相对导入语法：from . import module 、from … import module、 from .module import var，只搜索当前包目录。
2	python2.6，import或from语句不是点开头，先相对再绝对导入搜索模块。
3	python3.0，import或from语句不是点开头，按绝对导入搜索模块。
4	python2.6，通过 from future import absolute_import 实现绝对导入。
5	有包文件__init__.py，才支持相对导入。

3.4 python包外导入

3.4.1 描述

python包外导入（没有包文件__init__.py的目录进行导入）时，python2.6和3.0都是按模块搜索路径进行模块导入，不支持相对导入。

3.4.2 文件内容

E***\documents\F盘\main_str.py

# coding=utf-8
import sys,os
import string
print('run:{}'.format(os.path.abspath(__file__)))
print('print(sys.path[0]):{}'.format(sys.path[0]))
print('print(string):{}'.format(string))

3.4.3 示例导入标准库string

本示例在文件模式下执行，非交互模式执行。

E***\documents\F盘\ 目录不存在string.py文件

# 打开cmd，执行下面命令
E:\documents\F盘>d:\python3\python main_str.py
run:E:\documents\F盘\main_str.py
print(sys.path[0]):E:\documents\F盘
# 程序当前目录没有string.py，导入sys.path其他路径的string.py
print(string):<module 'string' from 'd:\\python3\\lib\\string.py'>

3.4.4 示例导入程序目录string

在程序当前目录(E***\documents\F盘) 增加 string.py

# coding=utf-8
import os
print('run:{}'.format(os.path.abspath(__file__)))

再次运行main_str.py

E:\documents\F盘>d:\python3\python main_str.py
run:E:\documents\F盘\string.py
run:E:\documents\F盘\main_str.py
print(sys.path[0]):E:\documents\F盘
# 导入程序当前目录的string.py
print(string):<module 'string' from 'E:\\documents\\F盘\\string.py'>

3.4.5 示例包外部不支持from点

在main_str.py用相对导入语法：from . import string。没包文件__init__.py不支持相对导入。

# coding=utf-8
import sys,os
# import string
from . import string
print('run:{}'.format(os.path.abspath(__file__)))
print('print(sys.path[0]):{}'.format(sys.path[0]))
print('print(string):{}'.format(string))

再次运行main_str.py

E:\documents\F盘>d:\python3\python main_str.py
Traceback (most recent call last):
  File "main_str.py", line 4, in <module>
from . import string
# 非包文件不支持相对导入
ImportError: attempted relative import with no known parent package

3.5 python包内导入

3.5.1 描述

在包文件__init__.py的目录，python文件使用import导入模块属于包内导入。

NO	版本	描述
1	python2.6	隐式搜索包目录。先从“包含import 语句的文件”所在包，开始搜索模块，再搜索sys.path路径。
2	python3.0	显式搜索包目录。默认跳过“包含import 语句的文件”所在包，需显示使用相对导入语法，从当前包搜索模块。
3	不涉及	python2.6和python3.0，包相对导入语法：from . import module 、from … import module、 from .module import var，只搜索当前包目录。

3.5.2 目录文件内容-1

# --E:\documents\F盘\
# ----pkg1\
# ------__init__.py
# ------pkgmoda.py
# ------main_moda.py

# __init__.py
import os
print('run:{}'.format(os.path.abspath(__file__)))

# pkgmoda.py
# coding=utf-8
import os
import string
print('run:{}'.format(os.path.abspath(__file__)))
print('print(string):{}'.format(string))
index = os.path.abspath(__file__)

# main_moda.py
# coding=utf-8
import sys,os
print('print(sys.path[0]):{}'.format(sys.path[0]))
import pkgmoda
print('run:{}'.format(os.path.abspath(__file__)))
print('print(pkgmoda):{}'.format(pkgmoda))
print('pkgmoda.index:{}'.format(pkgmoda.index))

3.5.3 示例import-python2.7搜索当前包

python2.7先搜索当前包目录，再搜索sys.path模块搜索路径。即先相对再绝对。

本示例在交互模式执行，非文件模式执行。

E***\documents\F盘\ 目录不存在pkgmoda.py文件

# 打开cmd，执行下面命令
E:\documents\F盘>d:\Python27\python
Python 2.7.18 (v2.7.18:8d21aa21f2, Apr 20 2020, 13:25:05) [MSC v.1500 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import pkg1.main_moda
run:E:\documents\F盘\pkg1\__init__.pyc
print(sys.path[0]):
run:E:\documents\F盘\pkg1\pkgmoda.pyc
print(string):<module 'string' from 'd:\Python27\lib\string.pyc'>
run:E:\documents\F盘\pkg1\main_moda.pyc
# 先搜索当前包目录
print(pkgmoda):<module 'pkg1.pkgmoda' from 'pkg1\pkgmoda.pyc'>
pkgmoda.index:E:\documents\F盘\pkg1\pkgmoda.pyc

3.5.4 示例import-python3.7略过当前包

python3.7不搜索当前包目录，直接搜索sys.path模块搜索路径，即绝对导入。

本示例在交互模式执行，非文件模式执行。

E***\documents\F盘\ 目录不存在pkgmoda.py文件

# 打开cmd，执行下面命令
E:\documents\F盘>d:\python3\python
Python 3.7.8 (tags/v3.7.8:4b47a5b6ba, Jun 28 2020, 07:55:33) [MSC v.1916 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import pkg1.main_moda
run:E:\documents\F盘\pkg1\__init__.py
print(sys.path[0]):
# 不搜索当前包目录
Traceback (most recent call last):
  File "", line 1, in <module>
  File "E:\documents\F盘\pkg1\main_moda.py", line 4, in <module>
    import pkgmoda
ModuleNotFoundError: No module named 'pkgmoda'

3.5.5 示例import-python3.7程序目录-文件模式

python3.7直接搜索sys.path模块搜索路径，即绝对导入。

本示例在文件模式执行，非交互模式执行。

E***\documents\F盘\ 目录不存在pkgmoda.py文件

# 打开cmd，执行下面命令
E:\documents\F盘>d:\python3\python pkg1\main_moda.py
# 程序目录为 pkg1
print(sys.path[0]):E:\documents\F盘\pkg1
run:E:\documents\F盘\pkg1\pkgmoda.py
print(string):<module 'string' from 'd:\\python3\\lib\\string.py'>
run:E:\documents\F盘\pkg1\main_moda.py
# 搜索sys.path的程序目录
print(pkgmoda):<module 'pkgmoda' from 'E:\\documents\\F盘\\pkg1\\pkgmoda.py'>
pkgmoda.index:E:\documents\F盘\pkg1\pkgmoda.py

3.5.6 示例import-sys.path

将pkg1\pkgmoda.py剪切到“E***\documents\F盘”。

当前包目录没有模块，sys.path的程序目录有模块。

python2.7先当前包目录，在sys.path，

python3.7只sys.path。

本示例在交互模式执行，非文件模式执行。

# python2.7示例
E:\documents\F盘>d:\Python27\python
Python 2.7.18 (v2.7.18:8d21aa21f2, Apr 20 2020, 13:25:05) [MSC v.1500 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import pkg1.main_moda
run:E:\documents\F盘\pkg1\__init__.pyc
print(sys.path[0]):
run:E:\documents\F盘\pkgmoda.py
print(string):<module 'string' from 'd:\Python27\lib\string.pyc'>
run:E:\documents\F盘\pkg1\main_moda.py
# 搜索程序目录
print(pkgmoda):<module 'pkgmoda' from 'pkgmoda.py'>
pkgmoda.index:E:\documents\F盘\pkgmoda.py
# python3.7示例
E:\documents\F盘>d:\python3\python
Python 3.7.8 (tags/v3.7.8:4b47a5b6ba, Jun 28 2020, 07:55:33) [MSC v.1916 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import pkg1.main_moda
run:E:\documents\F盘\pkg1\__init__.py
print(sys.path[0]):
run:E:\documents\F盘\pkgmoda.py
print(string):<module 'string' from 'd:\\python3\\lib\\string.py'>
run:E:\documents\F盘\pkg1\main_moda.py
# 搜索程序目录
print(pkgmoda):<module 'pkgmoda' from 'E:\\documents\\F盘\\pkgmoda.py'>
pkgmoda.index:E:\documents\F盘\pkgmoda.py

3.5.7 示例from点相对导入

“目录文件内容-1”修改 main_moda.py 为相对导入 from . import pkgmoda

# main_moda.py
# coding=utf-8
import sys,os
print('print(sys.path[0]):{}'.format(sys.path[0]))
from . import pkgmoda
print('run:{}'.format(os.path.abspath(__file__)))
print('print(pkgmoda):{}'.format(pkgmoda))
print('pkgmoda.index:{}'.format(pkgmoda.index))

本示例在交互模式执行，非文件模式执行。

E***\documents\F盘\ 目录不存在pkgmoda.py文件

相对导入from . import module 从当前包搜索。

# python2.7示例
E:\documents\F盘>d:\Python27\python
Python 2.7.18 (v2.7.18:8d21aa21f2, Apr 20 2020, 13:25:05) [MSC v.1500 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import pkg1.main_moda
run:E:\documents\F盘\pkg1\__init__.py
print(sys.path[0]):
run:E:\documents\F盘\pkg1\pkgmoda.py
print(string):<module 'string' from 'd:\Python27\lib\string.pyc'>
run:E:\documents\F盘\pkg1\main_moda.py
# python2.7 相对导入从当前包搜索
print(pkgmoda):<module 'pkg1.pkgmoda' from 'pkg1\pkgmoda.py'>
pkgmoda.index:E:\documents\F盘\pkg1\pkgmoda.py

# python3.7示例
E:\documents\F盘>d:\python3\python
Python 3.7.8 (tags/v3.7.8:4b47a5b6ba, Jun 28 2020, 07:55:33) [MSC v.1916 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import pkg1.main_moda
run:E:\documents\F盘\pkg1\__init__.py
print(sys.path[0]):
run:E:\documents\F盘\pkg1\pkgmoda.py
print(string):<module 'string' from 'd:\\python3\\lib\\string.py'>
run:E:\documents\F盘\pkg1\main_moda.py
# python3.7 相对导入从当前包搜索
print(pkgmoda):<module 'pkg1.pkgmoda' from 'E:\\documents\\F盘\\pkg1\\pkgmoda.py'>
pkgmoda.index:E:\documents\F盘\pkg1\pkgmoda.py

相对导入只搜索当前包路径，不搜索sys.path路径。

将pkg1\pkgmoda.py剪切到“E***\documents\F盘”

# python2.7示例

E:\documents\F盘>d:\Python27\python
Python 2.7.18 (v2.7.18:8d21aa21f2, Apr 20 2020, 13:25:05) [MSC v.1500 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import pkg1.main_moda
run:E:\documents\F盘\pkg1\__init__.py
print(sys.path[0]):
# 只搜索包当前路径，不搜索sys.path路径
Traceback (most recent call last):
  File "", line 1, in <module>
  File "pkg1\main_moda.py", line 5, in <module>
    from . import pkgmoda
ImportError: cannot import name pkgmoda
# python3.7示例

E:\documents\F盘>d:\python3\python
Python 3.7.8 (tags/v3.7.8:4b47a5b6ba, Jun 28 2020, 07:55:33) [MSC v.1916 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import pkg1.main_moda
run:E:\documents\F盘\pkg1\__init__.py
print(sys.path[0]):
# 只搜索包当前路径，不搜索sys.path路径
Traceback (most recent call last):
  File "", line 1, in <module>
  File "E:\documents\F盘\pkg1\main_moda.py", line 5, in <module>
    from . import pkgmoda
ImportError: cannot import name 'pkgmoda' from 'pkg1' (E:\documents\F盘\pkg1\__init__.py)