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 相关文章推荐
使用wxPython获取系统剪贴板中的数据的教程
May 06 Python
python在线编译器的简单原理及简单实现代码
Feb 02 Python
Django csrf 验证问题的实现
Oct 09 Python
Python写一个基于MD5的文件监听程序
Mar 11 Python
在Django admin中编辑ManyToManyField的实现方法
Aug 09 Python
Python3离线安装Requests模块问题
Oct 13 Python
使用Pandas将inf, nan转化成特定的值
Dec 19 Python
关于TensorFlow新旧版本函数接口变化详解
Feb 10 Python
python时间与Unix时间戳相互转换方法详解
Feb 13 Python
简单了解python列表和元组的区别
May 14 Python
基于selenium及python实现下拉选项定位select
Jul 22 Python
python 调整图片亮度的示例
Dec 03 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
注意:php5.4删除了session_unregister函数
2013/08/05 PHP
实例介绍PHP删除数组中的重复元素
2019/03/03 PHP
php判断IP地址是否在多个IP段内
2020/08/18 PHP
jquery选择器(常用选择器说明)
2010/09/28 Javascript
菜鸟学习JavaScript小实验之函数引用
2010/11/17 Javascript
jQuery设置Cookie及删除Cookie实例分析
2016/04/15 Javascript
jQuery点击输入框显示验证码图片
2016/05/19 Javascript
jQuery实现的checkbox级联选择下拉菜单效果示例
2016/12/26 Javascript
echart简介_动力节点Java学院整理
2017/08/11 Javascript
JavaScript全屏和退出全屏事件总结(附代码)
2017/08/17 Javascript
纯js实现画一棵树的示例
2017/09/05 Javascript
vue语法之拼接字符串的示例代码
2017/10/25 Javascript
layui实现文件或图片上传记录
2018/08/28 Javascript
vue-cli3+typescript初体验小结
2019/02/28 Javascript
使vue实现jQuery调用的两种方法
2019/05/12 jQuery
微信小程序实现签到弹窗动画
2020/09/21 Javascript
跟老齐学Python之用while来循环
2014/10/02 Python
python利用datetime模块计算时间差
2015/08/04 Python
python生成tensorflow输入输出的图像格式的方法
2018/02/12 Python
Python使用Pickle库实现读写序列操作示例
2018/06/15 Python
Python读取xlsx文件的实现方法
2019/07/04 Python
基于python实现模拟数据结构模型
2020/06/12 Python
从python读取sql的实例方法
2020/07/21 Python
常用的10个Python实用小技巧
2020/08/10 Python
python 爬虫爬取京东ps4售卖情况
2020/12/18 Python
H5新属性audio音频和video视频的控制详解(推荐)
2016/12/09 HTML / CSS
HTML5 HTMLCollection和NodeList的区别详解
2020/04/29 HTML / CSS
美国排名第一的泳池用品直接来源:In The Swim
2019/09/23 全球购物
建筑施工员岗位职责
2013/11/26 职场文书
简单英文演讲稿
2014/01/01 职场文书
结婚典礼证婚词
2014/01/08 职场文书
求职简历中自我评价
2014/01/28 职场文书
被告答辩状范文
2015/05/22 职场文书
2015年小学教师培训工作总结
2015/07/21 职场文书
spring boot项目application.properties文件存放及使用介绍
2021/06/30 Java/Android
SQL Server中T-SQL标识符介绍与无排序生成序号的方法
2022/05/25 SQL Server