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中的wxPython实现最基本的浏览器功能
Apr 14 Python
python计算方程式根的方法
May 07 Python
详解Python中的元组与逻辑运算符
Oct 13 Python
Python制作词云的方法
Jan 03 Python
浅谈配置OpenCV3 + Python3的简易方法(macOS)
Apr 02 Python
python 运用Django 开发后台接口的实例
Dec 11 Python
Python3爬虫学习之MySQL数据库存储爬取的信息详解
Dec 12 Python
Python实现合并excel表格的方法分析
Apr 13 Python
python使用BeautifulSoup与正则表达式爬取时光网不同地区top100电影并对比
Apr 15 Python
python getpass实现密文实例详解
Sep 24 Python
Tensorflow卷积实现原理+手写python代码实现卷积教程
May 22 Python
详解selenium + chromedriver 被反爬的解决方法
Oct 28 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和ACCESS写聊天室(一)
2006/10/09 PHP
php中的观察者模式
2010/03/24 PHP
基于php无限分类的深入理解
2013/06/02 PHP
PHP变量内存分配问题记录整理
2013/11/27 PHP
深入解析PHP中foreach语句控制数组循环的用法
2015/11/30 PHP
zend framework中使用memcache的方法
2016/03/04 PHP
thinkPHP3.2简单实现文件上传的方法
2016/05/16 PHP
基于php伪静态的实现方法解析
2020/07/31 PHP
极酷的javascirpt,让你随意编辑任何网页
2007/02/25 Javascript
jQuery获取和设置表单元素的方法
2014/02/14 Javascript
js 判断控件获得焦点的示例代码
2014/03/04 Javascript
一个JavaScript获取元素当前高度的实例
2014/10/29 Javascript
JavaScript数组随机排列实现随机洗牌功能
2015/03/19 Javascript
jQuery删除当前节点元素
2016/12/07 Javascript
Node.js连接MongoDB数据库产生的问题
2017/02/08 Javascript
jQuery 实现图片的依次加载图片功能
2017/07/06 jQuery
Vue中计算属性computed的示例解读
2017/07/26 Javascript
JavaScript实现移动端页面按手机屏幕分辨率自动缩放的最强代码
2017/08/18 Javascript
基于canvas粒子系统的构建详解
2017/08/31 Javascript
基于node.js的fs核心模块读写文件操作(实例讲解)
2017/09/10 Javascript
详细分析JavaScript中的深浅拷贝
2020/09/17 Javascript
python中使用enumerate函数遍历元素实例
2014/06/16 Python
Python基于time模块求程序运行时间的方法
2017/09/18 Python
python批量修改图片大小的方法
2018/07/24 Python
使用python采集脚本之家电子书资源并自动下载到本地的实例脚本
2018/10/23 Python
python 实现数字字符串左侧补零的方法
2018/12/04 Python
python 多线程对post请求服务器测试并发的方法
2019/06/13 Python
对Python函数设计规范详解
2019/07/19 Python
python列表推导式操作解析
2019/11/26 Python
python实现FTP循环上传文件
2020/03/20 Python
海淘零差价,宝贝全球购: 宝贝格子
2016/08/24 全球购物
牵手50新加坡:专为黄金岁月的单身人士而设的交友网站
2020/08/16 全球购物
2016年全国助残日活动总结
2016/04/01 职场文书
看完这篇文章获得一些java if优化技巧
2021/07/15 Java/Android
JavaWeb 入门篇:创建Web项目,Idea配置tomcat
2021/07/16 Java/Android
Golang jwt身份认证
2022/04/20 Golang