Holen Sie sich den aktuellen Git-Hash in einem Python-Skript

Ich möchte den aktuellen Git-Hash in die Ausgabe eines Python-Skripts aufnehmen (als Versionsnummer des Codes, der diese Ausgabe generiert hat).

Wie kann ich in meinem Python-Skript auf den aktuellen Git-Hash zugreifen?

Der git describeBefehl ist eine gute Möglichkeit, eine vom Menschen präsentierbare "Versionsnummer" des Codes zu erstellen. Aus den Beispielen in der Dokumentation:

Mit so etwas wie git.git aktueller Baum bekomme ich:

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

Das heißt, der aktuelle Kopf meines "übergeordneten" Zweigs basiert auf Version 1.0.4. Da er jedoch einige Commits enthält, hat description die Anzahl der zusätzlichen Commits ("14") und einen abgekürzten Objektnamen für das Commit hinzugefügt selbst ("2414721") am Ende.

In Python können Sie Folgendes tun:

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

Sie müssen nicht herumhacken, um selbst Daten vom gitBefehl abzurufen. GitPython ist eine sehr schöne Möglichkeit, dies und viele andere Dinge zu tun git. Es bietet sogar "Best Effort" -Unterstützung für Windows.

Nachdem pip install gitpythonSie tun können

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

Dieser Beitrag enthält den Befehl, Gregs Antwort enthält den Unterprozessbefehl.

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'])

numpyhat eine gut aussehende Multi-Plattform-Routine in seiner 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

Wenn der Unterprozess nicht portierbar ist und Sie kein Paket installieren möchten, um etwas so Einfaches zu tun, können Sie dies auch tun.

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()

Ich habe dies nur auf meinen Repos getestet, aber es scheint ziemlich konstant zu funktionieren.

Hier ist eine vollständigere Version von Gregs Antwort :

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

Oder wenn das Skript von außerhalb des Repos aufgerufen wird:

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

Wenn Sie aus irgendeinem Grund kein Git zur Verfügung haben, aber das Git-Repo haben (der Ordner .git wurde gefunden), können Sie den Commit-Hash aus .git / fetch / Heads / [branch] abrufen.

Zum Beispiel habe ich ein folgendes schnelles und schmutziges Python-Snippet verwendet, das im Repository-Stammverzeichnis ausgeführt wird, um die Commit-ID abzurufen:

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]