Dapatkan hasit git saat ini dalam skrip Python

Saya ingin memasukkan hash git saat ini dalam output skrip Python (sebagai nomor versi dari kode yang menghasilkan keluaran itu).

Bagaimana saya bisa mengakses hash git saat ini di skrip Python saya?

The git describeperintah adalah cara yang baik untuk menciptakan "nomor versi" manusia-rapi kode. Dari contoh-contoh dalam dokumentasi:

Dengan sesuatu seperti pohon git.git saat ini, saya mendapatkan:

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

yaitu kepala saat ini dari cabang "induk" saya didasarkan pada v1.0.4, tetapi karena memiliki beberapa commit di atas itu, jelaskan telah menambahkan jumlah komit tambahan ("14") dan nama objek singkatan untuk kom sendiri ("2414721") di akhir.

Dari dalam Python, Anda dapat melakukan sesuatu seperti berikut:

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

Tidak perlu meretas mendapatkan data dari gitperintah sendiri. GitPython adalah cara yang sangat bagus untuk melakukan ini dan banyak githal lainnya . Bahkan memiliki dukungan "upaya terbaik" untuk Windows.

Setelah pip install gitpythonkamu bisa melakukannya

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

Posting ini berisi perintah, jawaban Greg berisi perintah subproses.

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

numpymemiliki rutinitas multi-platform yang terlihat bagus di 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

Jika subproses tidak portabel dan Anda tidak ingin menginstal paket untuk melakukan sesuatu sesederhana ini, Anda juga dapat melakukannya.

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

Saya hanya menguji ini pada repo saya tetapi tampaknya bekerja cukup konsisten.

Berikut versi jawaban Greg yang lebih lengkap :

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

Atau, jika skrip dipanggil dari luar repo:

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

Jika Anda tidak memiliki git karena beberapa alasan, tetapi Anda memiliki git repo (folder .git ditemukan), Anda dapat mengambil hash komit dari .git / fetch / heads / [branch]

Sebagai contoh, saya telah menggunakan snippet Python cepat dan kotor berikut yang dijalankan di root repositori untuk mendapatkan id komit:

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]