Python的import vs from ... import

文章作者:Tyan
博客:noahsnail.com  |  CSDN  |  简书

0. 测试环境

Python 3.6.9

1. 引言

Python代码中,既可以导入模块,也可以导入模块中的对象,导入方式主要分为两种:import <module_name>from <module_name> import <name(s)>。本文主要对二者进行比较。为了之后测试,定义了一个module模块,module.py文件定义如下:

a = [1, 2, 3]
b = 'abc'

class Test():
    def __init__(self):
        self.desc = 'Test'

    def print_desc(self):
        print(self.desc)

2. 两种方式对比

2.1 import <module_name>

Python模块导入的命令之一是import <module_name>,执行了import <module_name>命令之后,Python的运行过程如下:

  1. 首先在sys.modules中查找module_namesys.modules中包含所有之前导入模块的缓存。
  2. 如果在模块缓存中没找到module_name,Python会继续查找内置模块列表,这些是Python预先安装的模块,可以在Python标准库中找到。
  3. 如果还没找到,Python会在sys.path定义的目录列表中查找。这个列表中通常包含当前目录,会首先查找当前目录。
  4. 如果找到了module_name,会将其绑定到局部命名空间中,后面可以使用。如果没找到,则会抛出ModuleNotFoundError

注:导入模块之后,可以通过模块的__file__属性来获取模块所在的目录,其是sys.path中的目录之一。sys.path[0]为空,表示当前目录。示例如下:

>>> import module
>>> module.__file__
'/workspace/heatmap/module.py'
>>> import re
>>> re.__file__
'/usr/lib/python3.6/re.py'
>>> sys.path
['', '/usr/lib/python36.zip', '/usr/lib/python3.6', '/usr/lib/python3.6/lib-dynload', '/usr/local/lib/python3.6/dist-packages', '/usr/local/lib/python3.6/dist-packages/warpctc_pytorch-0.1-py3.6-linux-x86_64.egg', '/usr/lib/python3/dist-packages']
>>> import os
>>> os.getcwd()
'/workspace/heatmap'
>>> import mod
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ModuleNotFoundError: No module named 'mod'

import <module_name>导入模块之后,并不可以直接访问模块中的内容,每个模块都有自己的私有符号表,其是模块中定义的所有对象的全局符号表,模块创建了一个单独的命名空间。执行import <module_name>之后,<module_name>放到了调用者的局部符号表里,但模块中定义的对象仍在模块的私有符号表里。访问模块中定义的对象需要使用.符号。示例如下:

>>> import module
>>> module
<module 'module' from '/workspace/heatmap/module.py'>
>>> a
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'a' is not defined
>>> b
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'b' is not defined
>>> module.a
[1, 2, 3]
>>> module.b
'abc'

import导入模块时,有时候模块的名字非常长,每次访问模块的内容都很不方便,因此可以使用import ... as ...的方式为模块重命名,便于使用,示例代码如下:

>>> import module as mod
>>> module
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'module' is not defined
>>> mod
<module 'module' from '/workspace/heatmap/module.py'>
>>> module.a
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'module' is not defined
>>> mod.a
[1, 2, 3]

2.2 from <module_name> import <name(s)>

from <module_name> import <name(s)>命令可以直接导入模块中的对象,命令执行之后,模块中的对象被引用到调用者的环境中,可以直接对其访问,而不需要添加模块前缀。这是方式的导入会将模块中的对象直接添加到调用者的符合表里,并会覆盖调用者符号表里的同名对象。

>>> a = [1, 2]
>>> a
[1, 2]
>>> from module import a
>>> a
[1, 2, 3]
>>> from module import abc
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: cannot import name 'abc'
>>> from module import b
>>> b
'abc'
>>> module
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'module' is not defined
>>> from module import Test
>>> t = Test()
>>> t.print_desc()
Test

针对导入对象名称较长问题,也可以使用from ... import ... as ...对导入的对象进行重命名,这种方式也可以用来解决导入对象带来的名称冲突。

2.3 from <module_name> import *

from <module_name> import *命令可以无差别导入模块中的大部分对象(下划线开头的部分除外),风险较高且代码阅读不直观,因此这里不对其进行详细介绍,也不推荐这种使用方式。

2.4 dir()

Python内置函数dir()会返回命名空间定义的名称列表,通过dir()函数可以查看导入声明前后局部符号表的变化情况,也可以用来查看模块中定义的对象,示例如下:

>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__']
>>> a = [1, 2]
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'a']
>>> from module import b
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'a', 'b']
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'a', 'b', 'module']
>>> from module import Test as t
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'a', 'b', 'module', 't']
>>> dir(module)
['Test', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', 'a', 'b']
>>> dir(module.Test)
['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'print_desc']

References

  1. https://realpython.com/absolute-vs-relative-python-imports/

  2. https://realpython.com/python-modules-packages/

  3. https://docs.python.org/3/reference/import.html

  4. https://stackoverflow.com/questions/710551/use-import-module-or-from-module-import

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,607评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,239评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,960评论 0 355
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,750评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,764评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,604评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,347评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,253评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,702评论 1 315
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,893评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,015评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,734评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,352评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,934评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,052评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,216评论 3 371
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,969评论 2 355