Python 引用其他文件夹的 `.py` 文件

1. 引言

在实际的项目开发中，我们经常会遇到需要引用其他文件夹中的 .py 文件的情况，这对于模块化的代码管理和提高代码重用性非常重要。本文将详细介绍在 Python 中如何引用其他文件夹中的 .py 文件，并分享一些实用的代码示例。

2. 相对路径和绝对路径

在开始介绍如何引用其他文件夹中的 .py 文件之前，我们需要了解两个概念：相对路径和绝对路径。

2.1 相对路径

相对路径是相对于当前脚本文件所在目录的路径。常用的相对路径标识方式有：

例如，如果当前脚本文件所在目录为 /home/user/project/，要引用该目录下的 utils.py 文件，可以使用相对路径 ./utils.py。

2.2 绝对路径

绝对路径是文件或文件夹在文件系统中的完整路径。绝对路径从根目录开始，一直到要引用的文件位置。Windows 和 Linux/MacOS 使用的绝对路径表示方式略有不同。例如：

Windows 绝对路径：C:\Users\user\project\utils.py。
Linux/MacOS 绝对路径：/home/user/project/utils.py。

在实际项目中，建议使用相对路径，因为它更灵活且可移植性更高。

3. 引用其他文件夹的 `.py` 文件

有多种方法可以引用其他文件夹中的 .py 文件，下面将详细介绍三种常用的方法。

3.1 方法一：使用 sys.path.append

sys.path 是一个 Python 内置的模块，它是一个列表，Python 解释器会按照列表中的路径顺序查找并导入模块。我们可以使用 sys.path.append() 方法将其他文件夹的路径添加到 sys.path 中，从而实现引用其他文件夹的 .py 文件。

下面是一个示例：

# main.py

import sys
sys.path.append('/home/user/project/utils')

import utils

print(utils.add(1, 2))  # 输出 3

# utils.py

def add(a, b):
    return a + b

在这个示例中，我们将 /home/user/project/utils 文件夹添加到了 sys.path 中，然后就可以在 main.py 文件中引用 utils 模块并调用其中的函数。

3.2 方法二：使用相对路径

在方法一中，我们使用了绝对路径来引用其他文件夹中的 .py 文件。但实际上，我们也可以使用相对路径来达到同样的目的。

下面是一个示例：

# main.py

from .utils import add

print(add(1, 2))  # 输出 3

# utils.py

def add(a, b):
    return a + b

在这个示例中，main.py 文件和 utils.py 文件位于同一级目录下。我们使用相对路径 from .utils import add 来引用 utils.py 文件中的 add 函数。这样，我们就不需要使用 sys.path 或绝对路径来引用其他文件夹中的 .py 文件了。

注意，相对路径的使用需要符合 Python 包结构的要求，即每个文件夹需要添加一个 __init__.py 文件来作为包的标识。

3.3 方法三：修改 PYTHONPATH 环境变量

PYTHONPATH 是一个用于指定 Python 模块搜索路径的环境变量。我们可以通过修改 PYTHONPATH 环境变量来实现引用其他文件夹中的 .py 文件。

在 Linux/MacOS 中，可以使用以下命令修改 PYTHONPATH 环境变量：

export PYTHONPATH=/home/user/project/utils:$PYTHONPATH

在 Windows 中，可以通过以下方式修改 PYTHONPATH 环境变量：
1. 打开“系统属性”对话框。
2. 点击“高级系统设置”。
3. 在“系统属性”对话框中，点击“环境变量”按钮。
4. 在“环境变量”对话框中，找到 PYTHONPATH 变量，并将需要引用的文件夹路径添加到 PYTHONPATH 中。

修改完成后，我们就可以在 Python 脚本中引用其他文件夹中的 .py 文件了。