1 # -*- coding: utf-8 -*-
4 Copyright (C) 2007, Karl Hasselström <kha@treskal.com>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License version 2 as
8 published by the Free Software Foundation.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 import datetime
, os
, subprocess
22 from stgit
.out
import *
24 class RunException(Exception):
25 """Thrown when something bad happened when we tried to run the
29 _all_log_modes
= ['debug', 'profile']
30 _log_mode
= os
.environ
.get('STGIT_SUBPROCESS_LOG', '')
31 if _log_mode
and not _log_mode
in _all_log_modes
:
32 out
.warn(('Unknown log mode "%s" specified in $STGIT_SUBPROCESS_LOG.'
34 'Valid values are: %s' %
', '.join(_all_log_modes
))
38 def __init__(self
, *cmd
):
39 self
.__cmd
= list(cmd
)
42 raise Exception, 'Bad command: %r' % cmd
43 self
.__good_retvals
= [0]
46 self
.__discard_stderr
= False
47 def __log_start(self
):
48 if _log_mode
== 'debug':
49 out
.start('Running subprocess %s' % self
.__cmd
)
50 elif _log_mode
== 'profile':
51 out
.start('Running subprocess %s' % self
.__cmd
[0])
52 self
.__starttime
= datetime
.datetime
.now()
53 def __log_end(self
, retcode
):
54 if _log_mode
== 'debug':
55 out
.done('return code: %d' % retcode
)
56 elif _log_mode
== 'profile':
57 duration
= datetime
.datetime
.now() - self
.__starttime
58 out
.done('%1.3f s' %
(duration
.microseconds
/1e6
+ duration
.seconds
))
59 def __check_exitcode(self
):
60 if self
.exitcode
not in self
.__good_retvals
:
61 raise self
.exc('%s failed with code %d'
62 %
(self
.__cmd
[0], self
.exitcode
))
64 """Run with captured IO."""
67 p
= subprocess
.Popen(self
.__cmd
, env
= self
.__env
,
68 stdin
= subprocess
.PIPE
,
69 stdout
= subprocess
.PIPE
,
70 stderr
= subprocess
.PIPE
)
71 outdata
, errdata
= p
.communicate(self
.__indata
)
72 self
.exitcode
= p
.returncode
74 raise self
.exc('%s failed: %s' %
(self
.__cmd
[0], e
))
75 if errdata
and not self
.__discard_stderr
:
77 self
.__log_end(self
.exitcode
)
78 self
.__check_exitcode()
81 """Run without captured IO."""
82 assert self
.__indata
== None
85 p
= subprocess
.Popen(self
.__cmd
, env
= self
.__env
)
86 self
.exitcode
= p
.wait()
88 raise self
.exc('%s failed: %s' %
(self
.__cmd
[0], e
))
89 self
.__log_end(self
.exitcode
)
90 self
.__check_exitcode()
91 def returns(self
, retvals
):
92 self
.__good_retvals
= retvals
94 def discard_stderr(self
, discard
= True):
95 self
.__discard_stderr
= discard
98 self
.__env
= dict(os
.environ
)
99 self
.__env
.update(env
)
101 def raw_input(self
, indata
):
102 self
.__indata
= indata
104 def input_lines(self
, lines
):
105 self
.__indata
= ''.join(['%s\n' % line
for line
in lines
])
108 outdata
= self
.__run_io()
110 raise self
.exc
, '%s produced output' % self
.__cmd
[0]
111 def discard_output(self
):
113 def raw_output(self
):
114 return self
.__run_io()
115 def output_lines(self
):
116 outdata
= self
.__run_io()
117 if outdata
.endswith('\n'):
118 outdata
= outdata
[:-1]
120 return outdata
.split('\n')
123 def output_one_line(self
):
124 outlines
= self
.output_lines()
125 if len(outlines
) == 1:
128 raise self
.exc('%s produced %d lines, expected 1'
129 %
(self
.__cmd
[0], len(outlines
)))
131 """Just run, with no IO redirection."""
133 def xargs(self
, xargs
):
134 """Just run, with no IO redirection. The extra arguments are
135 appended to the command line a few at a time; the command is
136 run as many times as needed to consume them all."""
139 for i
in xrange(0, len(xargs
), step
):
140 self
.__cmd
= basecmd
+ xargs
[i
:i
+step
]