Python3导入自定义模块的三种方法详解


Posted in Python onApril 13, 2018

前话

最近跟着廖雪峰的教程学到 模块 这一节。关于如何自定义一个模块,如果大家不懂的话先来看看基本的介绍:

模块

在计算机程序的开发过程中,随着程序代码越写越多,在一个文件里代码就会越来越长,越来越不容易维护。

为了编写可维护的代码,我们把很多函数分组,分别放到不同的文件里,这样,每个文件包含的代码就相对较少,很多编程语言都采用这种组织代码的方式。在Python中,一个.py文件就称之为一个模块(Module)。

使用模块有什么好处?

最大的好处是大大提高了代码的可维护性。其次,编写代码不必从零开始。当一个模块编写完毕,就可以被其他地方引用。我们在编写程序的时候,也经常引用其他模块,包括Python内置的模块和来自第三方的模块。

使用模块还可以避免函数名和变量名冲突。相同名字的函数和变量完全可以分别存在不同的模块中,因此,我们自己在编写模块时,不必考虑名字会与其他模块冲突。但是也要注意,尽量不要与内置函数名字冲突。点这里查看Python的所有内置函数。

你也许还想到,如果不同的人编写的模块名相同怎么办?为了避免模块名冲突,Python又引入了按目录来组织模块的方法,称为包(Package)。

举个例子,一个abc.py的文件就是一个名字叫abc的模块,一个xyz.py的文件就是一个名字叫xyz的模块。

现在,假设我们的abc和xyz这两个模块名字与其他模块冲突了,于是我们可以通过包来组织模块,避免冲突。方法是选择一个顶层包名,比如mycompany,按照如下目录存放:

mycompany
├─ __init__.py
├─ abc.py
└─ xyz.py

引入了包以后,只要顶层的包名不与别人冲突,那所有模块都不会与别人冲突。现在,abc.py模块的名字就变成了mycompany.abc,类似的,xyz.py的模块名变成了mycompany.xyz。

请注意,每一个包目录下面都会有一个__init__.py的文件,这个文件是必须存在的,否则,Python就把这个目录当成普通目录,而不是一个包。__init__.py可以是空文件,也可以有Python代码,因为__init__.py本身就是一个模块,而它的模块名就是mycompany。

类似的,可以有多级目录,组成多级层次的包结构。比如如下的目录结构:

mycompany
 ├─ web
 │  ├─ __init__.py
 │  ├─ utils.py
 │  └─ www.py
 ├─ __init__.py
 ├─ abc.py
 └─ xyz.py

文件www.py的模块名就是mycompany.web.www,两个文件utils.py的模块名分别是mycompany.utils和mycompany.web.utils。

自己创建模块时要注意命名,不能和Python自带的模块名称冲突。例如,系统自带了sys模块,自己的模块就不可命名为sys.py,否则将无法导入系统自带的sys模块。

mycompany.web也是一个模块,请指出该模块对应的.py文件。

小结

模块是一组Python代码的集合,可以使用其他模块,也可以被其他模块使用。

创建自己的模块时,要注意:

  • 模块名要遵循Python变量命名规范,不要使用中文、特殊字符;
  • 模块名不要和系统模块名冲突,最好先查看系统是否已存在该模块,检查方法是在Python交互环境执行import abc,若成功则说明系统存在此模块。

模块是个好东西啊,大牛们开源共享许多模块也加快了大家开发的速度,许多开源模块可以在这里找到 ↓

https://pypi.python.org/pypi

因为刚入门所有有很多细节不懂,在网上搜寻资料的时候发现各位大神们的教程实在太过于精简,让我这个菜鸟很辛苦的才操作成功。

因此在这里记录下来。

开始

第一种,直接 import

这里有个大前提,就是你的py执行文件和模块同属于同个目录(父级目录),如下图:

Python3导入自定义模块的三种方法详解

  • main.py 和 pwcong模块同在python目录
  • 执行文件为main.py
  • pwcong文件夹为一个模块

我把pwcong模块提供的函数写在 __init__.py 里,里面只提供一个 hi 函数:

# pwcong 模块的 __init__.py
# -*- coding: utf-8 -*-
def hi():
 print("hi")

执行文件main.py直接import模块:

# main.py
# -*- coding: utf-8 -*-
import pwcong
pwcong.hi()

接着我们运行一下main.py可以看到命令行窗口输出了一句 hi ,第一种方式完成。

使用模块方式为:先导入-》接着输入模块.变量|函数, 如上面例子的 pwcong.hi()

第二种,通过sys模块导入自定义模块的path

如果执行文件和模块不在同一目录,这时候直接import是找不到自定义模块的。如下图:

Python3导入自定义模块的三种方法详解

  • 执行文件main.py在main目录下
  • pwcong模块在python目录下

sys模块是python内置的,因此我们导入自定义模块的步骤如下:

  1. 先导入sys模块
  2. 然后通过sys.path.append(path) 函数来导入自定义模块所在的目录
  3. 导入自定义模块。

这时候 main.py 这样写:

# main.py
# -*- coding: utf-8 -*-
import sys
sys.path.append(r"C:\Users\Pwcong\Desktop\python")
import pwcong
pwcong.hi()

最后执行main.py文件,最终输出 hi ,第二种方式完成。

第三种,通过pth文件找到自定义模块

这个方法原理就是利用了系统变量,python会扫描path变量的路径来导入模块,可以在系统path里面添加。但是我还是推荐使用pth文件添加。

模块和执行文件目录结构跟上图一样:

Python3导入自定义模块的三种方法详解

  • 执行文件main.py在main目录下
  • pwcong模块在python目录下

我们创建一个 module_pwcong.pth 文件,里面内容就是 pwcong模块所在的目录:

C:\Users\Pwcong\Desktop\python

将该 module_pwcong.pth 文件放到这里:

python安装目录\Python35\Lib\site-packages

例如我的:

Python3导入自定义模块的三种方法详解

然后 main.py 导入并使用自定义模块:

# -*- coding: utf-8 -*-
import pwcong
pwcong.hi()

最后执行 main.py 文件,可以输出 hi ,第三种方式完成。

结束

到这里三种导入自定义模块的方式栗子就完成了,我写的应该很详细了吧 :)

好了,以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对三水点靠木的支持。

Python 相关文章推荐
python fabric使用笔记
May 09 Python
pymssql数据库操作MSSQL2005实例分析
May 25 Python
python利用dir函数查看类中所有成员函数示例代码
Sep 08 Python
利用python实现简单的邮件发送客户端示例
Dec 23 Python
Python列表推导式与生成器表达式用法示例
Feb 08 Python
用python写扫雷游戏实例代码分享
May 27 Python
Python读取csv文件分隔符设置方法
Jan 14 Python
python for 循环获取index索引的方法
Feb 01 Python
Python+numpy实现矩阵的行列扩展方式
Nov 29 Python
tensorflow的ckpt及pb模型持久化方式及转化详解
Feb 12 Python
Anaconda3+tensorflow2.0.0+PyCharm安装与环境搭建(图文)
Feb 18 Python
python小程序之飘落的银杏
Apr 17 Python
pandas数据预处理之dataframe的groupby操作方法
Apr 13 #Python
DataFrame 将某列数据转为数组的方法
Apr 13 #Python
Python中将dataframe转换为字典的实例
Apr 13 #Python
Python 实现使用dict 创建二维数据、DataFrame
Apr 13 #Python
每天迁移MySQL历史数据到历史库Python脚本
Apr 13 #Python
python实现数据库跨服务器迁移
Apr 12 #Python
解决python3爬虫无法显示中文的问题
Apr 12 #Python
You might like
php class中self,parent,this的区别以及实例介绍
2013/04/24 PHP
Yii数据库缓存实例分析
2016/03/29 PHP
PHP+Ajax异步带进度条上传文件实例
2016/11/01 PHP
VBScript版代码高亮
2006/06/26 Javascript
jQuery 核心函数以及jQuery对象
2010/03/23 Javascript
javascript判断用户浏览器插件安装情况的代码
2011/01/01 Javascript
javascript 内存回收机制理解
2011/01/17 Javascript
JavaScript定时器和优化的取消定时器方法
2015/07/03 Javascript
JS绘制生成花瓣效果的方法
2015/08/05 Javascript
jQuery中clone()函数实现表单中增加和减少输入项
2017/05/13 jQuery
再谈Angular4 脏值检测(性能优化)
2018/04/23 Javascript
微信小程序实现折线图的示例代码
2019/06/07 Javascript
微信小程序3种位置API的使用方法详解
2019/08/05 Javascript
解决layui 三级联动下拉框更新时回显的问题
2019/09/03 Javascript
Vue学习之axios的使用方法实例分析
2020/01/06 Javascript
在Python的setuptools框架下生成egg的教程
2015/04/13 Python
Python提取Linux内核源代码的目录结构实现方法
2016/06/24 Python
Python实现OpenCV的安装与使用示例
2018/03/30 Python
Python实现爬虫从网络上下载文档的实例代码
2018/06/13 Python
Python  unittest单元测试框架的使用
2018/09/08 Python
关于python pycharm中输出的内容不全的解决办法
2020/01/10 Python
Python系统公网私网流量监控实现流程
2020/11/23 Python
Python爬虫开发与项目实战
2020/12/16 Python
python中if嵌套命令实例讲解
2021/02/25 Python
介绍一下HDLC(High-Level Data Link Control)高层数据链路协议
2012/01/21 面试题
2014年学校党建工作汇报材料
2014/11/02 职场文书
2015年党员公开承诺书范文
2015/01/22 职场文书
前台岗位职责范本
2015/04/16 职场文书
护士工作心得体会
2016/01/25 职场文书
工作转正自我鉴定范文
2019/06/21 职场文书
七年级作文(600字3篇)
2019/09/24 职场文书
互联网创业商业模式以及赚钱法则有哪些?
2019/10/12 职场文书
php远程请求CURL案例(爬虫、保存登录状态)
2021/04/01 PHP
Python序列化与反序列化相关知识总结
2021/06/08 Python
mysql分表之后如何平滑上线详解
2021/11/01 MySQL
MongoDB支持的索引类型
2022/04/11 MongoDB