Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit8fbe7ee

Browse files
committed
Add 'sshkey' context manager
1 parentd850976 commit8fbe7ee

File tree

3 files changed

+92
-3
lines changed

3 files changed

+92
-3
lines changed

‎doc/source/tutorial.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,12 @@ You can easily access configuration information for a remote by accessing option
330330
Change configuration for a specific remote only::
331331
332332
o.config_writer.set("pushurl", "other_url")
333+
334+
You can also specify an SSH key to use for any operations on the remotes:
335+
336+
private_key_file = project_dir+'id_rsa_deployment_key'
337+
with repo.git.sshkey(private_key_file):
338+
o.fetch()
333339

334340

335341
Submodule Handling

‎git/cmd.py

Lines changed: 77 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,21 @@
55
# the BSD License: http://www.opensource.org/licenses/bsd-license.php
66

77
importos
8+
importos.path
89
importsys
910
importselect
1011
importlogging
1112
importthreading
1213
importerrno
1314
importmmap
1415

16+
fromcontextlibimportcontextmanager
1517
fromsubprocessimport (
1618
call,
1719
Popen,
1820
PIPE
1921
)
2022

21-
2223
from .utilimport (
2324
LazyMixin,
2425
stream_copy,
@@ -223,7 +224,7 @@ class Git(LazyMixin):
223224
Set its value to 'full' to see details about the returned values.
224225
"""
225226
__slots__= ("_working_dir","cat_file_all","cat_file_header","_version_info",
226-
"_git_options")
227+
"_git_options","_environment")
227228

228229
# CONFIGURATION
229230
# The size in bytes read from stdout when copying git's output to another stream
@@ -295,7 +296,8 @@ def wait(self):
295296
:raise GitCommandError: if the return status is not 0"""
296297
status=self.proc.wait()
297298
ifstatus!=0:
298-
raiseGitCommandError(self.args,status,self.proc.stderr.read().decode(defenc))
299+
error_output=self.proc.stderr.read().decode(defenc)
300+
raiseGitCommandError(self.args,status,error_output)
299301
# END status handling
300302
returnstatus
301303
# END auto interrupt
@@ -413,6 +415,9 @@ def __init__(self, working_dir=None):
413415
self._working_dir=working_dir
414416
self._git_options= ()
415417

418+
# Extra environment variables to pass to git commands
419+
self._environment= {}
420+
416421
# cached command slots
417422
self.cat_file_header=None
418423
self.cat_file_all=None
@@ -536,6 +541,8 @@ def execute(self, command,
536541
# Start the process
537542
env=os.environ.copy()
538543
env["LC_MESSAGES"]="C"
544+
env.update(self._environment)
545+
539546
proc=Popen(command,
540547
env=env,
541548
cwd=cwd,
@@ -603,6 +610,73 @@ def execute(self, command,
603610
else:
604611
returnstdout_value
605612

613+
defset_environment(self,**kwargs):
614+
"""
615+
Set environment variables for future git invocations. Return all changed
616+
values in a format that can be passed back into this function to revert
617+
the changes:
618+
619+
``Examples``::
620+
621+
old_env = self.set_environment(PWD='/tmp')
622+
self.set_environment(**old_env)
623+
624+
:param kwargs: environment variables to use for git processes
625+
:return: dict that maps environment variables to their old values
626+
"""
627+
old_env= {}
628+
forkey,valueinkwargs.iteritems():
629+
# set value if it is None
630+
ifvalueisnotNone:
631+
ifkeyinself._environment:
632+
old_env[key]=self._environment[key]
633+
else:
634+
old_env[key]=None
635+
self._environment[key]=value
636+
# remove key from environment if its value is None
637+
elifkeyinself._environment:
638+
old_env[key]=self._environment[key]
639+
delself._environment[key]
640+
returnold_env
641+
642+
@contextmanager
643+
defenvironment(self,**kwargs):
644+
"""
645+
A context manager around the above set_environment to restore the
646+
environment back to its previous state after operation.
647+
648+
``Examples``::
649+
650+
with self.environment(GIT_SSH='/bin/ssh_wrapper'):
651+
repo.remotes.origin.fetch()
652+
653+
:param kwargs: see set_environment
654+
"""
655+
old_env=self.set_environment(**kwargs)
656+
try:
657+
yield
658+
finally:
659+
self.set_environment(**old_env)
660+
661+
@contextmanager
662+
defsshkey(self,sshkey_file):
663+
"""
664+
A context manager to temporarily set an SSH key for all operations that
665+
run inside it.
666+
667+
``Examples``::
668+
669+
with self.environment(GIT_SSH=project_dir+'deployment_key'):
670+
repo.remotes.origin.fetch()
671+
672+
:param sshkey_file: Path to a private SSH key file
673+
"""
674+
this_dir=os.path.dirname(__file__)
675+
ssh_wrapper=os.path.join(this_dir,'..','scripts','ssh_wrapper.py')
676+
677+
withself.environment(GIT_SSH_KEY_FILE=sshkey_file,GIT_SSH=ssh_wrapper):
678+
yield
679+
606680
deftransform_kwargs(self,split_single_char_options=False,**kwargs):
607681
"""Transforms Python style kwargs into git command line options."""
608682
args=list()

‎scripts/ssh_wrapper.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/usr/bin/env python
2+
3+
importos
4+
importsubprocess
5+
importsys
6+
7+
ssh_options= ['-i',os.environ['GIT_SSH_KEY_FILE']]
8+
ret_code=subprocess.call(['ssh']+ssh_options+sys.argv[1:])
9+
sys.exit(ret_code)

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp