aboutsummaryrefslogtreecommitdiff
path: root/git/repo/base.py
blob: 0f86a6bff4753c63d03dcba564658b4ea3293390 (plain)
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
# repo.py
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
#
# This module is part of GitPython and is released under
# the BSD License: http://www.opensource.org/licenses/bsd-license.php

from git.exc import InvalidGitRepositoryError, NoSuchPathError
from git.cmd import Git
from git.util import Actor
from git.refs import *
from git.index import IndexFile
from git.objects import *
from git.config import GitConfigParser
from git.remote import Remote
from git.db.cmd import CmdCompatibilityGitDB 
from git.db.py import PureGitDB


from git.util import (
							join,
							isfile,
							hex_to_bin
						)

from fun import (
					is_git_dir,
					touch
				)

import os
import sys
import re

import warnings

DefaultDBType = PureGitDB
if sys.version_info[1] < 5:		# python 2.4 compatiblity
	DefaultDBType = CmdGitDB
# END handle python 2.4


__all__ = ('Repo', )


class Repo(CmdCompatibilityGitDB):
	"""Represents a git repository and allows you to query references, 
	gather commit information, generate diffs, create and clone repositories query
	the log.
	
	The following attributes are worth using:
	
	'working_dir' is the working directory of the git command, wich is the working tree 
	directory if available or the .git directory in case of bare repositories
	
	'working_tree_dir' is the working tree directory, but will raise AssertionError
	if we are a bare repository.
	
	'git_dir' is the .git repository directoy, which is always set."""
	
	def __init__(self, path=None, odbt = None):
		"""Create a new Repo instance

		:param path: is the path to either the root git directory or the bare git repo::

			repo = Repo("/Users/mtrier/Development/git-python")
			repo = Repo("/Users/mtrier/Development/git-python.git")
			repo = Repo("~/Development/git-python.git")
			repo = Repo("$REPOSITORIES/Development/git-python.git")
		:raise InvalidDBRoot:
		:return: git.Repo """
		if odbt is not None:
			warnings.warn("deprecated use of odbt", DeprecationWarning)
		#END handle old parameter
		super(Repo, self).__init__(path)
		self._git = Git(self.working_dir)
		
	def __repr__(self):
		return '<git.Repo "%s">' % self.git_dir