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 相关文章推荐
详解Django框架中的视图级缓存
Jul 23 Python
Python使用Mechanize模块编写爬虫的要点解析
Mar 31 Python
Windows下Python2与Python3两个版本共存的方法详解
Feb 12 Python
Flask和Django框架中自定义模型类的表名、父类相关问题分析
Jul 19 Python
解决PyCharm同目录下导入模块会报错的问题
Oct 13 Python
Django的用户模块与权限系统的示例代码
Jul 24 Python
Python测试线程应用程序过程解析
Dec 31 Python
Numpy 多维数据数组的实现
Jun 18 Python
浅谈pytorch中torch.max和F.softmax函数的维度解释
Jun 28 Python
Python自动化之UnitTest框架实战记录
Sep 08 Python
python爬虫使用scrapy注意事项
Nov 23 Python
如何使用Python提取Chrome浏览器保存的密码
Jun 09 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
thinkphp控制器调度使用示例
2014/02/24 PHP
yii,CI,yaf框架+smarty模板使用方法
2015/12/29 PHP
PHP 数组黑名单/白名单实例代码详解
2019/06/04 PHP
基于ThinkPHP删除目录及目录文件函数
2020/10/28 PHP
服务器端的JavaScript脚本 Node.js 使用入门
2012/03/07 Javascript
利用js 进行输入框自动匹配字符的小例子
2013/06/29 Javascript
jQuery ajax dataType值为text json探索分享
2013/09/23 Javascript
使用Bootstrap框架制作查询页面的界面实例代码
2016/05/27 Javascript
JS添加删除DIV的简单实例
2016/07/08 Javascript
Bootstrap table表格简单操作
2017/02/07 Javascript
利用jQuery实现简单的拖曳效果实例代码
2017/10/20 jQuery
JavaScript中this关键字用法实例分析
2018/08/24 Javascript
新年快乐! javascript实现超级炫酷的3D烟花特效
2019/01/30 Javascript
详解基于Wepy开发小程序插件(推荐)
2019/08/01 Javascript
vue实现网络图片瀑布流 + 下拉刷新 + 上拉加载更多(步骤详解)
2020/01/14 Javascript
vue中v-for循环选中点击的元素并对该元素添加样式操作
2020/07/17 Javascript
理解Proxy及使用Proxy实现vue数据双向绑定操作
2020/07/18 Javascript
JavaScript canvas实现雨滴特效
2021/01/10 Javascript
[01:59]翻天覆地,因你而变,7.20版本地图更新速览
2018/11/24 DOTA
python网络编程之TCP通信实例和socketserver框架使用例子
2014/04/25 Python
python实现通过pil模块对图片格式进行转换的方法
2015/03/24 Python
用实例分析Python中method的参数传递过程
2015/04/02 Python
Python使用logging结合decorator模式实现优化日志输出的方法
2016/04/16 Python
详解python解压压缩包的五种方法
2019/07/05 Python
Python日志无延迟实时写入的示例
2019/07/11 Python
Python:type、object、class与内置类型实例
2019/12/25 Python
jupyter notebook实现显示行号
2020/04/13 Python
在CentOS7下安装Python3教程解析
2020/07/09 Python
python 利用toapi库自动生成api
2020/10/19 Python
CSS3中currentColor关键字的妙用
2016/02/27 HTML / CSS
MCM英国官网:奢侈皮具制品
2017/04/18 全球购物
Origins悦木之源香港官网:雅诗兰黛集团高端植物护肤品牌
2018/03/21 全球购物
建龙钢铁面试总结
2014/04/15 面试题
社会学专业求职信
2014/07/17 职场文书
涨价通知怎么写
2015/04/23 职场文书
2015年基层党支部工作总结
2015/05/21 职场文书