简介

此包通过允许所有路径相对于项目仓库根目录，使Python项目中路径的处理标准化。该包根据特殊（空）.py-repo-root文件的位置来发现项目根目录。如果需要，可以覆盖项目根指示器。

此包受到了pyprojroot的极大启发。此包允许自定义根文件指示器，避免了"/"是"/"的父级问题，并可以使用当前文件位置开始遍历目录树。

设置

安装

pip install py-repo-root

使用

使用默认的项目根指示器列表获取项目根

from pyreporoot import project_root

project_root_dir = project_root(__file__)

指定自定义项目根指示器（不在上面的列表中）

project_root_dir = project_root(__file__, root_files='.my-root-indicator')

另一种常见的使用模式可能是将项目_root添加到PYTHONPATH，以便运行某些脚本。

import sys
from pyreporoot import project_root

sys.path.insert(0, project_root(__file__))

从项目根目录获取文件的相对路径

from pathlib import Path
from projectroot import project_root

project_root_dir = project_root(__file__)
path_rel_to_project_root = Path(project_root_dir).joinpath('/path/to/file.txt')