美文网首页Python
Python的import vs from ... import

Python的import vs from ... import

作者: SnailTyan | 来源:发表于2020-06-19 17:33 被阅读0次

    文章作者: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

    相关文章

      网友评论

        本文标题:Python的import vs from ... import

        本文链接:https://www.haomeiwen.com/subject/qlivxktx.html