Python中使用语句导入模块或包的机制研究


Posted in Python onMarch 30, 2015

这篇文章讨论了Python的from <module> import *和from <package> import *,它们怎么执行以及为什么使用这种语法(也许)是一个坏主意。
从一个模块导入全部

from <module> import * means意味着“我希望能访问<module>中我有权限访问的全部名称”。例如以下代码something.py:
 

# something.py
 
public_variable = 42
_private_variable = 141
 
def public_function():
  print("I'm a public function! yay!")
 
def _private_function():
  print("Ain't nobody accessing me from another module...usually")
 
class PublicClass(object):
  pass
 
class _WeirdClass(object):
  pass

在Python解释器中,我们可以执行from something import *,然后看到如下的内容:
 

>>> from something import *
>>> public_variable
42
>>> _private_variable
...
NameError: name '_private_variable' is not defined
>>> public_function()
"I'm a public function! yay!"
>>> _private_function()
...
NameError: name '_private_function' is not defined
>>> c = PublicClass()
>>> c
<something.PublicClass object at ...>
>>> c = _WeirdClass()
...
NameError: name '_WeirdClass' is not defined

from something import *从something中导入了除了以_开头名称外的其他所有名称,按照规范,_开始的名称是私有的所以未被导入。
嗯,不是特别糟!还有什么?

上面没提到__all__是什么。__all__是一个字符串列表,指定了当from <module> import *被使用时,模块(或者如后文会提到的包)中的哪些符号会被导出。如果我们不定义__all__(我们在上面的something.py就没定义),import *默认的导入方式是导入除了下划线(_)开头的所有名称。再说一次,编程惯例上下划线表示一个符号是私有的,不导入是合理的。让我们来看看在something.py中定义我们自己的__all__会发生什么。
 

# something.py
 
__all__ = ['_private_variable', 'PublicClass']
 
# The rest is the same as before
 
public_variable = 42
_private_variable = 141
 
def public_function():
  print("I'm a public function! yay!")
 
def _private_function():
  print("Ain't nobody accessing me from another module...usually")
 
class PublicClass(object):
  pass
 
class _WeirdClass(object):
  pass

现在,我们期望from something import *只会导入_private_variable和PublicClass:
 

>>> from something import *
>>> public_variable
42
>>> _private_variable
...
NameError: name '_private_variable' is not defined
>>> public_function()
"I'm a public function! yay!"
>>> _private_function()
...
NameError: name '_private_function' is not defined
>>> c = PublicClass()
>>> c
<something.PublicClass object at ...>
>>> c = _WeirdClass()
...
NameError: name '_WeirdClass' is not defined

包是怎样的呢?

当从一个包中导入全部时,__all__的做法和模块基本一样,不过它处理的是包中的模块(而不是把模块中的名都导入)。所以当我们使用from <package> import *.时__all__说明了所有需要被导入当前命名空间的模块。

不同之处在于,如果你在一个包的__init__.py里面没有声明__all__,from <package> import *语句不会导入任何东西(这个说法也不全对,正确的说法在此)
但是,这有什么不好?

继续读之前,在你的Python解释器中,执行import this,再读一遍Python之禅(在你孩子每晚睡前也要读给他们)。

    明确比含糊要好。

from <module> import * 是不明确的。它没告诉我们我们正在导入什么或者我们把什么带入当前命名空间了。更好的做法是显式地导入我们需要的全部名称。这种方式下,读者(非常可能是未来的你自己)就不会困惑于你代码中使用的一个变量/方法/类/其他东西是哪儿来的,这也告诉了我们下一点:

    可读性很重要

即使你需要导入很多东西,一个一个显式地导入也更清楚。使用PEP 328:
 

from Tkinter import (Tk, Frame, Button, Entry, Canvas, Text,
  LEFT, DISABLED, NORMAL, RIDGE, END)

你现在就能明确知道你的命名空间里有什么,使用ctrl+f能很快地告诉你它们是哪儿来的。

同时,你还总是要承担模块/包作者更改list内容(加/减东西)的风险。也就是下面两者之一:

    作者从__all__里删除了一个字符串。如果你的代码使用了那个名字,你的代码就会报出NameError的错误,并且很难发现为什么。
    作者在__all__里加入了很多东西。你也许不需要这些增加的内容,所以你只是让这些你不关心的东西占满了你的命名空间。他们甚至在你不注意的时候会替代其他同名内容。

当然,有时候从模块或者包中导入全部内容是有用的。不过,这么做之前三思。从我的经验来看,这么做通常只是因为懒。

Python 相关文章推荐
详解Python中的多线程编程
Apr 09 Python
Windows下Python使用Pandas模块操作Excel文件的教程
May 31 Python
使用python绘制常用的图表
Aug 27 Python
Python实现将数据框数据写入mongodb及mysql数据库的方法
Apr 02 Python
django自带的server 让外网主机访问方法
May 14 Python
在cmder下安装ipython以及环境的搭建
Oct 19 Python
Python如何发送与接收大型数组
Aug 07 Python
pycharm 快速解决python代码冲突的问题
Jan 15 Python
pycharm 的Structure界面设置操作
Feb 05 Python
jupyter notebook指定启动目录的方法
Mar 02 Python
python scipy 稀疏矩阵的使用说明
May 26 Python
OpenCV 图像梯度的实现方法
Jul 25 Python
优化Python代码使其加快作用域内的查找
Mar 30 #Python
Python中分数的相关使用教程
Mar 30 #Python
Python2.x中str与unicode相关问题的解决方法
Mar 30 #Python
分享一个常用的Python模拟登陆类
Mar 29 #Python
python实现查询IP地址所在地
Mar 29 #Python
python实现定时播放mp3
Mar 29 #Python
Python实现设置windows桌面壁纸代码分享
Mar 28 #Python
You might like
PHP延迟静态绑定示例分享
2014/06/22 PHP
php采用curl实现伪造IP来源的方法
2014/11/21 PHP
Javascript 设计模式(二) 闭包
2010/05/26 Javascript
js 3种归并操作的实例代码
2013/10/30 Javascript
javascript中字符串的定义示例代码
2013/12/19 Javascript
BootStrap下jQuery自动完成的样式调整
2016/05/30 Javascript
JS弹出新窗口被拦截的解决方法
2016/08/09 Javascript
如何实现json数据可视化详解
2016/11/24 Javascript
javascript实现无法关闭的弹框
2016/11/27 Javascript
vue2.0与bootstrap3实现列表分页效果
2017/11/28 Javascript
Bootstrap实现的表格合并单元格示例
2018/02/06 Javascript
vue-router权限控制(简单方式)
2018/10/29 Javascript
JS实现的贪吃蛇游戏完整实例
2019/01/18 Javascript
Vue在 Nuxt.js 中重定向 404 页面的方法
2019/04/23 Javascript
微信小程序云开发之模拟后台增删改查
2019/05/16 Javascript
Vue的data、computed、watch源码浅谈
2020/04/04 Javascript
详解supervisor使用教程
2017/11/21 Python
django 自定义过滤器的实现
2019/02/26 Python
python中将两组数据放在一起按照某一固定顺序shuffle的实例
2019/07/15 Python
如何基于windows实现python定时爬虫
2020/05/01 Python
Champion官网:美国冠军运动服装
2017/01/25 全球购物
秘鲁购物网站:Linio秘鲁
2017/04/07 全球购物
澳大利亚音乐商店:Bava’s Music City
2019/05/05 全球购物
如何用SQL语句进行模糊查找
2015/09/25 面试题
自我鉴定思想方面
2013/10/07 职场文书
公关活动策划方案
2014/05/25 职场文书
班级标语大全
2014/06/21 职场文书
优秀纪检干部材料
2014/08/27 职场文书
2014乡镇机关党员个人对照检查材料思想汇报
2014/10/09 职场文书
2015年班主任个人工作总结
2015/03/31 职场文书
2016年大学生就业指导课心得体会
2015/10/09 职场文书
商务英语邮件开头问候语
2015/11/10 职场文书
历史名人教你十五个读书方法,赶快Get起来!
2019/07/18 职场文书
导游词之秦始皇兵马俑博物馆
2019/09/29 职场文书
Golang原生rpc(rpc服务端源码解读)
2022/04/07 Golang
css让页脚保持在底部位置的四种方案
2022/07/23 HTML / CSS