1 """Python GIT interface
5 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License version 2 as
9 published by the Free Software Foundation.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 import sys, os, popen2
23 from stgit.utils import *
26 class GitException(Exception):
30 # Different start-up variables read from the environment
31 if 'GIT_DIR' in os.environ:
32 base_dir = os.environ['GIT_DIR']
41 """Handle the commit objects
43 def __init__(self, id_hash):
44 self.__id_hash = id_hash
46 lines = _output_lines('git-cat-file commit %s' % id_hash)
48 for i in range(len(lines)):
52 field = line.strip().split(' ', 1)
53 if field[0] == 'tree':
54 self.__tree = field[1]
55 elif field[0] == 'parent':
56 self.__parents.append(field[1])
57 if field[0] == 'author':
58 self.__author = field[1]
59 if field[0] == 'committer':
60 self.__committer = field[1]
61 self.__log = ''.join(lines[i+1:])
63 def get_id_hash(self):
70 return self.__parents[0]
72 def get_parents(self):
78 def get_committer(self):
79 return self.__committer
84 # dictionary of Commit objects, used to avoid multiple calls to git
90 def get_commit(id_hash):
91 """Commit objects factory. Save/look-up them in the __commits
96 if id_hash in __commits:
97 return __commits[id_hash]
99 commit = Commit(id_hash)
100 __commits[id_hash] = commit
104 """Return the list of file conflicts
106 conflicts_file = os.path.join(base_dir, 'conflicts')
107 if os.path.isfile(conflicts_file):
108 f = file(conflicts_file)
109 names = [line.strip() for line in f.readlines()]
115 def _input(cmd, file_desc):
116 p = popen2.Popen3(cmd, True)
118 line = file_desc.readline()
121 p.tochild.write(line)
124 raise GitException, '%s failed' % str(cmd)
127 p=popen2.Popen3(cmd, True)
128 output = p.fromchild.read()
130 raise GitException, '%s failed' % str(cmd)
133 def _output_one_line(cmd, file_desc = None):
134 p=popen2.Popen3(cmd, True)
135 if file_desc != None:
136 for line in file_desc:
137 p.tochild.write(line)
139 output = p.fromchild.readline().strip()
141 raise GitException, '%s failed' % str(cmd)
144 def _output_lines(cmd):
145 p=popen2.Popen3(cmd, True)
146 lines = p.fromchild.readlines()
148 raise GitException, '%s failed' % str(cmd)
151 def __run(cmd, args=None):
152 """__run: runs cmd using spawnvp.
154 Runs cmd using spawnvp. The shell is avoided so it won't mess up
155 our arguments. If args is very large, the command is run multiple
156 times; args is split xargs style: cmd is passed on each
157 invocation. Unlike xargs, returns immediately if any non-zero
158 return code is received.
164 for i in range(0, len(args)+1, 100):
165 r=os.spawnvp(os.P_WAIT, args_l[0], args_l + args[i:min(i+100, len(args))])
170 def __check_base_dir():
171 return os.path.isdir(base_dir)
173 def __tree_status(files = None, tree_id = 'HEAD', unknown = False,
175 """Returns a list of pairs - [status, filename]
185 exclude_file = os.path.join(base_dir, 'info', 'exclude')
186 base_exclude = ['--exclude=%s' % s for s in
187 ['*.[ao]', '*.pyc', '.*', '*~', '#*', 'TAGS', 'tags']]
188 base_exclude.append('--exclude-per-directory=.gitignore')
190 if os.path.exists(exclude_file):
191 extra_exclude = ['--exclude-from=%s' % exclude_file]
195 extra_exclude = base_exclude = []
197 lines = _output_lines(['git-ls-files', '--others'] + base_exclude
199 cache_files += [('?', line.strip()) for line in lines]
202 conflicts = get_conflicts()
205 cache_files += [('C', filename) for filename in conflicts]
208 for line in _output_lines(['git-diff-index', '-r', tree_id] + files):
209 fs = tuple(line.rstrip().split(' ',4)[-1].split('\t',1))
210 if fs[1] not in conflicts:
211 cache_files.append(fs)
216 """Return true if there are local changes in the tree
218 return len(__tree_status()) != 0
224 """Verifies the HEAD and returns the SHA1 id that represents it
229 __head = rev_parse('HEAD')
233 """Returns the name of the file pointed to by the HEAD link
235 return os.path.basename(_output_one_line('git-symbolic-ref HEAD'))
237 def set_head_file(ref):
238 """Resets HEAD to point to a new ref
240 # head cache flushing is needed since we might have a different value
243 if __run('git-symbolic-ref HEAD', [ref]) != 0:
244 raise GitException, 'Could not set head to "%s"' % ref
247 """Sets the HEAD value
251 if not __head or __head != val:
252 if __run('git-update-ref HEAD', [val]) != 0:
253 raise GitException, 'Could not update HEAD to "%s".' % val
256 def __clear_head_cache():
257 """Sets the __head to None so that a re-read is forced
264 """Refresh index with stat() information from the working directory.
266 __run('git-update-index -q --unmerged --refresh')
268 def rev_parse(git_id):
269 """Parse the string and return a verified SHA1 id
272 return _output_one_line(['git-rev-parse', '--verify', git_id])
274 raise GitException, 'Unknown revision: %s' % git_id
276 def branch_exists(branch):
277 """Existance check for the named branch
279 for line in _output_lines(['git-rev-parse', '--symbolic', '--all']):
280 if line.strip() == branch:
284 def create_branch(new_branch, tree_id = None):
285 """Create a new branch in the git repository
287 new_head = os.path.join('refs', 'heads', new_branch)
288 if branch_exists(new_head):
289 raise GitException, 'Branch "%s" already exists' % new_branch
291 current_head = get_head()
292 set_head_file(new_head)
293 __set_head(current_head)
295 # a checkout isn't needed if new branch points to the current head
299 if os.path.isfile(os.path.join(base_dir, 'MERGE_HEAD')):
300 os.remove(os.path.join(base_dir, 'MERGE_HEAD'))
302 def switch_branch(name):
303 """Switch to a git branch
307 new_head = os.path.join('refs', 'heads', name)
308 if not branch_exists(new_head):
309 raise GitException, 'Branch "%s" does not exist' % name
311 tree_id = rev_parse(new_head + '^0')
312 if tree_id != get_head():
314 if __run('git-read-tree -u -m', [get_head(), tree_id]) != 0:
315 raise GitException, 'git-read-tree failed (local changes maybe?)'
317 set_head_file(new_head)
319 if os.path.isfile(os.path.join(base_dir, 'MERGE_HEAD')):
320 os.remove(os.path.join(base_dir, 'MERGE_HEAD'))
322 def delete_branch(name):
323 """Delete a git branch
325 branch_head = os.path.join('refs', 'heads', name)
326 if not branch_exists(branch_head):
327 raise GitException, 'Branch "%s" does not exist' % name
328 os.remove(os.path.join(base_dir, branch_head))
330 def rename_branch(from_name, to_name):
331 """Rename a git branch
333 from_head = os.path.join('refs', 'heads', from_name)
334 if not branch_exists(from_head):
335 raise GitException, 'Branch "%s" does not exist' % from_name
336 to_head = os.path.join('refs', 'heads', to_name)
337 if branch_exists(to_head):
338 raise GitException, 'Branch "%s" already exists' % to_name
340 if get_head_file() == from_name:
341 set_head_file(to_head)
342 os.rename(os.path.join(base_dir, from_head), os.path.join(base_dir, to_head))
345 """Add the files or recursively add the directory contents
347 # generate the file list
350 if not os.path.exists(i):
351 raise GitException, 'Unknown file or directory: %s' % i
354 # recursive search. We only add files
355 for root, dirs, local_files in os.walk(i):
356 for name in [os.path.join(root, f) for f in local_files]:
357 if os.path.isfile(name):
358 files.append(os.path.normpath(name))
359 elif os.path.isfile(i):
360 files.append(os.path.normpath(i))
362 raise GitException, '%s is not a file or directory' % i
365 if __run('git-update-index --add --', files):
366 raise GitException, 'Unable to add file'
368 def rm(files, force = False):
369 """Remove a file from the repository
373 if os.path.exists(f):
374 raise GitException, '%s exists. Remove it first' %f
376 __run('git-update-index --remove --', files)
379 __run('git-update-index --force-remove --', files)
381 def update_cache(files = None, force = False):
382 """Update the cache information for the given files
387 cache_files = __tree_status(files)
389 # everything is up-to-date
390 if len(cache_files) == 0:
393 # check for unresolved conflicts
394 if not force and [x for x in cache_files
395 if x[0] not in ['M', 'N', 'A', 'D']]:
396 raise GitException, 'Updating cache failed: unresolved conflicts'
399 add_files = [x[1] for x in cache_files if x[0] in ['N', 'A']]
400 rm_files = [x[1] for x in cache_files if x[0] in ['D']]
401 m_files = [x[1] for x in cache_files if x[0] in ['M']]
403 if add_files and __run('git-update-index --add --', add_files) != 0:
404 raise GitException, 'Failed git-update-index --add'
405 if rm_files and __run('git-update-index --force-remove --', rm_files) != 0:
406 raise GitException, 'Failed git-update-index --rm'
407 if m_files and __run('git-update-index --', m_files) != 0:
408 raise GitException, 'Failed git-update-index'
412 def commit(message, files = None, parents = None, allowempty = False,
413 cache_update = True, tree_id = None,
414 author_name = None, author_email = None, author_date = None,
415 committer_name = None, committer_email = None):
416 """Commit the current tree to repository
423 # Get the tree status
424 if cache_update and parents != []:
425 changes = update_cache(files)
426 if not changes and not allowempty:
427 raise GitException, 'No changes to commit'
429 # get the commit message
430 if message[-1:] != '\n':
434 # write the index to repository
436 tree_id = _output_one_line('git-write-tree')
443 cmd += 'GIT_AUTHOR_NAME="%s" ' % author_name
445 cmd += 'GIT_AUTHOR_EMAIL="%s" ' % author_email
447 cmd += 'GIT_AUTHOR_DATE="%s" ' % author_date
449 cmd += 'GIT_COMMITTER_NAME="%s" ' % committer_name
451 cmd += 'GIT_COMMITTER_EMAIL="%s" ' % committer_email
452 cmd += 'git-commit-tree %s' % tree_id
458 commit_id = _output_one_line(cmd, message)
460 __set_head(commit_id)
464 def apply_diff(rev1, rev2):
465 """Apply the diff between rev1 and rev2 onto the current
466 index. This function doesn't need to raise an exception since it
467 is only used for fast-pushing a patch. If this operation fails,
468 the pushing would fall back to the three-way merge.
470 return os.system('git-diff-tree -p %s %s | git-apply --index 2> /dev/null'
473 def merge(base, head1, head2):
474 """Perform a 3-way merge between base, head1 and head2 into the
478 if __run('git-read-tree -u -m', [base, head1, head2]) != 0:
479 raise GitException, 'git-read-tree failed (local changes maybe?)'
481 # this can fail if there are conflicts
482 if __run('git-merge-index -o -q gitmergeonefile.py -a') != 0:
483 raise GitException, 'git-merge-index failed (possible conflicts)'
485 def status(files = None, modified = False, new = False, deleted = False,
486 conflict = False, unknown = False, noexclude = False):
487 """Show the tree status
492 cache_files = __tree_status(files, unknown = True, noexclude = noexclude)
493 all = not (modified or new or deleted or conflict or unknown)
508 cache_files = [x for x in cache_files if x[0] in filestat]
510 for fs in cache_files:
512 print '%s %s' % (fs[0], fs[1])
516 def diff(files = None, rev1 = 'HEAD', rev2 = None, out_fd = None):
517 """Show the diff between rev1 and rev2
523 diff_str = _output(['git-diff-tree', '-p', rev1, rev2] + files)
527 diff_str = _output(['git-diff-index', '-p', '-R', rev2] + files)
529 diff_str = _output(['git-diff-index', '-p', rev1] + files)
534 out_fd.write(diff_str)
538 def diffstat(files = None, rev1 = 'HEAD', rev2 = None):
539 """Return the diffstat between rev1 and rev2
544 p=popen2.Popen3('git-apply --stat')
545 diff(files, rev1, rev2, p.tochild)
547 diff_str = p.fromchild.read().rstrip()
549 raise GitException, 'git.diffstat failed'
552 def files(rev1, rev2):
553 """Return the files modified between rev1 and rev2
557 for line in _output_lines('git-diff-tree -r %s %s' % (rev1, rev2)):
558 result += '%s %s\n' % tuple(line.rstrip().split(' ',4)[-1].split('\t',1))
560 return result.rstrip()
562 def barefiles(rev1, rev2):
563 """Return the files modified between rev1 and rev2, without status info
567 for line in _output_lines('git-diff-tree -r %s %s' % (rev1, rev2)):
568 result += '%s\n' % line.rstrip().split(' ',4)[-1].split('\t',1)[-1]
570 return result.rstrip()
572 def checkout(files = None, tree_id = None, force = False):
573 """Check out the given or all files
578 if tree_id and __run('git-read-tree -m', [tree_id]) != 0:
579 raise GitException, 'Failed git-read-tree -m %s' % tree_id
581 checkout_cmd = 'git-checkout-index -q -u'
583 checkout_cmd += ' -f'
585 checkout_cmd += ' -a'
587 checkout_cmd += ' --'
589 if __run(checkout_cmd, files) != 0:
590 raise GitException, 'Failed git-checkout-index'
593 """Switch the tree to the given id
596 if __run('git-read-tree -u -m', [get_head(), tree_id]) != 0:
597 raise GitException, 'git-read-tree failed (local changes maybe?)'
601 def reset(tree_id = None):
602 """Revert the tree changes relative to the given tree_id. It removes
608 cache_files = __tree_status(tree_id = tree_id)
609 rm_files = [x[1] for x in cache_files if x[0] in ['D']]
611 checkout(tree_id = tree_id, force = True)
614 # checkout doesn't remove files
615 map(os.remove, rm_files)
617 def pull(repository = 'origin', refspec = None):
618 """Pull changes from the remote repository. At the moment, just
619 use the 'git pull' command
621 # 'git pull' updates the HEAD
628 if __run('git pull', args) != 0:
629 raise GitException, 'Failed "git pull %s"' % repository
631 def apply_patch(filename = None, base = None):
632 """Apply a patch onto the current or given index. There must not
633 be any local changes in the tree, otherwise the command fails
637 return __run('git-apply --index', [filename]) == 0
640 _input('git-apply --index', sys.stdin)
646 orig_head = get_head()
649 refresh_index() # needed since __apply_patch() doesn't do it
651 if not __apply_patch():
654 raise GitException, 'Patch does not apply cleanly'
656 top = commit(message = 'temporary commit used for applying a patch',
659 merge(base, orig_head, top)
661 def clone(repository, local_dir):
662 """Clone a remote repository. At the moment, just use the
665 if __run('git clone', [repository, local_dir]) != 0:
666 raise GitException, 'Failed "git clone %s %s"' \
667 % (repository, local_dir)
669 def modifying_revs(files, base_rev):
670 """Return the revisions from the list modifying the given files
672 cmd = ['git-rev-list', '%s..' % base_rev, '--']
673 revs = [line.strip() for line in _output_lines(cmd + files)]