Python 获取项目根路径的代码

获取Python项目根路径是常见的需求，本文将介绍两种获取Python项目根路径的方法：

方法一：使用os和sys模块获取项目根路径

使用os和sys模块可以获取Python项目的根路径，具体操作步骤如下：

首先，在Python项目中创建一个文件“root_path.py”。
在“root_path.py”中使用以下代码来获取Python项目根路径。

import os
import sys

# 获取当前文件所在目录
current_path = os.path.dirname(os.path.abspath(__file__))
# 获取项目根目录
root_path = os.path.abspath(os.path.join(current_path, '..'))
sys.path.append(root_path) # 将项目根目录添加到系统路径中

接着，我们可以通过以下方式来测试该代码是否正确。

示例1：测试当前模块的根目录

如下是一个当前文件目录结构的示例图：

  myproject/
  │
  ├── root_path.py
  ├── module1/
  │     └──__init__.py
  │     └── module_example.py
  ├── tests/
  ├── myproject.py
  ...

在“module_example.py”文件的顶部添加如下代码：

from root_path import root_path
import os

print(os.path.join(root_path, "tests")) # 根目录/test
print(os.path.join(root_path, "module1", "test.txt")) # 根目录/module1/test.txt

在“module_example.py”中运行该代码，通过输出结果进行验证。输出结果应该为：

/your_path/myproject/tests
/your_path/myproject/module1/test.txt

示例2：测试直接运行的Python文件是否正确

from root_path import root_path
import os

if __name__ == "__main__":
   print(root_path)

在“myproject.py”中运行以上代码，输出结果应该为：

/your_path/myproject

方法二：使用file属性获取项目根路径

还可以通过Python内置的__file__属性获取Python项目的根路径，具体操作步骤如下：

在Python项目中创建一个文件“root_path.py”。
在“root_path.py”中使用以下代码来获取Python项目根路径。

import os

# 获取当前文件所在目录
current_path = os.path.dirname(os.path.abspath(__file__))
# 获取项目根目录
root_path = os.path.abspath(os.path.join(current_path, os.pardir))

接着，我们可以通过以下方式来测试该代码是否正确。