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 07 Python
Python编程之基于概率论的分类方法:朴素贝叶斯
Nov 11 Python
python实现百度语音识别api
Apr 10 Python
基于python 处理中文路径的终极解决方法
Apr 12 Python
删除DataFrame中值全为NaN或者包含有NaN的列或行方法
Nov 06 Python
使用python对文件中的单词进行提取的方法示例
Dec 21 Python
对Pyhon实现静态变量全局变量的方法详解
Jan 11 Python
pycharm 将python文件打包为exe格式的方法
Jan 16 Python
三步实现Django Paginator分页的方法
Jun 11 Python
python绘制双Y轴折线图以及单Y轴双变量柱状图的实例
Jul 08 Python
python pymysql链接数据库查询结果转为Dataframe实例
Jun 05 Python
关于tf.matmul() 和tf.multiply() 的区别说明
Jun 18 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
YiiFramework入门知识点总结(图文教程)
2015/12/28 PHP
ThinkPHP框架获取最后一次执行SQL语句及变量调试简单操作示例
2018/06/13 PHP
javascript比较文档位置
2008/04/08 Javascript
国外的为初学者写的JavaScript教程
2008/06/09 Javascript
Extjs TriggerField在弹出窗口显示不出问题的解决方法
2010/01/08 Javascript
JavaScript地图拖动功能SpryMap的简单实现
2013/07/17 Javascript
在myeclipse中如何加入jquery代码提示功能
2014/06/03 Javascript
js中的事件捕捉模型与冒泡模型实例分析
2015/01/10 Javascript
JavaScript实现文本框中默认显示背景图片在获得焦点后消失的方法
2015/07/01 Javascript
js中判断变量类型函数typeof的用法总结
2016/08/09 Javascript
Vue组件开发技巧总结
2018/03/04 Javascript
微信小程序开发之路由切换页面重定向问题
2018/09/18 Javascript
小程序实现投票进度条
2019/11/20 Javascript
jquery使用echarts实现有向图可视化功能示例
2019/11/25 jQuery
node静态服务器实现静态读取文件或文件夹
2019/12/03 Javascript
json解析大全 双引号、键值对不在一起的情况
2019/12/06 Javascript
JS表单验证插件之数据与逻辑分离操作实例分析【策略模式】
2020/05/01 Javascript
JavaScript实现10秒后再次获取验证码
2020/12/02 Javascript
Python中super的用法实例
2015/05/28 Python
python字典基本操作实例分析
2015/07/11 Python
Python中的多行注释文档编写风格汇总
2016/06/16 Python
简单的python协同过滤程序实例代码
2018/01/31 Python
python获取当前目录路径和上级路径的实例
2018/04/26 Python
连接pandas以及数组转pandas的方法
2019/06/28 Python
Python 用三行代码提取PDF表格数据
2019/10/13 Python
python列表返回重复数据的下标
2020/02/10 Python
HTML5 绘制图像(上)之:关于canvas元素引领下一代web页面的问题
2013/04/24 HTML / CSS
iPad和Surface Pro蓝牙键盘:Brydge
2018/11/10 全球购物
医药营销专业个人自荐信
2013/09/29 职场文书
门卫岗位职责
2013/11/15 职场文书
元旦寄语大全
2014/04/10 职场文书
机关驾驶员违规检讨书
2014/09/13 职场文书
个人授权委托书样本
2014/09/13 职场文书
技术股份合作协议书
2014/10/05 职场文书
国庆横幅标语
2014/10/08 职场文书
如何使用pdb进行Python调试
2021/06/30 Python