找到文件所在的git存储库的根目录

Question

在Python中工作(例如运行脚本)时,如何找到脚本所在的git存储库根目录的路径？

到目前为止,我知道我可以获得当前路径:

path_to_containing_folder = os.path.dirname(os.path.realpath(__file__))

那么我怎样才能找到git存储库所在的位置？

Answer 1

.git在所有情况下查找目录都不起作用.正确的git命令是:

git rev-parse --show-toplevel

Answer 2

使用GitPython模块http://gitpython.readthedocs.io/en/stable/.

pip install gitpython

假设您有一个本地Git仓库/path/to/.git.下面的示例接收/path/to/your/file输入,它正确返回Git根作为/path/to/.

import git

def get_git_root(path):

        git_repo = git.Repo(path, search_parent_directories=True)
        git_root = git_repo.git.rev_parse("--show-toplevel")
        print git_root

if __name__ == "__main__":
    get_git_root("/path/to/your/file")

Answer 3

该GitPython模块提供的这个属性右出的现成为您提供:

import git

repo = git.Repo('.', search_parent_directories=True)
repo.working_tree_dir

Answer 4

没有任何外部库：

import subprocess

def getGitRoot():
    return subprocess.Popen(['git', 'rev-parse', '--show-toplevel'], stdout=subprocess.PIPE).communicate()[0].rstrip().decode('utf-8')

Answer 5

我刚刚为此任务编写了一个小python模块:https: //github.com/MaxNoe/python-gitpath

安装时 pip install git+https://github.com/maxnoe/python-gitpath

用法:

import gitpath

print(gitpath.root())
print(gitpath.abspath('myfile.txt'))

gitpath.abspath(relative_path) 将返回机器上的绝对路径,以获取相对于git存储库根目录的路径.

获取root的代码部分来自Ryne Everetts评论:

from subprocess import check_output, CalledProcessError
from functools import lru_cache

@lru_cache(maxsize=1)
def root():
    ''' returns the absolute path of the repository root '''
    try:
        base = check_output('git rev-parse --show-toplevel', shell=True)
    except CalledProcessError:
        raise IOError('Current working directory is not a git repository')
    return base.decode('utf-8').strip()

缓存第二次调用root()ca. 快3500倍(用ipython和测量%%timeit)

Answer 6

我发现其他答案对于这项任务来说太混乱了，所以我创建了这个函数来解决这个问题。基本上，它循环遍历给定路径的父目录并返回第一个包含“.git”目录的目录。如果没有找到，则返回 None。

from pathlib import Path

def find_repo(path):
    "Find repository root from the path's parents"
    for path in Path(path).parents:
        # Check whether "path/.git" exists and is a directory
        git_dir = path / ".git"
        if git_dir.is_dir():
            return path

# Find the repo root where the script is
find_repo(__file__)

Pathlib 是标准库 (Python 3) 的一部分，因此没有额外的依赖项。如果这是你唯一需要的东西，Gitpython 就有点大材小用了。

Answer 7

这个函数是通用的（不依赖于外部模块或调用git命令）。它从给定的路径向上搜索以找到第一个包含.git目录的路径。

def find_vcs_root(test, dirs=(".git",), default=None):
    import os
    prev, test = None, os.path.abspath(test)
    while prev != test:
        if any(os.path.isdir(os.path.join(test, d)) for d in dirs):
            return test
        prev, test = test, os.path.abspath(os.path.join(test, os.pardir))
    return default

使用示例：

import os
print(find_vcs_root(os.path.dirname(__file__)))

或检查其他版本控制：

import os
print(find_vcs_root(os.path.dirname(__file__)), dirs=(".hg", ".git", ".svn"))