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 相关文章推荐
windows下wxPython开发环境安装与配置方法
Jun 28 Python
Python的内存泄漏及gc模块的使用分析
Jul 16 Python
Python实现简单截取中文字符串的方法
Jun 15 Python
python实现发送和获取手机短信验证码
Jan 15 Python
Django 开发环境与生产环境的区分详解
Jul 26 Python
使用OpenCV实现仿射变换—缩放功能
Aug 29 Python
在主流系统之上安装Pygame的方法
May 20 Python
opencv 查找连通区域 最大面积实例
Jun 04 Python
Pyinstaller打包Scrapy项目的实现步骤
Sep 22 Python
如何用tempfile库创建python进程中的临时文件
Jan 28 Python
据Python爬虫不靠谱预测可知今年双十一销售额将超过6000亿元
Nov 11 Python
宝塔更新Python及Flask项目的部署
Apr 11 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示例演示发送邮件给某个邮箱
2019/04/03 PHP
javascript 写类方式之八
2009/07/05 Javascript
javascript利用初始化数据装配模版的实现代码
2010/11/17 Javascript
利用JS自动打开页面上链接的实现代码
2011/09/25 Javascript
收集json解析的四种方法分享
2014/01/17 Javascript
JavaScript中数组成员的添加、删除介绍
2014/12/30 Javascript
JavaScript 异常处理 详解
2015/02/06 Javascript
js实现input框文字动态变换显示效果
2015/08/19 Javascript
js计算文本框输入的字符数
2015/10/23 Javascript
微信小程序 slider的简单实例
2017/04/19 Javascript
VUE中v-model和v-for指令详解
2017/06/23 Javascript
JS+Ajax实现百度智能搜索框
2017/08/04 Javascript
使用JS实现导航切换时高亮显示的示例讲解
2018/08/22 Javascript
vue 获取视频时长的实例代码
2019/08/20 Javascript
关于JS解构的5种有趣用法
2019/09/05 Javascript
python网页请求urllib2模块简单封装代码
2014/02/07 Python
详解Python中的正则表达式的用法
2015/04/09 Python
在Python中操作列表之list.extend()方法的使用
2015/05/20 Python
详解python使用Nginx和uWSGI来运行Python应用
2018/01/09 Python
更改Python的pip install 默认安装依赖路径方法详解
2018/10/27 Python
Django-Rest-Framework 权限管理源码浅析(小结)
2018/11/12 Python
Python实现带参数的用户验证功能装饰器示例
2018/12/14 Python
python实现知乎高颜值图片爬取
2019/08/12 Python
用python3 urllib破解有道翻译反爬虫机制详解
2019/08/14 Python
英国床和浴室商场:Bed & Bath Emporium
2018/05/20 全球购物
DC Shoes荷兰官方网站:美国极限运动品牌
2019/10/22 全球购物
公务员总结性个人自我评价
2013/12/05 职场文书
酒店个人培训自我鉴定
2013/12/11 职场文书
最新大学生创业计划书写作攻略
2014/04/02 职场文书
大学学习计划书范文
2014/05/02 职场文书
2014院党委领导班子对照检查材料思想汇报
2014/09/24 职场文书
办公室主任四风问题对照检查材料思想汇报
2014/09/28 职场文书
考试作弊检讨书
2015/01/27 职场文书
幼儿园小班个人总结
2015/02/12 职场文书
劳动模范获奖感言
2015/07/31 职场文书
宾馆安全管理制度
2015/08/06 职场文书