Nhận băm git hiện tại trong tập lệnh Python

Tôi muốn bao gồm hàm git hiện tại trong đầu ra của tập lệnh Python (dưới dạng số phiên bản của mã đã tạo đầu ra đó).

Làm cách nào tôi có thể truy cập hàm git hiện tại trong tập lệnh Python của mình?

Các git describelệnh là một cách tốt để tạo ra một "số phiên bản" con người-đoan của mã này. Từ các ví dụ trong tài liệu:

Với một cái gì đó như git.git cây hiện tại, tôi nhận được:

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

tức là người đứng đầu hiện tại của nhánh "cha mẹ" của tôi dựa trên v1.0.4, nhưng vì nó có một vài cam kết trên đó, mô tả đã thêm số lần xác nhận bổ sung ("14") và tên đối tượng viết tắt cho cam kết chính nó ("2414721") ở cuối.

Từ bên trong Python, bạn có thể làm một cái gì đó như sau:

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

Không cần phải hack xung quanh để lấy dữ liệu từ gitlệnh. GitPython là một cách rất hay để làm điều này và rất nhiều gitthứ khác . Nó thậm chí còn có hỗ trợ "nỗ lực tốt nhất" cho Windows.

Sau khi pip install gitpythonbạn có thể làm

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

Bài đăng này chứa lệnh, câu trả lời của Greg chứa lệnh quy trình con.

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

numpycó một thói quen đa nền tảng đẹp mắt trong 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

Nếu quy trình con không thể di động và bạn không muốn cài đặt một gói để làm điều gì đó đơn giản, bạn cũng có thể làm điều này.

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

Tôi chỉ thử nghiệm điều này trên repos của mình nhưng có vẻ như nó hoạt động khá ổn định.

Đây là phiên bản hoàn chỉnh hơn của câu trả lời của Greg :

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

Hoặc, nếu tập lệnh đang được gọi từ bên ngoài repo:

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

Nếu bạn không có sẵn git vì một số lý do, nhưng bạn có git repo (thư mục .git được tìm thấy), bạn có thể tìm nạp hàm băm từ .git / fetch / Heads / [Branch]

Ví dụ: tôi đã sử dụng đoạn mã Python nhanh và bẩn sau đây chạy ở thư mục gốc của kho lưu trữ để lấy id xác nhận:

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]