Python import上级目录详解|极客教程

Python import上级目录详解

介绍

在Python中，import语句用于引入其他模块或包。默认情况下，Python从sys.path中搜索模块，并加载它们。然而，有时候我们可能需要引入上级目录中的模块。本文将详细介绍如何在Python中正确引入上级目录的模块。

问题背景

在Python项目中，我们通常会将相关的模块组织在一个包(package)中。但有时候，我们可能需要在包的外部引用这些模块。考虑以下目录结构：

example/
  |- package/
      |- __init__.py
      |- module.py
  |- script.py

在上面的目录结构中，example是顶级目录，package是一个包，其中包含一个模块module.py。script.py是一个位于顶级目录下的脚本。

现在的问题是，如何在script.py中引入module.py？

解决方案

1. 使用sys.path.append方法

一种解决方案是使用sys.path.append方法将上级目录添加到Python的搜索路径中。然后，我们可以直接使用import语句引入模块。在script.py中，可以这样写：

import sys
sys.path.append("..")

import package.module

在这里，我们首先通过import sys引入了sys模块。然后，使用sys.path.append("..")将上级目录添加到Python的搜索路径中。最后，我们可以使用import package.module导入上级目录中的模块。

这种方法的优点是简单直接，适用于小型的项目。但是，如果项目结构比较复杂，可能需要多级的上级目录引入，这样的写法会显得比较繁琐。

2. 使用绝对导入

还有一种更常用的方法是使用绝对导入。在Python 3中，默认启用了绝对导入，因此我们只需要修改script.py的代码即可：

from package import module

在这里，我们使用from package import module来导入module.py。由于script.py位于顶级目录，因此可以直接使用绝对导入。

需要注意的是，为了在Python 2中使用绝对导入，我们需要在example目录下添加一个__init__.py文件。这样，Python会将example视为一个包，并启用绝对导入。

3. 使用相对导入

如果我们希望在script.py中使用相对导入，可以这样做：

from .package import module

在这里，我们使用from .package import module来实现相对导入。注意，这里的.表示当前目录，因此可以正确引入上级目录中的模块。

需要注意的是，相对导入只能在包内部使用，不适用于顶级脚本。如果我们尝试在顶级脚本中使用相对导入，会导致ImportError。

示例代码

接下来，让我们通过一个示例代码来演示上述三种引入上级目录的方法。

# module.py
def greet(name):
    return f"Hello, {name}!"

# script.py
import sys
sys.path.append("..")

import package.module

print(package.module.greet("Alice"))

from package import module

print(module.greet("Bob"))

from .package import module

print(module.greet("Charlie"))

在这个示例中，module.py定义了一个简单的函数greet，用于输出问候语。script.py通过上述三种方式分别引入了module.py并调用了函数。

运行结果如下：

Hello, Alice!
Hello, Bob!
Traceback (most recent call last):
  File "script.py", line 10, in <module>
    from .package import module
ImportError: attempted relative import with no known parent package

在第三种方式中，没有得到预期的结果，并且抛出了ImportError。这是因为相对导入只能在包内部使用，而script.py是一个顶级脚本，不属于任何包。