Pobierz aktualny skrót git w skrypcie Pythona

Chciałbym dołączyć bieżący skrót git do danych wyjściowych skryptu w języku Python (jako numer wersji kodu, który wygenerował dane wyjściowe).

Jak mogę uzyskać dostęp do aktualnego skrótu git w moim skrypcie Python?

git describePolecenia jest dobrym sposobem na stworzenie „numeru wersji” człowieka-reprezentacyjny kodu. Z przykładów w dokumentacji:

W przypadku aktualnego drzewa git.git otrzymuję:

[torvalds@g5 git]$ git describe parent
v1.0.4-14-g2414721

tzn. obecna nagłówek mojej gałęzi "macierzystej" jest oparta na wersji 1.0.4, ale ponieważ ma kilka zatwierdzeń, opis dodał liczbę dodatkowych zatwierdzeń ("14") i skróconą nazwę obiektu dla zatwierdzenia („2414721”) na końcu.

Z poziomu Pythona możesz wykonać następujące czynności:

import subprocess
label = subprocess.check_output(["git", "describe"]).strip()

Nie ma potrzeby samodzielnego pobierania danych z gitpolecenia. GitPython to bardzo fajny sposób na zrobienie tego i wielu innych gitrzeczy. Obsługuje nawet system Windows „do najlepszych starań”.

Po tym, jak pip install gitpythonmożesz to zrobić

import git
repo = git.Repo(search_parent_directories=True)
sha = repo.head.object.hexsha

Ten post zawiera polecenie, odpowiedź Grega zawiera polecenie podprocesu.

import subprocess

def get_git_revision_hash():
    return subprocess.check_output(['git', 'rev-parse', 'HEAD'])

def get_git_revision_short_hash():
    return subprocess.check_output(['git', 'rev-parse', '--short', 'HEAD'])

numpyma ładnie wyglądającą wieloplatformową procedurę w swoim setup.py:

import os
import subprocess

# Return the git revision as a string
def git_version():
    def _minimal_ext_cmd(cmd):
        # construct minimal environment
        env = {}
        for k in ['SYSTEMROOT', 'PATH']:
            v = os.environ.get(k)
            if v is not None:
                env[k] = v
        # LANGUAGE is used on win32
        env['LANGUAGE'] = 'C'
        env['LANG'] = 'C'
        env['LC_ALL'] = 'C'
        out = subprocess.Popen(cmd, stdout = subprocess.PIPE, env=env).communicate()[0]
        return out

    try:
        out = _minimal_ext_cmd(['git', 'rev-parse', 'HEAD'])
        GIT_REVISION = out.strip().decode('ascii')
    except OSError:
        GIT_REVISION = "Unknown"

    return GIT_REVISION

Jeśli podproces nie jest przenośny i nie chcesz instalować pakietu, aby zrobić coś tak prostego, możesz również to zrobić.

import pathlib

def get_git_revision(base_path):
    git_dir = pathlib.Path(base_path) / '.git'
    with (git_dir / 'HEAD').open('r') as head:
        ref = head.readline().split(' ')[-1].strip()

    with (git_dir / ref).open('r') as git_hash:
        return git_hash.readline().strip()

Testowałem to tylko na moich repozytoriach, ale wydaje się, że działa dość konsekwentnie.

Oto pełniejsza wersja odpowiedzi Grega :

import subprocess
print(subprocess.check_output(["git", "describe", "--always"]).strip().decode())

Lub, jeśli skrypt jest wywoływany spoza repozytorium:

import subprocess, os
os.chdir(os.path.dirname(__file__))
print(subprocess.check_output(["git", "describe", "--always"]).strip().decode())

Jeśli z jakiegoś powodu nie masz dostępnego gita, ale masz repozytorium git (znaleziono folder .git), możesz pobrać skrót zatwierdzenia z .git / fetch / heads / [branch]

Na przykład użyłem następującego szybkiego i nieczytelnego fragmentu kodu Pythona uruchomionego w katalogu głównym repozytorium, aby uzyskać identyfikator zatwierdzenia:

git_head = '.git\\HEAD'

# Open .git\HEAD file:
with open(git_head, 'r') as git_head_file:
    # Contains e.g. ref: ref/heads/master if on "master"
    git_head_data = str(git_head_file.read())

# Open the correct file in .git\ref\heads\[branch]
git_head_ref = '.git\\%s' % git_head_data.split(' ')[1].replace('/', '\\').strip()

# Get the commit hash ([:7] used to get "--short")
with open(git_head_ref, 'r') as git_head_ref_file:
    commit_id = git_head_ref_file.read().strip()[:7]