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实现拼接多张图片的方法
Dec 01 Python
利用Psyco提升Python运行速度
Dec 24 Python
Python判断Abundant Number的方法
Jun 15 Python
开源Web应用框架Django图文教程
Mar 09 Python
Python 转义字符详细介绍
Mar 21 Python
Python列表元素常见操作简单示例
Oct 25 Python
Python hashlib模块实例使用详解
Dec 24 Python
Python解释器及PyCharm工具安装过程
Feb 26 Python
Python如何在windows环境安装pip及rarfile
Jun 15 Python
Opencv 图片的OCR识别的实战示例
Mar 02 Python
python3使用diagrams绘制架构图的步骤
Apr 08 Python
利用Python将list列表写入文件并读取的方法汇总
Mar 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
一次编写,随处运行
2006/10/09 PHP
php fread读取文件注意事项
2016/09/24 PHP
php 浮点数比较方法详解
2017/05/05 PHP
Yii 2.0自带的验证码使用经验分享
2017/06/19 PHP
laravel框架与其他框架的详细对比
2019/10/23 PHP
学习JavaScript的最佳方法分享
2011/10/21 Javascript
javascript-简单的计算器实现步骤分解(附图)
2013/05/30 Javascript
关闭ie窗口清除Session的解决方法
2014/01/10 Javascript
Js判断CSS文件加载完毕的具体实现
2014/01/17 Javascript
jQuery实现模仿微博下拉滚动条加载数据效果
2015/12/25 Javascript
针对JavaScript中this指向的简单理解
2016/08/26 Javascript
javascript如何创建对象
2016/08/29 Javascript
jquery日历插件e-calendar升级版
2016/11/10 Javascript
jQuery电话号码验证实例
2017/01/05 Javascript
Nodejs实现文件上传的示例代码
2017/09/26 NodeJs
手把手教你用Node.js爬虫爬取网站数据的方法
2018/07/05 Javascript
vue实现打印功能的两种方法
2018/09/07 Javascript
Vuex 单状态库与多模块状态库详解
2018/12/11 Javascript
python求斐波那契数列示例分享
2014/02/14 Python
Python实现合并excel表格的方法分析
2019/04/13 Python
python多线程与多进程及其区别详解
2019/08/08 Python
wxpython绘制圆角窗体
2019/11/18 Python
浅谈pytorch池化maxpool2D注意事项
2020/02/18 Python
python使用梯度下降和牛顿法寻找Rosenbrock函数最小值实例
2020/04/02 Python
Python Pandas 对列/行进行选择,增加,删除操作
2020/05/17 Python
Python可以用来做什么
2020/11/23 Python
canvas小画板之平滑曲线的实现
2020/08/12 HTML / CSS
.net面试题
2015/12/22 面试题
中国梦的演讲稿
2014/01/08 职场文书
和平主题的演讲稿
2014/01/12 职场文书
土木工程专业推荐信
2014/02/19 职场文书
主题党日活动总结
2014/07/08 职场文书
修辞手法有哪些?
2019/08/29 职场文书
详解MySQL中的主键与事务
2021/05/27 MySQL
使用Python拟合函数曲线
2022/04/14 Python
Redis实现主从复制方式(Master&Slave)
2022/06/21 Redis