python历险记之模块导入

最近在学习用 python3 写测试用例,在导入包和模块中踩到了坑。在网上找资料,发现不太全面,有些还有错漏。于是决定自己总结,希望也能给遇到问题的小伙伴们带来帮助。 注:使用python版本为3.7。

在任何语言中,依赖管理都是最基础的。在 python 中也不例外。这里我们要从模块和包说起。

模块和包

  • 模块 .py 为后缀的文件视为一个模块。模块可以在其他 python 文件中被导入和使用。
  • 包 包含多个模块的文件夹,导入该包即导入该包内的模块。必须有 init.py文件。
    • init.py 文件:导入某个包时,会首先执行init.py 文件,因此可以在里面先行导入需要用到的模块或者模块内的定义、方法。

python 如何找到导入的模块

python会按顺序来查找导入的模块:从sys.modules 查找 -> 查找器查找。

  • sys.modules:缓存了之前导入的所有模块。
  • 查找器:默认有3个,按照内置模块(python官方模块等)-> 冻结模块-> import path(来自 sys.path,包括当前模块所在目录,以及自行加入的目录等)的路径查找。

如何导入模块

  • 导入语法
    • import xxx:直接导入,xxx 为包/模块。
    • from xxx import yyy:从 xxx 中导入 yyy。xxx 为包/模块,yyy 可以为子包、模块、模块内的内容(类、方法)等。这种方式结合init.py,可以让包和模块导入更简单,便于管理。
  • 导入方式
    • 相对路径 使用 . 或者 .. 的方式来包含指定导入模块。. 代表当前包所在目录,.. 为上级目录。只能使用 from xxx import xxx 的方式导入。因为 .moduleY 不是一个有效表达式。
    • 绝对路径 使用 xxx.yyy.zzz 导入。以当前包目录为顶层目录。

推荐 :020 持续更新,精品小圈子每日都有新内容,干货浓度极高。
结实人脉、讨论技术 你想要的这里都有!
抢先入群,跑赢同龄人!(入群无需任何费用)
点击此处,与Python开发大牛一起交流学习。
群号:745895701
申请即送:
Python软件安装包,Python实战教程
资料免费领取,包括 Python基础学习、进阶学习、爬虫、人工智能、自动化运维、自动化测试等

实例说明

  • 项目结构 my_project 为项目文件夹,下图为 my_project 的结构:
  • my_project:包含 module_one 模块,package_a、package_b 子包。
  • package_a:包含 a_module_one、a_module_two 模块,a_inner_package 子包。
  • package_b:包含 b_module_one 模块。

每个模块中都会有一个方法,打印 “i am xxx_method”,来明确显示我们的模块导入和调用是成功的。

使用 import xxx 方式

  • 示例一 在 a_module_one.py 中引入上级、同级、下级包中模块。
# my_project/package_a/a_module_one.py 

import sys

sys.path.append("..")
import module_one # 引入上级包中的模块
import a_module_two # 引入同级包中的模块
import a_inner_package.a_inner_module # 引入下级包中的模块

module_one.module_one_method() # 结果:i am module_one_method
a_module_two.a_module_two_method() # 结果:i am a_module_two_method
a_inner_package.a_inner_module.a_inner_package_method() # 结果:i am a_inner_package_method

注意,引入上级包中模块需要将 .. 加入 sys.path 中,否则会找不到,因为python仅会从当前包的目录开始查找。

使用 from xxx import yyy 方式

  • 示例二:在包的init.py 中 import 进需要的包内含有的子包和模块
# my_project/package_a/__init__.py

from .a_module_two import a_module_two_method # 导入当前包的模块的方法
from package_a.a_inner_package import a_inner_module # 导入子包中的模块
  • 示例三:在模块中引用包,使用其模块和方法
# my_project/module_one.py
# 引入 my_project/package_a 包
from package_a import a_inner_module
from package_a import a_module_two_method

a_module_two_method() # 结果:i am a_module_two_method
a_inner_module.a_inner_package_method() # 结果:i am a_inner_package_method

总结和注意事项

  • 推荐使用包对模块进行管理。
  • 推荐使用 from xxx imoprt yyy 的方式来引入。结合init.py文件,引入包时,可以控制引入粒度,不需要引入无用的子包和模块。
  • from xxx import yyy 方式说明 若在包 package_a 的 init.py 文件中引入了其下具体的类、函数,则在引用 pakcage_a 的包中可以直接引用;若没有,则 xxx 的粒度为包,yyy 必须为子包或直接模块。即yyy必须是能在下能直接找到的。例如:from package_a imoprt a_module_method 是错误的。(可参考示例三)

踩坑记录

  • 坑一
    • 现象:执行 my_project/package_a/init.py 文件(文件内容参考示例二)报错: ModuleNotFoundError: No module named 'main.a_module_two'; 'main' is not a package
    • 原因:当前模块为 init.py。在当前模块执行时,.代表的是name变量;在被其他模块导入和执行时,. 表示原模块的文件名。因此在用 . 相对路径引入的时候,直接执行会报错。
  • 坑二
    • 引用上级包中的模块,例如:from .. import module_xx。报错:ValueError: attempted relative import beyond top-level package
    • 原因:当前所在包目录为顶层目录,python 会从该目录开始查找被引入的包和模块,因此它无法识别当前层级以上的包和模块。需要引入,要用sys.path.append加入路径。

参考文档

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容