summaryrefslogtreecommitdiff
path: root/lib/git_python/git.py
blob: c66d94618103a91abd96db3c1731ad9298b67726 (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
79
80
81
82
83
84
85
86
87
88
89
import os
import subprocess
import re
from utils import *
from method_missing import MethodMissingMixin

# Enables debugging of GitPython's git commands
GIT_PYTHON_TRACE = os.environ.get("GIT_PYTHON_TRACE", False)

class Git(MethodMissingMixin):
    """
    The Git class manages communication with the Git binary
    """
    def __init__(self, git_dir):
        super(Git, self).__init__()
        self.git_dir = git_dir

    @property
    def get_dir(self):
        return self.git_dir

    def execute(self, command):
        """
        Handles executing the command on the shell and consumes and returns
        the returned information (stdout)

        ``command``
            The command to execute
        """

        if GIT_PYTHON_TRACE:
            print command

        proc = subprocess.Popen(command,
                                cwd = self.git_dir,
                                stdout=subprocess.PIPE
                                )
        proc.wait()
        stdout_value = proc.stdout.read()
        proc.stdout.close()
        return stdout_value

    def transform_kwargs(self, **kwargs):
        """
        Transforms Python style kwargs into git command line options.
        """
        args = []
        for k, v in kwargs.items():
            if len(k) == 1:
                if v is True:
                    args.append("-%s" % k)
                else:
                    args.append("-%s%s" % (k, v))
            else:
                if v is True:
                    args.append("--%s" % dashify(k))
                else:
                    args.append("--%s=%s" % (dashify(k), v))
        return args

    def method_missing(self, method, *args, **kwargs):
        """
        Run the given git command with the specified arguments and return
        the result as a String

        ``method``
            is the command

        ``args``
            is the list of arguments

        ``kwargs``
            is a dict of keyword arguments

        Examples
            git.rev_list('master', max_count=10, header=True)

        Returns
            str
        """
        opt_args = self.transform_kwargs(**kwargs)
        ext_args = map(lambda a: (a == '--') and a or "%s" % a, args)
        args = opt_args + ext_args

        call = ["git", dashify(method)]
        call.extend(args)

        stdout_value = self.execute(call)
        return stdout_value