返回介绍

为什么使用相对导入

发布于 2024-01-29 22:24:15 字数 2531 浏览 0 评论 0 收藏 0

这个功能的设计初衷是,当脚本在同名文件出现在模块搜索路径上许多地方时,可以解决模糊性。考虑如下包的目录。

这定义了一个名为mypkg的包,其中含有名为mypkg.main和mypkg.string的模块。现在,假设模块main试图导入名为string的模块。在Python 2.6和稍早版本中,Python会先寻找mypkg目录以执行相对导入。这会找到并导入位于该处的string.py文件,将其赋值给mypkg.main模块命名空间内的变量名string。

不过,import的原意可能是要导入Python标准库的string模块。可惜的是,在这些Python的版本中,没有办法直接忽略mypkg.string而去寻找位于模块搜索路径更右侧的标准库中的string模块。此外,我们无法使用包导入路径来解决这个问题,因为我们无法依赖在每台机器上都存在标准链接库以上的额外包的目录结构。

换句话说,包中的导入可能是模糊的。在包内,import spam语句是指包内或包外的块,这并不明确。更准确地讲,一个局部的模块或包可能会隐藏sys.path上的另一个模块,无论是有意或无意的。

实际上,Python用户可以避免为他们自己的模块重复使用标准库模块的名称(如果需要标准string,就不要把新的模块命名为string)。但是,这样对包是否会不小心隐藏标准模块没有什么帮助。再者,Python以后可能新增标准库模块,而其名称刚好和自己的一个模块同名。依赖相对导入的程序代码比较不容易理解,因为读者对于期望使用哪个模块,可能会感到困惑。如果程序代码中能明确地进行分辨,就比较好了。

Python 3.0中的相对导入解决方案

要解决这种问题,在包中运行的导入已经在Python 3.0中(并且作为Python 2.6的一个选项)改为绝对的。在这种方式下,在我们的示例文件mypkg/main.py中,一条如下形式的import语句将总是在包之外找到一个string,通过sys.path的绝对导入搜索。

没有前面的点号的一条from语句,也看做是绝对的。

如果你真的想要从包中导入一个模块,而没有给出从包根目录的完整路径,在from语句中使用点语法仍然可能做到相对导入。

这种形式只是相对于当前的包导入string模块,并且是前面的导入示例的绝对形式的相对等价形式,当使用这一特殊的相对语法的时候,包的目录是唯一搜索的目录。

我们也可以使用相对语法从一个模块复制特定的名称。

这条语句再次相对于当前包来引用string模块。如果这段代码出现在我们的mypkg.main模块中,它将从mypkg.string导入name1和name2。

实际上,相对导入中的“.”用来表示包含文件的包目录,而导入就出现在该文件中。前面再增加一个点,将执行从当前包的父目录的相对导入。例如,下面的语句。

将会导入mypkg的一个兄弟,位于该包自己的包含目录中的spam模块,该模块紧挨着mypkg。更通俗地说,位于某个模块A.B.C中的代码可以做下面任何一种导入。

相对导入VS绝对包路径

此外,一个文件有时候也可以在一条绝对导入语句中显式地指定其包。例如,在下面的语句中,将在sys.path的一个绝对路径中找到mypkg。

然而,这依赖于配置以及模块搜索路径设置的顺序,尽管相对导入的点语法不会依赖于此。实际上,这种形式需要直接包含将要包含在模块搜索路径中的mypkg。通常,像这样显式地指定包的时候,绝对导入语句必须列出包的根目录下的所有目录。

在较大或较深的包中,这可能比点语法要做更多的工作。

使用后一种形式,包含的包自动搜索,而不管搜索路径的设置是什么。

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文