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对小数进行除法运算的正确方法示例
Aug 25 Python
解读Python中degrees()方法的使用
May 18 Python
Python多进程机制实例详解
Jul 02 Python
Python使用gensim计算文档相似性
Apr 10 Python
python下读取公私钥做加解密实例详解
Mar 29 Python
浅谈python正则的常用方法 覆盖范围70%以上
Mar 14 Python
python调用OpenCV实现人脸识别功能
May 25 Python
Python PyAutoGUI模块控制鼠标和键盘实现自动化任务详解
Sep 04 Python
python的列表List求均值和中位数实例
Mar 03 Python
Python greenlet和gevent使用代码示例解析
Apr 01 Python
python中yield的用法详解
Jan 13 Python
Python实现滑雪小游戏
Sep 25 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实现zip文件解压操作
2015/11/03 PHP
修复ShopNC使用QQ 互联时提示100010 错误
2015/11/08 PHP
PHP实现的Redis多库选择功能单例类
2017/07/27 PHP
PHP7引入的&quot;??&quot;和&quot;?:&quot;的区别讲解
2019/04/08 PHP
PHP创建对象的六种方式实例总结
2019/06/27 PHP
仿服务器端脚本方式的JS模板实现方法
2007/04/27 Javascript
JavaScript 字符串乘法
2009/08/20 Javascript
一段批量给页面上的控件赋值js
2010/06/19 Javascript
一个js拖拽的效果类和dom-drag.js浅析
2010/07/17 Javascript
CSS鼠标响应事件经过、移动、点击示例介绍
2013/09/04 Javascript
使用jQuery和Bootstrap实现多层、自适应模态窗口
2014/12/22 Javascript
js无法获取到html标签的属性的解决方法
2016/07/26 Javascript
Vue 前端实现登陆拦截及axios 拦截器的使用
2019/07/17 Javascript
JavaScript简易计算器制作
2020/01/17 Javascript
Vue实现点击当前行变色
2020/12/14 Vue.js
ES2020让代码更优美的运算符 (?.) (??)
2021/01/04 Javascript
python getopt 参数处理小示例
2009/06/09 Python
Python入门篇之面向对象
2014/10/20 Python
实例Python处理XML文件的方法
2015/08/31 Python
Python下rrdtool模块的基本使用方法
2015/11/13 Python
python 读写txt文件 json文件的实现方法
2016/10/22 Python
Python中with及contextlib的用法详解
2017/06/08 Python
Python从函数参数类型引出元组实例分析
2019/05/28 Python
win10下opencv-python特定版本手动安装与pip自动安装教程
2020/03/05 Python
PyTorch在Windows环境搭建的方法步骤
2020/05/12 Python
python工具快速为音视频自动生成字幕(使用说明)
2021/01/27 Python
详解如何使用rem或viewport进行移动端适配
2020/08/14 HTML / CSS
基本款天堂:Everlane
2017/05/13 全球购物
Linux中如何用命令创建目录
2016/12/02 面试题
自行车租赁公司创业计划书
2014/01/28 职场文书
关于安全演讲稿
2014/05/09 职场文书
售后服务承诺书怎么写
2014/05/21 职场文书
初中学习计划书范文
2014/09/15 职场文书
庆祝儿童节标语
2014/10/09 职场文书
2015年禁毒工作总结
2015/04/30 职场文书
《夹竹桃》教学反思
2016/02/23 职场文书