1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
|
"""Git commands and queries for Git"""
import json
import os
import re
from io import StringIO
from . import core
from . import textwrap
from . import utils
from . import version
from .git import STDOUT
from .git import EMPTY_TREE_OID
from .git import OID_LENGTH
from .i18n import N_
from .interaction import Interaction
from .models import dag
from .models import prefs
def add(context, items, u=False):
"""Run "git add" while preventing argument overflow"""
git_add = context.git.add
return utils.slice_func(
items, lambda paths: git_add('--', force=True, verbose=True, u=u, *paths)
)
def apply_diff(context, filename):
"""Use "git apply" to apply the patch in `filename` to the staging area"""
git = context.git
return git.apply(filename, index=True, cached=True)
def apply_diff_to_worktree(context, filename):
"""Use "git apply" to apply the patch in `filename` to the worktree"""
git = context.git
return git.apply(filename)
def get_branch(context, branch):
"""Get the current branch"""
if branch is None:
branch = current_branch(context)
return branch
def upstream_remote(context, branch=None):
"""Return the remote associated with the specified branch"""
config = context.cfg
branch = get_branch(context, branch)
return config.get(f'branch.{branch}.remote')
def remote_url(context, remote, push=False):
"""Return the URL for the specified remote"""
config = context.cfg
url = config.get(f'remote.{remote}.url', '')
if push:
url = config.get(f'remote.{remote}.pushurl', url)
return url
def diff_index_filenames(context, ref):
"""
Return a diff of filenames that have been modified relative to the index
"""
git = context.git
out = git.diff_index(ref, name_only=True, z=True, _readonly=True)[STDOUT]
return _parse_diff_filenames(out)
def diff_filenames(context, *args):
"""Return a list of filenames that have been modified"""
out = diff_tree(context, *args)[STDOUT]
return _parse_diff_filenames(out)
def changed_files(context, oid):
"""Return the list of filenames that changed in a given commit oid"""
status, out, _ = diff_tree(context, oid + '~', oid)
if status != 0:
# git init
status, out, _ = diff_tree(context, EMPTY_TREE_OID, oid)
if status == 0:
result = _parse_diff_filenames(out)
else:
result = []
return result
def diff_tree(context, *args):
"""Return a list of filenames that have been modified"""
git = context.git
return git_diff_tree(git, *args)
def git_diff_tree(git, *args):
return git.diff_tree(
name_only=True, no_commit_id=True, r=True, z=True, _readonly=True, *args
)
def listdir(context, dirname, ref='HEAD'):
"""Get the contents of a directory according to Git
Query Git for the content of a directory, taking ignored
files into account.
"""
dirs = []
files = []
# first, parse git ls-tree to get the tracked files
# in a list of (type, path) tuples
entries = ls_tree(context, dirname, ref=ref)
for entry in entries:
if entry[0][0] == 't': # tree
dirs.append(entry[1])
else:
files.append(entry[1])
# gather untracked files
untracked = untracked_files(context, paths=[dirname], directory=True)
for path in untracked:
if path.endswith('/'):
dirs.append(path[:-1])
else:
files.append(path)
dirs.sort()
files.sort()
return (dirs, files)
def diff(context, args):
"""Return a list of filenames for the given diff arguments
:param args: list of arguments to pass to "git diff --name-only"
"""
git = context.git
out = git.diff(name_only=True, z=True, _readonly=True, *args)[STDOUT]
return _parse_diff_filenames(out)
def _parse_diff_filenames(out):
if out:
return out[:-1].split('\0')
return []
def tracked_files(context, *args):
"""Return the names of all files in the repository"""
git = context.git
out = git.ls_files('--', *args, z=True, _readonly=True)[STDOUT]
if out:
return sorted(out[:-1].split('\0'))
return []
def all_files(context, *args):
"""Returns a sorted list of all files, including untracked files."""
git = context.git
ls_files = git.ls_files(
'--',
*args,
z=True,
cached=True,
others=True,
exclude_standard=True,
_readonly=True,
)[STDOUT]
return sorted([f for f in ls_files.split('\0') if f])
class CurrentBranchCache:
"""Cache for current_branch()"""
key = None
value = None
def reset():
"""Reset cached value in this module (e.g. the cached current branch)"""
CurrentBranchCache.key = None
def current_branch(context):
"""Return the current branch"""
git = context.git
head = git.git_path('HEAD')
try:
key = core.stat(head).st_mtime
if CurrentBranchCache.key == key:
return CurrentBranchCache.value
except OSError:
# OSError means we can't use the stat cache
key = 0
status, data, _ = git.rev_parse('HEAD', symbolic_full_name=True, _readonly=True)
if status != 0:
# git init -- read .git/HEAD. We could do this unconditionally...
data = _read_git_head(context, head)
for refs_prefix in ('refs/heads/', 'refs/remotes/', 'refs/tags/'):
if data.startswith(refs_prefix):
value = data[len(refs_prefix) :]
CurrentBranchCache.key = key
CurrentBranchCache.value = value
return value
# Detached head
return data
def _read_git_head(context, head, default='main'):
"""Pure-python .git/HEAD reader"""
# Common .git/HEAD "ref: refs/heads/main" files
git = context.git
islink = core.islink(head)
if core.isfile(head) and not islink:
data = core.read(head).rstrip()
ref_prefix = 'ref: '
if data.startswith(ref_prefix):
return data[len(ref_prefix) :]
# Detached head
return data
# Legacy .git/HEAD symlinks
if islink:
refs_heads = core.realpath(git.git_path('refs', 'heads'))
path = core.abspath(head).replace('\\', '/')
if path.startswith(refs_heads + '/'):
return path[len(refs_heads) + 1 :]
return default
def branch_list(context, remote=False):
"""
Return a list of local or remote branches
This explicitly removes HEAD from the list of remote branches.
"""
if remote:
return for_each_ref_basename(context, 'refs/remotes')
return for_each_ref_basename(context, 'refs/heads')
def _version_sort(context, key='version:refname'):
if version.check_git(context, 'version-sort'):
sort = key
else:
sort = False
return sort
def for_each_ref_basename(context, refs):
"""Return refs starting with 'refs'."""
git = context.git
sort = _version_sort(context)
_, out, _ = git.for_each_ref(refs, format='%(refname)', sort=sort, _readonly=True)
output = out.splitlines()
non_heads = [x for x in output if not x.endswith('/HEAD')]
offset = len(refs) + 1
return [x[offset:] for x in non_heads]
def _prefix_and_size(prefix, values):
"""Return a tuple of (prefix, len(prefix) + 1, y) for <prefix>/ stripping"""
return (prefix, len(prefix) + 1, values)
def all_refs(context, split=False, sort_key='version:refname'):
"""Return a tuple of (local branches, remote branches, tags)."""
git = context.git
local_branches = []
remote_branches = []
tags = []
query = (
_prefix_and_size('refs/tags', tags),
_prefix_and_size('refs/heads', local_branches),
_prefix_and_size('refs/remotes', remote_branches),
)
sort = _version_sort(context, key=sort_key)
_, out, _ = git.for_each_ref(format='%(refname)', sort=sort, _readonly=True)
for ref in out.splitlines():
for prefix, prefix_len, dst in query:
if ref.startswith(prefix) and not ref.endswith('/HEAD'):
dst.append(ref[prefix_len:])
continue
tags.reverse()
if split:
return local_branches, remote_branches, tags
return local_branches + remote_branches + tags
def tracked_branch(context, branch=None):
"""Return the remote branch associated with 'branch'."""
if branch is None:
branch = current_branch(context)
if branch is None:
return None
config = context.cfg
remote = config.get('branch.%s.remote' % branch)
if not remote:
return None
merge_ref = config.get('branch.%s.merge' % branch)
if not merge_ref:
return None
refs_heads = 'refs/heads/'
if merge_ref.startswith(refs_heads):
return remote + '/' + merge_ref[len(refs_heads) :]
return None
def parse_remote_branch(branch):
"""Split a remote branch apart into (remote, name) components"""
rgx = re.compile(r'^(?P<remote>[^/]+)/(?P<branch>.+)$')
match = rgx.match(branch)
remote = ''
branch = ''
if match:
remote = match.group('remote')
branch = match.group('branch')
return (remote, branch)
def untracked_files(context, paths=None, **kwargs):
"""Returns a sorted list of untracked files."""
git = context.git
if paths is None:
paths = []
args = ['--'] + paths
out = git.ls_files(
z=True, others=True, exclude_standard=True, _readonly=True, *args, **kwargs
)[STDOUT]
if out:
return out[:-1].split('\0')
return []
def tag_list(context):
"""Return a list of tags."""
result = for_each_ref_basename(context, 'refs/tags')
result.reverse()
return result
def log(git, *args, **kwargs):
return git.log(
no_color=True,
no_abbrev_commit=True,
no_ext_diff=True,
_readonly=True,
*args,
**kwargs,
)[STDOUT]
def commit_diff(context, oid):
git = context.git
return log(git, '-1', oid, '--') + '\n\n' + oid_diff(context, oid)
_diff_overrides = {}
def update_diff_overrides(space_at_eol, space_change, all_space, function_context):
_diff_overrides['ignore_space_at_eol'] = space_at_eol
_diff_overrides['ignore_space_change'] = space_change
_diff_overrides['ignore_all_space'] = all_space
_diff_overrides['function_context'] = function_context
def common_diff_opts(context):
config = context.cfg
# Default to --patience when diff.algorithm is unset
patience = not config.get('diff.algorithm', default='')
submodule = version.check_git(context, 'diff-submodule')
opts = {
'patience': patience,
'submodule': submodule,
'no_color': True,
'no_ext_diff': True,
'unified': config.get('gui.diffcontext', default=3),
'_raw': True,
'_readonly': True,
}
opts.update(_diff_overrides)
return opts
def _add_filename(args, filename):
if filename:
args.extend(['--', filename])
def oid_diff(context, oid, filename=None):
"""Return the diff for an oid"""
# Naively "$oid^!" is what we'd like to use but that doesn't
# give the correct result for merges--the diff is reversed.
# Be explicit and compare oid against its first parent.
return oid_diff_range(context, oid + '~', oid, filename=filename)
def oid_diff_range(context, start, end, filename=None):
"""Return the diff for a commit range"""
if end == dag.STAGE:
if start == dag.STAGE + '~':
args = ['--cached']
else:
args = ['--cached', start]
elif end == dag.WORKTREE:
if start == dag.WORKTREE + '~' or start == dag.STAGE + '~':
args = []
else:
args = [start]
else:
args = [start, end]
git = context.git
opts = common_diff_opts(context)
_add_filename(args, filename)
status, out, _ = git.diff(*args, **opts)
if status != 0:
# We probably don't have "$oid~" because this is the root commit.
# "git show" is clever enough to handle the root commit.
args = [end + '^!']
_add_filename(args, filename)
_, out, _ = git.show(pretty='format:', *args, **opts)
out = out.lstrip()
return out
def diff_info(context, oid, filename=None):
"""Return the diff for the specified oid"""
return diff_range(context, oid + '~', oid, filename=filename)
def diff_range(context, start, end, filename=None):
"""Return the diff for the specified commit range"""
git = context.git
if end == dag.WORKTREE or end == dag.STAGE:
commitmsg = context.model.commitmsg
if commitmsg:
raw_description = '\n'.join(commitmsg.split('\n')[2:])
tabwidth = prefs.tabwidth(context)
textwidth = prefs.textwidth(context)
description = textwrap.word_wrap(raw_description, tabwidth, textwidth)
else:
description = ''
else:
description = log(git, '-1', end, '--', pretty='format:%b').strip()
if description:
description += '\n\n'
return description + oid_diff_range(context, start, end, filename=filename)
def diff_helper(
context,
commit=None,
ref=None,
endref=None,
filename=None,
cached=True,
deleted=False,
head=None,
amending=False,
with_diff_header=False,
suppress_header=True,
reverse=False,
untracked=False,
):
"""Invoke git diff on a path"""
git = context.git
cfg = context.cfg
if commit:
ref, endref = commit + '^', commit
argv = []
if ref and endref:
argv.append(f'{ref}..{endref}')
elif ref:
argv.extend(utils.shell_split(ref.strip()))
elif head and amending and cached:
argv.append(head)
encoding = None
if untracked:
argv.append('--no-index')
argv.append(os.devnull)
argv.append(filename)
elif filename:
argv.append('--')
if isinstance(filename, (list, tuple)):
argv.extend(filename)
else:
argv.append(filename)
encoding = cfg.file_encoding(filename)
status, out, _ = git.diff(
R=reverse,
M=True,
cached=cached,
_encoding=encoding,
*argv,
**common_diff_opts(context),
)
success = status == 0
# Diff will return 1 when comparing untracked file and it has change,
# therefore we will check for diff header from output to differentiate
# from actual error such as file not found.
if untracked and status == 1:
try:
_, second, _ = out.split('\n', 2)
except ValueError:
second = ''
success = second.startswith('new file mode ')
if not success:
# git init
if with_diff_header:
return ('', '')
return ''
result = extract_diff_header(deleted, with_diff_header, suppress_header, out)
return core.UStr(result, out.encoding)
def extract_diff_header(deleted, with_diff_header, suppress_header, diffoutput):
"""Split a diff into a header section and payload section"""
if diffoutput.startswith('Submodule'):
if with_diff_header:
return ('', diffoutput)
return diffoutput
start = False
del_tag = 'deleted file mode '
output = StringIO()
headers = StringIO()
for line in diffoutput.split('\n'):
if not start and line[:2] == '@@' and '@@' in line[2:]:
start = True
if start or (deleted and del_tag in line):
output.write(line + '\n')
else:
if with_diff_header:
headers.write(line + '\n')
elif not suppress_header:
output.write(line + '\n')
output_text = output.getvalue()
output.close()
headers_text = headers.getvalue()
headers.close()
if with_diff_header:
return (headers_text, output_text)
return output_text
def format_patchsets(context, to_export, revs, output='patches'):
"""
Group contiguous revision selection into patch sets
Exists to handle multi-selection.
Multiple disparate ranges in the revision selection
are grouped into continuous lists.
"""
outs = []
errs = []
cur_rev = to_export[0]
cur_rev_idx = revs.index(cur_rev)
patches_to_export = [[cur_rev]]
patchset_idx = 0
# Group the patches into continuous sets
for rev in to_export[1:]:
# Limit the search to the current neighborhood for efficiency
try:
rev_idx = revs[cur_rev_idx:].index(rev)
rev_idx += cur_rev_idx
except ValueError:
rev_idx = revs.index(rev)
if rev_idx == cur_rev_idx + 1:
patches_to_export[patchset_idx].append(rev)
cur_rev_idx += 1
else:
patches_to_export.append([rev])
cur_rev_idx = rev_idx
patchset_idx += 1
# Export each patch set
status = 0
for patchset in patches_to_export:
stat, out, err = export_patchset(
context,
patchset[0],
patchset[-1],
output=output,
n=len(patchset) > 1,
thread=True,
patch_with_stat=True,
)
outs.append(out)
if err:
errs.append(err)
status = max(stat, status)
return (status, '\n'.join(outs), '\n'.join(errs))
def export_patchset(context, start, end, output='patches', **kwargs):
"""Export patches from start^ to end."""
git = context.git
return git.format_patch('-o', output, start + '^..' + end, **kwargs)
def reset_paths(context, head, items):
"""Run "git reset" while preventing argument overflow"""
items = list(set(items))
func = context.git.reset
status, out, err = utils.slice_func(items, lambda paths: func(head, '--', *paths))
return (status, out, err)
def unstage_paths(context, args, head='HEAD'):
"""Unstage paths while accounting for git init"""
status, out, err = reset_paths(context, head, args)
if status == 128:
# handle git init: we have to use 'git rm --cached'
# detect this condition by checking if the file is still staged
return untrack_paths(context, args)
return (status, out, err)
def untrack_paths(context, args):
if not args:
return (-1, N_('Nothing to do'), '')
git = context.git
return git.update_index('--', force_remove=True, *set(args))
def worktree_state(
context, head='HEAD', update_index=False, display_untracked=True, paths=None
):
"""Return a dict of files in various states of being
:rtype: dict, keys are staged, unstaged, untracked, unmerged,
changed_upstream, and submodule.
"""
git = context.git
if update_index:
git.update_index(refresh=True)
staged, unmerged, staged_deleted, staged_submods = diff_index(
context, head, paths=paths
)
modified, unstaged_deleted, modified_submods = diff_worktree(context, paths)
if display_untracked:
untracked = untracked_files(context, paths=paths)
else:
untracked = []
# Remove unmerged paths from the modified list
if unmerged:
unmerged_set = set(unmerged)
modified = [path for path in modified if path not in unmerged_set]
# Look for upstream modified files if this is a tracking branch
upstream_changed = diff_upstream(context, head)
# Keep stuff sorted
staged.sort()
modified.sort()
unmerged.sort()
untracked.sort()
upstream_changed.sort()
return {
'staged': staged,
'modified': modified,
'unmerged': unmerged,
'untracked': untracked,
'upstream_changed': upstream_changed,
'staged_deleted': staged_deleted,
'unstaged_deleted': unstaged_deleted,
'submodules': staged_submods | modified_submods,
}
def _parse_raw_diff(out):
while out:
info, path, out = out.split('\0', 2)
status = info[-1]
is_submodule = '160000' in info[1:14]
yield (path, status, is_submodule)
def diff_index(context, head, cached=True, paths=None):
git = context.git
staged = []
unmerged = []
deleted = set()
submodules = set()
if paths is None:
paths = []
args = [head, '--'] + paths
status, out, _ = git.diff_index(cached=cached, z=True, _readonly=True, *args)
if status != 0:
# handle git init
args[0] = EMPTY_TREE_OID
status, out, _ = git.diff_index(cached=cached, z=True, _readonly=True, *args)
for path, status, is_submodule in _parse_raw_diff(out):
if is_submodule:
submodules.add(path)
if status in 'DAMT':
staged.append(path)
if status == 'D':
deleted.add(path)
elif status == 'U':
unmerged.append(path)
return staged, unmerged, deleted, submodules
def diff_worktree(context, paths=None):
git = context.git
ignore_submodules_value = context.cfg.get('diff.ignoresubmodules', 'none')
ignore_submodules = ignore_submodules_value in {'all', 'dirty', 'untracked'}
modified = []
deleted = set()
submodules = set()
if paths is None:
paths = []
args = ['--'] + paths
status, out, _ = git.diff_files(z=True, _readonly=True, *args)
for path, status, is_submodule in _parse_raw_diff(out):
if is_submodule:
submodules.add(path)
if ignore_submodules:
continue
if status in 'DAMT':
modified.append(path)
if status == 'D':
deleted.add(path)
return modified, deleted, submodules
def diff_upstream(context, head):
"""Given `ref`, return $(git merge-base ref HEAD)..ref."""
tracked = tracked_branch(context)
if not tracked:
return []
base = merge_base(context, head, tracked)
return diff_filenames(context, base, tracked)
def list_submodule(context):
"""Return submodules in the format(state, sha_1, path, describe)"""
git = context.git
status, data, _ = git.submodule('status')
ret = []
if status == 0 and data:
data = data.splitlines()
# see git submodule status
for line in data:
state = line[0].strip()
sha1 = line[1 : OID_LENGTH + 1]
left_bracket = line.find('(', OID_LENGTH + 3)
if left_bracket == -1:
left_bracket = len(line) + 1
path = line[OID_LENGTH + 2 : left_bracket - 1]
describe = line[left_bracket + 1 : -1]
ret.append((state, sha1, path, describe))
return ret
def merge_base(context, head, ref):
"""Return the merge-base of head and ref"""
git = context.git
return git.merge_base(head, ref, _readonly=True)[STDOUT]
def merge_base_parent(context, branch):
tracked = tracked_branch(context, branch=branch)
if tracked:
return tracked
return 'HEAD'
def ls_tree(context, path, ref='HEAD'):
"""Return a parsed git ls-tree result for a single directory"""
git = context.git
result = []
status, out, _ = git.ls_tree(
ref, '--', path, z=True, full_tree=True, _readonly=True
)
if status == 0 and out:
path_offset = 6 + 1 + 4 + 1 + OID_LENGTH + 1
for line in out[:-1].split('\0'):
# 1 1 1
# .....6 ...4 ......................................40
# 040000 tree c127cde9a0c644a3a8fef449a244f47d5272dfa6 relative
# 100644 blob 139e42bf4acaa4927ec9be1ec55a252b97d3f1e2 relative/path
# 0..... 7... 12...................................... 53
# path_offset = 6 + 1 + 4 + 1 + OID_LENGTH(40) + 1
objtype = line[7:11]
relpath = line[path_offset:]
result.append((objtype, relpath))
return result
# A regex for matching the output of git(log|rev-list) --pretty=oneline
REV_LIST_REGEX = re.compile(r'^([0-9a-f]{40}) (.*)$')
def parse_rev_list(raw_revs):
"""Parse `git log --pretty=online` output into (oid, summary) pairs."""
revs = []
for line in raw_revs.splitlines():
match = REV_LIST_REGEX.match(line)
if match:
rev_id = match.group(1)
summary = match.group(2)
revs.append((
rev_id,
summary,
))
return revs
def log_helper(context, all=False, extra_args=None):
"""Return parallel arrays containing oids and summaries."""
revs = []
summaries = []
args = []
if extra_args:
args = extra_args
git = context.git
output = log(git, pretty='oneline', all=all, *args)
for line in output.splitlines():
match = REV_LIST_REGEX.match(line)
if match:
revs.append(match.group(1))
summaries.append(match.group(2))
return (revs, summaries)
def rev_list_range(context, start, end):
"""Return (oid, summary) pairs between start and end."""
git = context.git
revrange = f'{start}..{end}'
out = git.rev_list(revrange, pretty='oneline', _readonly=True)[STDOUT]
return parse_rev_list(out)
def commit_message_path(context):
"""Return the path to .git/GIT_COLA_MSG"""
git = context.git
path = git.git_path('GIT_COLA_MSG')
if core.exists(path):
return path
return None
def merge_message_path(context):
"""Return the path to .git/MERGE_MSG or .git/SQUASH_MSG."""
git = context.git
for basename in ('MERGE_MSG', 'SQUASH_MSG'):
path = git.git_path(basename)
if core.exists(path):
return path
return None
def read_merge_commit_message(context, path):
"""Read a merge commit message from disk while stripping commentary"""
content = core.read(path)
cleanup_mode = prefs.commit_cleanup(context)
if cleanup_mode in ('verbatim', 'scissors', 'whitespace'):
return content
comment_char = prefs.comment_char(context)
return '\n'.join(
line for line in content.splitlines() if not line.startswith(comment_char)
)
def prepare_commit_message_hook(context):
"""Run the cola.preparecommitmessagehook to prepare the commit message"""
config = context.cfg
default_hook = config.hooks_path('cola-prepare-commit-msg')
return config.get('cola.preparecommitmessagehook', default=default_hook)
def cherry_pick(context, revs):
"""Cherry-picks each revision into the current branch.
Returns (0, out, err) where stdout and stderr across all "git cherry-pick"
invocations are combined into single values when all cherry-picks succeed.
Returns a combined (status, out, err) of the first failing "git cherry-pick"
in the event of a non-zero exit status.
"""
if not revs:
return []
outs = []
errs = []
status = 0
for rev in revs:
status, out, err = context.git.cherry_pick(rev)
if status != 0:
details = N_(
'Hint: The "Actions > Abort Cherry-Pick" menu action can be used to '
'cancel the current cherry-pick.'
)
output = f'# git cherry-pick {rev}\n# {details}\n\n{out}'
return (status, output, err)
outs.append(out)
errs.append(err)
return (0, '\n'.join(outs), '\n'.join(errs))
def abort_apply_patch(context):
"""Abort a "git am" session."""
# Reset the worktree
git = context.git
status, out, err = git.am(abort=True)
return status, out, err
def abort_cherry_pick(context):
"""Abort a cherry-pick."""
# Reset the worktree
git = context.git
status, out, err = git.cherry_pick(abort=True)
return status, out, err
def abort_merge(context):
"""Abort a merge"""
# Reset the worktree
git = context.git
status, out, err = git.merge(abort=True)
return status, out, err
def strip_remote(remotes, remote_branch):
"""Get branch names with the "<remote>/" prefix removed"""
for remote in remotes:
prefix = remote + '/'
if remote_branch.startswith(prefix):
return remote_branch[len(prefix) :]
return remote_branch.split('/', 1)[-1]
def parse_refs(context, argv):
"""Parse command-line arguments into object IDs"""
git = context.git
status, out, _ = git.rev_parse(_readonly=True, *argv)
if status == 0:
oids = [oid for oid in out.splitlines() if oid]
else:
oids = argv
return oids
def prev_commitmsg(context, *args):
"""Queries git for the latest commit message."""
git = context.git
return git.log(
'-1', no_color=True, pretty='format:%s%n%n%b', _readonly=True, *args
)[STDOUT]
def rev_parse(context, name):
"""Call git rev-parse and return the output"""
git = context.git
status, out, _ = git.rev_parse(name, _readonly=True)
if status == 0:
result = out.strip()
else:
result = name
return result
def write_blob(context, oid, filename):
"""Write a blob to a temporary file and return the path
Modern versions of Git allow invoking filters. Older versions
get the object content as-is.
"""
if version.check_git(context, 'cat-file-filters-path'):
return cat_file_to_path(context, filename, oid)
return cat_file_blob(context, filename, oid)
def cat_file_blob(context, filename, oid):
"""Write a blob from git to the specified filename"""
return cat_file(context, filename, 'blob', oid)
def cat_file_to_path(context, filename, oid):
"""Extract a file from a commit ref and a write it to the specified filename"""
return cat_file(context, filename, oid, path=filename, filters=True)
def cat_file(context, filename, *args, **kwargs):
"""Redirect git cat-file output to a path"""
result = None
git = context.git
# Use the original filename in the suffix so that the generated filename
# has the correct extension, and so that it resembles the original name.
basename = os.path.basename(filename)
suffix = '-' + basename # ensures the correct filename extension
path = utils.tmp_filename('blob', suffix=suffix)
with open(path, 'wb') as tmp_file:
status, out, err = git.cat_file(
_raw=True, _readonly=True, _stdout=tmp_file, *args, **kwargs
)
Interaction.command(N_('Error'), 'git cat-file', status, out, err)
if status == 0:
result = path
if not result:
core.unlink(path)
return result
def write_blob_path(context, head, oid, filename):
"""Use write_blob() when modern git is available"""
if version.check_git(context, 'cat-file-filters-path'):
return write_blob(context, oid, filename)
return cat_file_blob(context, filename, head + ':' + filename)
def annex_path(context, head, filename):
"""Return the git-annex path for a filename at the specified commit"""
git = context.git
path = None
annex_info = {}
# unfortunately there's no way to filter this down to a single path
# so we just have to scan all reported paths
status, out, _ = git.annex('findref', '--json', head, _readonly=True)
if status == 0:
for line in out.splitlines():
info = json.loads(line)
try:
annex_file = info['file']
except (ValueError, KeyError):
continue
# we only care about this file so we can skip the rest
if annex_file == filename:
annex_info = info
break
key = annex_info.get('key', '')
if key:
status, out, _ = git.annex('contentlocation', key, _readonly=True)
if status == 0 and os.path.exists(out):
path = out
return path
def is_binary(context, filename):
"""A heuristic to determine whether `filename` contains (non-text) binary content"""
cfg_is_binary = context.cfg.is_binary(filename)
if cfg_is_binary is not None:
return cfg_is_binary
# This is the same heuristic as xdiff-interface.c:buffer_is_binary().
size = 8000
try:
result = core.read(filename, size=size, encoding='bytes')
except OSError:
result = b''
return b'\0' in result
def is_valid_ref(context, ref):
"""Is the provided Git ref a valid refname?"""
status, _, _ = context.git.rev_parse(ref, quiet=True, verify=True, _readonly=True)
return status == 0
|