checkout: add support for overriding the target directory

Author: carlosmn

pygit2/repository.py

@@ -185,37 +185,46 @@ def _checkout_args_to_options(**kwargs):
         copts = ffi.new('git_checkout_options *')
         check_error(C.git_checkout_init_options(copts, 1))
 
+        # References we need to keep to strings and so forth
+        refs = []
+
         # pygit2's default is SAFE_CREATE
         copts.checkout_strategy = GIT_CHECKOUT_SAFE_CREATE
         # and go through the arguments to see what the user wanted
-        for k, v in kwargs.iteritems():
-            if k == 'strategy':
-                copts.checkout_strategy = v
+        strategy = kwargs.get('strategy')
+        if strategy:
+            copts.checkout_strategy = strategy
+
+        directory = kwargs.get('directory')
+        if directory:
+            target_dir = ffi.new('char[]', to_str(directory))
+            refs.append(target_dir)
+            copts.target_directory = target_dir
 
-        return copts
+        return copts, refs
 
     def checkout_head(self, **kwargs):
         """Checkout HEAD
 
         For arguments, see Repository.checkout().
         """
-        copts = Repository._checkout_args_to_options(**kwargs)
+        copts, refs = Repository._checkout_args_to_options(**kwargs)
         check_error(C.git_checkout_head(self._repo, copts))
 
     def checkout_index(self, **kwargs):
         """Checkout the repository's index
 
         For arguments, see Repository.checkout().
         """
-        copts = Repository._checkout_args_to_options(**kwargs)
+        copts, refs = Repository._checkout_args_to_options(**kwargs)
         check_error(C.git_checkout_index(self._repo, ffi.NULL, copts))
 
     def checkout_tree(self, treeish, **kwargs):
         """Checkout the given treeish
 
         For arguments, see Repository.checkout().
         """
-        copts = Repository._checkout_args_to_options(**kwargs)
+        copts, refs = Repository._checkout_args_to_options(**kwargs)
         cptr = ffi.new('git_object **')
         ffi.buffer(cptr)[:] = treeish._pointer[:]
 
@@ -242,6 +251,8 @@ def checkout(self, refname=None, **kwargs):
         :param int strategy: A ``GIT_CHECKOUT_`` value. The default is
           ``GIT_CHECKOUT_SAFE_CREATE``.
 
+        :param str directory: Alternative checkout path to workdir.
+
         """
 
 

test/test_repository.py

@@ -246,6 +246,14 @@ def test_checkout_head(self):
         self.repo.checkout('HEAD', strategy=pygit2.GIT_CHECKOUT_FORCE)
         self.assertTrue('bye.txt' not in self.repo.status())
 
+    def test_checkout_alternative_dir(self):
+        ref_i18n = self.repo.lookup_reference('refs/heads/i18n')
+        extra_dir = os.path.join(self.repo.workdir, 'extra-dir')
+        os.mkdir(extra_dir)
+        self.assertTrue(len(os.listdir(extra_dir)) == 0)
+        self.repo.checkout(ref_i18n, directory=extra_dir)
+        self.assertFalse(len(os.listdir(extra_dir)) == 0)
+
     def test_merge_base(self):
         commit = self.repo.merge_base(
             '5ebeeebb320790caf276b9fc8b24546d63316533',