Obtenez le hachage git actuel dans un script Python

Je voudrais inclure le hachage git actuel dans la sortie d'un script Python (en tant que numéro de version du code qui a généré cette sortie).

Comment puis-je accéder au hachage git actuel dans mon script Python?

La git describecommande est un bon moyen de créer un "numéro de version" présentable par l'homme du code. D'après les exemples de la documentation:

Avec quelque chose comme l'arbre actuel de git.git, j'obtiens:

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

c'est-à-dire que la tête actuelle de ma branche "parent" est basée sur la v1.0.4, mais comme elle a quelques commits en plus de cela, describe a ajouté le nombre de commits supplémentaires ("14") et un nom d'objet abrégé pour le commit lui-même ("2414721") à la fin.

Depuis Python, vous pouvez faire quelque chose comme ce qui suit:

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

Pas besoin de pirater pour obtenir des données de la gitcommande vous-même. GitPython est un très bon moyen de faire cela et bien d'autresgit choses. Il a même un support "best effort" pour Windows.

Après avoir pip install gitpythonpu faire

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

Ce message contient la commande, la réponse de Greg contient la commande de sous-processus.

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

numpya une belle routine multi-plateforme dans son 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

Si le sous-processus n'est pas portable et que vous ne voulez pas installer un package pour faire quelque chose d'aussi simple, vous pouvez également le faire.

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

Je n'ai testé cela que sur mes dépôts, mais cela semble fonctionner de manière assez cohérente.

Voici une version plus complète de la réponse de Greg :

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

Ou, si le script est appelé depuis l'extérieur du dépôt:

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

Si vous n'avez pas git disponible pour une raison quelconque, mais que vous avez le repo git (le dossier .git est trouvé), vous pouvez récupérer le hachage de validation à partir de .git / fetch / heads / [branch]

Par exemple, j'ai utilisé un extrait de code Python rapide et sale suivant à la racine du référentiel pour obtenir l'ID de validation:

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]