Pythonスクリプトで現在のgitハッシュを取得する

現在のgitハッシュをPythonスクリプトの出力に含めたい（その出力を生成したコードのバージョン番号として）。

Pythonスクリプトで現在のgitハッシュにアクセスするにはどうすればよいですか？

このgit describeコマンドは、人間が提示できるコードの「バージョン番号」を作成するための優れた方法です。ドキュメントの例から：

git.git current treeのようなもので、私は得ます：

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

つまり、私の「親」ブランチの現在のヘッドはv1.0.4に基づいていますが、その上にいくつかのコミットがあるため、describeは追加のコミット（ "14"）の数とそのコミットの省略されたオブジェクト名を追加しました最後にそれ自体（「2414721」）。

Python内から、次のようなことができます。

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

gitコマンドからデータを取得するためにハッキングする必要はありません。GitPythonは、これや他の多くのことを行うための非常に優れた方法gitです。Windowsの「ベストエフォート」もサポートしています。

pip install gitpythonあなたができる後

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

この投稿にはコマンドが含まれ、Gregの回答にはサブプロセスコマンドが含まれています。

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

numpyその中に見栄えの良いマルチプラットフォームルーチンがあります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

サブプロセスが移植可能ではなく、パッケージをインストールしてこれほど簡単なことをしたくない場合は、これも実行できます。

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

私はこれを私のリポジトリでテストしただけですが、それはかなり一貫して動作するようです。

これがグレッグの答えのより完全なバージョンです：

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

または、スクリプトがリポジトリの外部から呼び出されている場合：

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

何らかの理由でgitを使用できないが、gitリポジトリ（.gitフォルダーが見つかった）がある場合は、.git / fetch / heads / [branch]からコミットハッシュをフェッチできます。

たとえば、コミットIDを取得するために、リポジトリルートで実行される次の汚いPythonスニペットを使用しました。

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]