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):
35 """Handle the commit objects
37 def __init__(self, id_hash):
38 self.__id_hash = id_hash
40 lines = _output_lines('git-cat-file commit %s' % id_hash)
42 for i in range(len(lines)):
46 field = line.strip().split(' ', 1)
47 if field[0] == 'tree':
48 self.__tree = field[1]
49 elif field[0] == 'parent':
50 self.__parents.append(field[1])
51 if field[0] == 'author':
52 self.__author = field[1]
53 if field[0] == 'committer':
54 self.__committer = field[1]
55 self.__log = ''.join(lines[i+1:])
57 def get_id_hash(self):
64 return self.__parents[0]
66 def get_parents(self):
72 def get_committer(self):
73 return self.__committer
78 # dictionary of Commit objects, used to avoid multiple calls to git
86 """Different start-up variables read from the environment
88 if 'GIT_DIR' in os.environ:
89 return os.environ['GIT_DIR']
91 return _output_one_line('git-rev-parse --git-dir')
93 def get_commit(id_hash):
94 """Commit objects factory. Save/look-up them in the __commits
99 if id_hash in __commits:
100 return __commits[id_hash]
102 commit = Commit(id_hash)
103 __commits[id_hash] = commit
107 """Return the list of file conflicts
109 conflicts_file = os.path.join(get_base_dir(), 'conflicts')
110 if os.path.isfile(conflicts_file):
111 f = file(conflicts_file)
112 names = [line.strip() for line in f.readlines()]
118 def _input(cmd, file_desc):
119 p = popen2.Popen3(cmd, True)
121 line = file_desc.readline()
124 p.tochild.write(line)
127 raise GitException, '%s failed' % str(cmd)
130 p=popen2.Popen3(cmd, True)
131 output = p.fromchild.read()
133 raise GitException, '%s failed' % str(cmd)
136 def _output_one_line(cmd, file_desc = None):
137 p=popen2.Popen3(cmd, True)
138 if file_desc != None:
139 for line in file_desc:
140 p.tochild.write(line)
142 output = p.fromchild.readline().strip()
144 raise GitException, '%s failed' % str(cmd)
147 def _output_lines(cmd):
148 p=popen2.Popen3(cmd, True)
149 lines = p.fromchild.readlines()
151 raise GitException, '%s failed' % str(cmd)
154 def __run(cmd, args=None):
155 """__run: runs cmd using spawnvp.
157 Runs cmd using spawnvp. The shell is avoided so it won't mess up
158 our arguments. If args is very large, the command is run multiple
159 times; args is split xargs style: cmd is passed on each
160 invocation. Unlike xargs, returns immediately if any non-zero
161 return code is received.
167 for i in range(0, len(args)+1, 100):
168 r=os.spawnvp(os.P_WAIT, args_l[0], args_l + args[i:min(i+100, len(args))])
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(get_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', 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 # only allow SHA1 hashes
257 assert(len(__head) == 40)
259 def __clear_head_cache():
260 """Sets the __head to None so that a re-read is forced
267 """Refresh index with stat() information from the working directory.
269 __run('git-update-index -q --unmerged --refresh')
271 def rev_parse(git_id):
272 """Parse the string and return a verified SHA1 id
275 return _output_one_line(['git-rev-parse', '--verify', git_id])
277 raise GitException, 'Unknown revision: %s' % git_id
279 def branch_exists(branch):
280 """Existence check for the named branch
282 for line in _output_lines(['git-rev-parse', '--symbolic', '--all']):
283 if line.strip() == branch:
287 def create_branch(new_branch, tree_id = None):
288 """Create a new branch in the git repository
290 new_head = os.path.join('refs', 'heads', new_branch)
291 if branch_exists(new_head):
292 raise GitException, 'Branch "%s" already exists' % new_branch
294 current_head = get_head()
295 set_head_file(new_head)
296 __set_head(current_head)
298 # a checkout isn't needed if new branch points to the current head
302 if os.path.isfile(os.path.join(get_base_dir(), 'MERGE_HEAD')):
303 os.remove(os.path.join(get_base_dir(), 'MERGE_HEAD'))
305 def switch_branch(name):
306 """Switch to a git branch
310 new_head = os.path.join('refs', 'heads', name)
311 if not branch_exists(new_head):
312 raise GitException, 'Branch "%s" does not exist' % name
314 tree_id = rev_parse(new_head + '^{commit}')
315 if tree_id != get_head():
317 if __run('git-read-tree -u -m', [get_head(), tree_id]) != 0:
318 raise GitException, 'git-read-tree failed (local changes maybe?)'
320 set_head_file(new_head)
322 if os.path.isfile(os.path.join(get_base_dir(), 'MERGE_HEAD')):
323 os.remove(os.path.join(get_base_dir(), 'MERGE_HEAD'))
325 def delete_branch(name):
326 """Delete a git branch
328 branch_head = os.path.join('refs', 'heads', name)
329 if not branch_exists(branch_head):
330 raise GitException, 'Branch "%s" does not exist' % name
331 os.remove(os.path.join(get_base_dir(), branch_head))
333 def rename_branch(from_name, to_name):
334 """Rename a git branch
336 from_head = os.path.join('refs', 'heads', from_name)
337 if not branch_exists(from_head):
338 raise GitException, 'Branch "%s" does not exist' % from_name
339 to_head = os.path.join('refs', 'heads', to_name)
340 if branch_exists(to_head):
341 raise GitException, 'Branch "%s" already exists' % to_name
343 if get_head_file() == from_name:
344 set_head_file(to_head)
345 os.rename(os.path.join(get_base_dir(), from_head), \
346 os.path.join(get_base_dir(), to_head))
349 """Add the files or recursively add the directory contents
351 # generate the file list
354 if not os.path.exists(i):
355 raise GitException, 'Unknown file or directory: %s' % i
358 # recursive search. We only add files
359 for root, dirs, local_files in os.walk(i):
360 for name in [os.path.join(root, f) for f in local_files]:
361 if os.path.isfile(name):
362 files.append(os.path.normpath(name))
363 elif os.path.isfile(i):
364 files.append(os.path.normpath(i))
366 raise GitException, '%s is not a file or directory' % i
369 if __run('git-update-index --add --', files):
370 raise GitException, 'Unable to add file'
372 def rm(files, force = False):
373 """Remove a file from the repository
377 if os.path.exists(f):
378 raise GitException, '%s exists. Remove it first' %f
380 __run('git-update-index --remove --', files)
383 __run('git-update-index --force-remove --', files)
385 def update_cache(files = None, force = False):
386 """Update the cache information for the given files
391 cache_files = __tree_status(files)
393 # everything is up-to-date
394 if len(cache_files) == 0:
397 # check for unresolved conflicts
398 if not force and [x for x in cache_files
399 if x[0] not in ['M', 'N', 'A', 'D']]:
400 raise GitException, 'Updating cache failed: unresolved conflicts'
403 add_files = [x[1] for x in cache_files if x[0] in ['N', 'A']]
404 rm_files = [x[1] for x in cache_files if x[0] in ['D']]
405 m_files = [x[1] for x in cache_files if x[0] in ['M']]
407 if add_files and __run('git-update-index --add --', add_files) != 0:
408 raise GitException, 'Failed git-update-index --add'
409 if rm_files and __run('git-update-index --force-remove --', rm_files) != 0:
410 raise GitException, 'Failed git-update-index --rm'
411 if m_files and __run('git-update-index --', m_files) != 0:
412 raise GitException, 'Failed git-update-index'
416 def commit(message, files = None, parents = None, allowempty = False,
417 cache_update = True, tree_id = None,
418 author_name = None, author_email = None, author_date = None,
419 committer_name = None, committer_email = None):
420 """Commit the current tree to repository
427 # Get the tree status
428 if cache_update and parents != []:
429 changes = update_cache(files)
430 if not changes and not allowempty:
431 raise GitException, 'No changes to commit'
433 # get the commit message
434 if message[-1:] != '\n':
438 # write the index to repository
440 tree_id = _output_one_line('git-write-tree')
447 cmd += 'GIT_AUTHOR_NAME="%s" ' % author_name
449 cmd += 'GIT_AUTHOR_EMAIL="%s" ' % author_email
451 cmd += 'GIT_AUTHOR_DATE="%s" ' % author_date
453 cmd += 'GIT_COMMITTER_NAME="%s" ' % committer_name
455 cmd += 'GIT_COMMITTER_EMAIL="%s" ' % committer_email
456 cmd += 'git-commit-tree %s' % tree_id
462 commit_id = _output_one_line(cmd, message)
464 __set_head(commit_id)
468 def apply_diff(rev1, rev2, check_index = True):
469 """Apply the diff between rev1 and rev2 onto the current
470 index. This function doesn't need to raise an exception since it
471 is only used for fast-pushing a patch. If this operation fails,
472 the pushing would fall back to the three-way merge.
475 index_opt = '--index'
478 cmd = 'git-diff-tree -p %s %s | git-apply %s 2> /dev/null' \
479 % (rev1, rev2, index_opt)
481 return os.system(cmd) == 0
483 def merge(base, head1, head2):
484 """Perform a 3-way merge between base, head1 and head2 into the
488 if __run('git-read-tree -u -m', [base, head1, head2]) != 0:
489 raise GitException, 'git-read-tree failed (local changes maybe?)'
491 # this can fail if there are conflicts
492 if __run('git-merge-index -o -q gitmergeonefile.py -a') != 0:
493 raise GitException, 'git-merge-index failed (possible conflicts)'
495 def status(files = None, modified = False, new = False, deleted = False,
496 conflict = False, unknown = False, noexclude = False):
497 """Show the tree status
502 cache_files = __tree_status(files, unknown = True, noexclude = noexclude)
503 all = not (modified or new or deleted or conflict or unknown)
518 cache_files = [x for x in cache_files if x[0] in filestat]
520 for fs in cache_files:
522 print '%s %s' % (fs[0], fs[1])
526 def diff(files = None, rev1 = 'HEAD', rev2 = None, out_fd = None):
527 """Show the diff between rev1 and rev2
533 diff_str = _output(['git-diff-tree', '-p', rev1, rev2] + files)
537 diff_str = _output(['git-diff-index', '-p', '-R', rev2] + files)
539 diff_str = _output(['git-diff-index', '-p', rev1] + files)
544 out_fd.write(diff_str)
548 def diffstat(files = None, rev1 = 'HEAD', rev2 = None):
549 """Return the diffstat between rev1 and rev2
554 p=popen2.Popen3('git-apply --stat')
555 diff(files, rev1, rev2, p.tochild)
557 diff_str = p.fromchild.read().rstrip()
559 raise GitException, 'git.diffstat failed'
562 def files(rev1, rev2):
563 """Return the files modified between rev1 and rev2
567 for line in _output_lines('git-diff-tree -r %s %s' % (rev1, rev2)):
568 result += '%s %s\n' % tuple(line.rstrip().split(' ',4)[-1].split('\t',1))
570 return result.rstrip()
572 def barefiles(rev1, rev2):
573 """Return the files modified between rev1 and rev2, without status info
577 for line in _output_lines('git-diff-tree -r %s %s' % (rev1, rev2)):
578 result += '%s\n' % line.rstrip().split(' ',4)[-1].split('\t',1)[-1]
580 return result.rstrip()
582 def checkout(files = None, tree_id = None, force = False):
583 """Check out the given or all files
588 if tree_id and __run('git-read-tree -m', [tree_id]) != 0:
589 raise GitException, 'Failed git-read-tree -m %s' % tree_id
591 checkout_cmd = 'git-checkout-index -q -u'
593 checkout_cmd += ' -f'
595 checkout_cmd += ' -a'
597 checkout_cmd += ' --'
599 if __run(checkout_cmd, files) != 0:
600 raise GitException, 'Failed git-checkout-index'
603 """Switch the tree to the given id
606 if __run('git-read-tree -u -m', [get_head(), tree_id]) != 0:
607 raise GitException, 'git-read-tree failed (local changes maybe?)'
611 def reset(files = None, tree_id = None):
612 """Revert the tree changes relative to the given tree_id. It removes
618 checkout(files, tree_id, True)
620 # if the reset refers to the whole tree, switch the HEAD as well
624 def pull(repository = 'origin', refspec = None):
625 """Pull changes from the remote repository. At the moment, just
626 use the 'git pull' command
628 # 'git pull' updates the HEAD
635 if __run('git pull', args) != 0:
636 raise GitException, 'Failed "git pull %s"' % repository
638 def apply_patch(filename = None, base = None):
639 """Apply a patch onto the current or given index. There must not
640 be any local changes in the tree, otherwise the command fails
644 return __run('git-apply --index', [filename]) == 0
647 _input('git-apply --index', sys.stdin)
653 orig_head = get_head()
656 refresh_index() # needed since __apply_patch() doesn't do it
658 if not __apply_patch():
661 raise GitException, 'Patch does not apply cleanly'
663 top = commit(message = 'temporary commit used for applying a patch',
666 merge(base, orig_head, top)
668 def clone(repository, local_dir):
669 """Clone a remote repository. At the moment, just use the
672 if __run('git clone', [repository, local_dir]) != 0:
673 raise GitException, 'Failed "git clone %s %s"' \
674 % (repository, local_dir)
676 def modifying_revs(files, base_rev):
677 """Return the revisions from the list modifying the given files
679 cmd = ['git-rev-list', '%s..' % base_rev, '--']
680 revs = [line.strip() for line in _output_lines(cmd + files)]