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之for循环语句
Oct 02 Python
详解Python中DOM方法的动态性
Apr 11 Python
python实现ID3决策树算法
Dec 20 Python
分数霸榜! python助你微信跳一跳拿高分
Jan 08 Python
详解python多线程之间的同步(一)
Apr 03 Python
Python assert语句的简单使用示例
Jul 28 Python
python web框架Flask实现图形验证码及验证码的动态刷新实例
Oct 14 Python
Python字典常见操作实例小结【定义、添加、删除、遍历】
Oct 25 Python
Python3 hashlib密码散列算法原理详解
Mar 30 Python
Django URL参数Template反向解析
Nov 24 Python
python解压zip包中文乱码解决方法
Nov 27 Python
python Pexpect模块的使用
Dec 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
C# Assembly类访问程序集信息
2009/06/13 PHP
php setcookie(name, value, expires, path, domain, secure) 参数详解
2013/06/28 PHP
php smarty模板引擎的6个小技巧
2014/04/24 PHP
php中$美元符号与Zen Coding冲突问题解决方法分享
2014/05/28 PHP
完美解决thinkphp验证码出错无法显示的方法
2014/12/09 PHP
实现PHP+Mysql无限分类的方法汇总
2015/03/02 PHP
php封装的表单验证类完整实例
2016/10/19 PHP
Javascript 获取LI里的内容
2008/12/17 Javascript
js过滤HTML标签以及空格的思路及代码
2013/05/24 Javascript
jQuery之折叠面板的深入解析
2013/06/19 Javascript
JS获取鼠标坐标的实例方法
2013/07/18 Javascript
通过js简单实现将一个文本内容转译成加密文本
2013/10/22 Javascript
js单词形式的运算符
2014/05/06 Javascript
jQuery事件用法实例汇总
2014/08/29 Javascript
使用JavaScript 编写简单计算器
2014/11/24 Javascript
jQuery实现DIV层淡入淡出拖动特效的方法
2015/02/13 Javascript
js实现具有高亮显示效果的多级菜单代码
2015/09/01 Javascript
Node.js 条形码识别程序构建思路详解
2016/02/14 Javascript
AngularJS基础 ng-cut 指令介绍及简单示例
2016/08/01 Javascript
JavaScript取得gridview中获取checkbox选中的值
2017/07/24 Javascript
Angular.js通过自定义指令directive实现滑块滑动效果
2017/10/13 Javascript
nodejs之koa2请求示例(GET,POST)
2018/08/07 NodeJs
js使用ajax传值给后台,后台返回字符串处理方法
2018/08/08 Javascript
原生js检测页面加载完毕的实例
2018/09/11 Javascript
JavaScript 2018 中即将迎来的新功能
2018/09/21 Javascript
简单了解微信小程序 e.target与e.currentTarget的不同
2019/09/27 Javascript
JS通用方法触发点击事件代码实例
2020/02/17 Javascript
python os.path.isfile 的使用误区详解
2019/11/29 Python
sklearn的predict_proba使用说明
2020/06/28 Python
人民教师的自我评价分享
2014/02/21 职场文书
售前工程师职业生涯规划
2014/03/02 职场文书
道德大讲堂实施方案
2014/05/14 职场文书
环境保护标语
2014/06/20 职场文书
收银员岗位职责范本
2015/04/07 职场文书
放假通知范文
2015/04/14 职场文书
周恩来的四个昼夜观后感
2015/06/03 职场文书