Show More
@@ -1,223 +1,212 b'' | |||||
1 | """Common utilities for the various process_* implementations. |
|
1 | """Common utilities for the various process_* implementations. | |
2 |
|
2 | |||
3 | This file is only meant to be imported by the platform-specific implementations |
|
3 | This file is only meant to be imported by the platform-specific implementations | |
4 | of subprocess utilities, and it contains tools that are common to all of them. |
|
4 | of subprocess utilities, and it contains tools that are common to all of them. | |
5 | """ |
|
5 | """ | |
6 |
|
6 | |||
7 | #----------------------------------------------------------------------------- |
|
7 | #----------------------------------------------------------------------------- | |
8 | # Copyright (C) 2010-2011 The IPython Development Team |
|
8 | # Copyright (C) 2010-2011 The IPython Development Team | |
9 | # |
|
9 | # | |
10 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | # Distributed under the terms of the BSD License. The full license is in | |
11 | # the file COPYING, distributed as part of this software. |
|
11 | # the file COPYING, distributed as part of this software. | |
12 | #----------------------------------------------------------------------------- |
|
12 | #----------------------------------------------------------------------------- | |
13 |
|
13 | |||
14 | #----------------------------------------------------------------------------- |
|
14 | #----------------------------------------------------------------------------- | |
15 | # Imports |
|
15 | # Imports | |
16 | #----------------------------------------------------------------------------- |
|
16 | #----------------------------------------------------------------------------- | |
17 | import subprocess |
|
17 | import subprocess | |
18 | import shlex |
|
18 | import shlex | |
19 | import sys |
|
19 | import sys | |
20 | import os |
|
20 | import os | |
21 |
|
21 | |||
22 | from IPython.utils import py3compat |
|
22 | from IPython.utils import py3compat | |
23 |
|
23 | |||
24 | #----------------------------------------------------------------------------- |
|
24 | #----------------------------------------------------------------------------- | |
25 | # Function definitions |
|
25 | # Function definitions | |
26 | #----------------------------------------------------------------------------- |
|
26 | #----------------------------------------------------------------------------- | |
27 |
|
27 | |||
28 | def read_no_interrupt(p): |
|
28 | def read_no_interrupt(p): | |
29 | """Read from a pipe ignoring EINTR errors. |
|
29 | """Read from a pipe ignoring EINTR errors. | |
30 |
|
30 | |||
31 | This is necessary because when reading from pipes with GUI event loops |
|
31 | This is necessary because when reading from pipes with GUI event loops | |
32 | running in the background, often interrupts are raised that stop the |
|
32 | running in the background, often interrupts are raised that stop the | |
33 | command from completing.""" |
|
33 | command from completing.""" | |
34 | import errno |
|
34 | import errno | |
35 |
|
35 | |||
36 | try: |
|
36 | try: | |
37 | return p.read() |
|
37 | return p.read() | |
38 | except IOError as err: |
|
38 | except IOError as err: | |
39 | if err.errno != errno.EINTR: |
|
39 | if err.errno != errno.EINTR: | |
40 | raise |
|
40 | raise | |
41 |
|
41 | |||
42 |
|
42 | |||
43 | def process_handler(cmd, callback, stderr=subprocess.PIPE): |
|
43 | def process_handler(cmd, callback, stderr=subprocess.PIPE): | |
44 | """Open a command in a shell subprocess and execute a callback. |
|
44 | """Open a command in a shell subprocess and execute a callback. | |
45 |
|
45 | |||
46 | This function provides common scaffolding for creating subprocess.Popen() |
|
46 | This function provides common scaffolding for creating subprocess.Popen() | |
47 | calls. It creates a Popen object and then calls the callback with it. |
|
47 | calls. It creates a Popen object and then calls the callback with it. | |
48 |
|
48 | |||
49 | Parameters |
|
49 | Parameters | |
50 | ---------- |
|
50 | ---------- | |
51 | cmd : str or list |
|
51 | cmd : str or list | |
52 | A command to be executed by the system, using :class:`subprocess.Popen`. |
|
52 | A command to be executed by the system, using :class:`subprocess.Popen`. | |
53 | If a string is passed, it will be run in the system shell. If a list is |
|
53 | If a string is passed, it will be run in the system shell. If a list is | |
54 | passed, it will be used directly as arguments. |
|
54 | passed, it will be used directly as arguments. | |
55 |
|
55 | |||
56 | callback : callable |
|
56 | callback : callable | |
57 | A one-argument function that will be called with the Popen object. |
|
57 | A one-argument function that will be called with the Popen object. | |
58 |
|
58 | |||
59 | stderr : file descriptor number, optional |
|
59 | stderr : file descriptor number, optional | |
60 | By default this is set to ``subprocess.PIPE``, but you can also pass the |
|
60 | By default this is set to ``subprocess.PIPE``, but you can also pass the | |
61 | value ``subprocess.STDOUT`` to force the subprocess' stderr to go into |
|
61 | value ``subprocess.STDOUT`` to force the subprocess' stderr to go into | |
62 | the same file descriptor as its stdout. This is useful to read stdout |
|
62 | the same file descriptor as its stdout. This is useful to read stdout | |
63 | and stderr combined in the order they are generated. |
|
63 | and stderr combined in the order they are generated. | |
64 |
|
64 | |||
65 | Returns |
|
65 | Returns | |
66 | ------- |
|
66 | ------- | |
67 | The return value of the provided callback is returned. |
|
67 | The return value of the provided callback is returned. | |
68 | """ |
|
68 | """ | |
69 | sys.stdout.flush() |
|
69 | sys.stdout.flush() | |
70 | sys.stderr.flush() |
|
70 | sys.stderr.flush() | |
71 | # On win32, close_fds can't be true when using pipes for stdin/out/err |
|
71 | # On win32, close_fds can't be true when using pipes for stdin/out/err | |
72 | close_fds = sys.platform != 'win32' |
|
72 | close_fds = sys.platform != 'win32' | |
73 | # Determine if cmd should be run with system shell. |
|
73 | # Determine if cmd should be run with system shell. | |
74 | shell = isinstance(cmd, str) |
|
74 | shell = isinstance(cmd, str) | |
75 | # On POSIX systems run shell commands with user-preferred shell. |
|
75 | # On POSIX systems run shell commands with user-preferred shell. | |
76 | executable = None |
|
76 | executable = None | |
77 | if shell and os.name == 'posix' and 'SHELL' in os.environ: |
|
77 | if shell and os.name == 'posix' and 'SHELL' in os.environ: | |
78 | executable = os.environ['SHELL'] |
|
78 | executable = os.environ['SHELL'] | |
79 | p = subprocess.Popen(cmd, shell=shell, |
|
79 | p = subprocess.Popen(cmd, shell=shell, | |
80 | executable=executable, |
|
80 | executable=executable, | |
81 | stdin=subprocess.PIPE, |
|
81 | stdin=subprocess.PIPE, | |
82 | stdout=subprocess.PIPE, |
|
82 | stdout=subprocess.PIPE, | |
83 | stderr=stderr, |
|
83 | stderr=stderr, | |
84 | close_fds=close_fds) |
|
84 | close_fds=close_fds) | |
85 |
|
85 | |||
86 | try: |
|
86 | try: | |
87 | out = callback(p) |
|
87 | out = callback(p) | |
88 | except KeyboardInterrupt: |
|
88 | except KeyboardInterrupt: | |
89 | print('^C') |
|
89 | print('^C') | |
90 | sys.stdout.flush() |
|
90 | sys.stdout.flush() | |
91 | sys.stderr.flush() |
|
91 | sys.stderr.flush() | |
92 | out = None |
|
92 | out = None | |
93 | finally: |
|
93 | finally: | |
94 | # Make really sure that we don't leave processes behind, in case the |
|
94 | # Make really sure that we don't leave processes behind, in case the | |
95 | # call above raises an exception |
|
95 | # call above raises an exception | |
96 | # We start by assuming the subprocess finished (to avoid NameErrors |
|
96 | # We start by assuming the subprocess finished (to avoid NameErrors | |
97 | # later depending on the path taken) |
|
97 | # later depending on the path taken) | |
98 | if p.returncode is None: |
|
98 | if p.returncode is None: | |
99 | try: |
|
99 | try: | |
100 | p.terminate() |
|
100 | p.terminate() | |
101 | p.poll() |
|
101 | p.poll() | |
102 | except OSError: |
|
102 | except OSError: | |
103 | pass |
|
103 | pass | |
104 | # One last try on our way out |
|
104 | # One last try on our way out | |
105 | if p.returncode is None: |
|
105 | if p.returncode is None: | |
106 | try: |
|
106 | try: | |
107 | p.kill() |
|
107 | p.kill() | |
108 | except OSError: |
|
108 | except OSError: | |
109 | pass |
|
109 | pass | |
110 |
|
110 | |||
111 | return out |
|
111 | return out | |
112 |
|
112 | |||
113 |
|
113 | |||
114 | def getoutput(cmd): |
|
114 | def getoutput(cmd): | |
115 | """Run a command and return its stdout/stderr as a string. |
|
115 | """Run a command and return its stdout/stderr as a string. | |
116 |
|
116 | |||
117 | Parameters |
|
117 | Parameters | |
118 | ---------- |
|
118 | ---------- | |
119 | cmd : str or list |
|
119 | cmd : str or list | |
120 | A command to be executed in the system shell. |
|
120 | A command to be executed in the system shell. | |
121 |
|
121 | |||
122 | Returns |
|
122 | Returns | |
123 | ------- |
|
123 | ------- | |
124 | output : str |
|
124 | output : str | |
125 | A string containing the combination of stdout and stderr from the |
|
125 | A string containing the combination of stdout and stderr from the | |
126 | subprocess, in whatever order the subprocess originally wrote to its |
|
126 | subprocess, in whatever order the subprocess originally wrote to its | |
127 | file descriptors (so the order of the information in this string is the |
|
127 | file descriptors (so the order of the information in this string is the | |
128 | correct order as would be seen if running the command in a terminal). |
|
128 | correct order as would be seen if running the command in a terminal). | |
129 | """ |
|
129 | """ | |
130 | out = process_handler(cmd, lambda p: p.communicate()[0], subprocess.STDOUT) |
|
130 | out = process_handler(cmd, lambda p: p.communicate()[0], subprocess.STDOUT) | |
131 | if out is None: |
|
131 | if out is None: | |
132 | return '' |
|
132 | return '' | |
133 | return py3compat.bytes_to_str(out) |
|
133 | return py3compat.bytes_to_str(out) | |
134 |
|
134 | |||
135 |
|
135 | |||
136 | def getoutputerror(cmd): |
|
136 | def getoutputerror(cmd): | |
137 | """Return (standard output, standard error) of executing cmd in a shell. |
|
137 | """Return (standard output, standard error) of executing cmd in a shell. | |
138 |
|
138 | |||
139 | Accepts the same arguments as os.system(). |
|
139 | Accepts the same arguments as os.system(). | |
140 |
|
140 | |||
141 | Parameters |
|
141 | Parameters | |
142 | ---------- |
|
142 | ---------- | |
143 | cmd : str or list |
|
143 | cmd : str or list | |
144 | A command to be executed in the system shell. |
|
144 | A command to be executed in the system shell. | |
145 |
|
145 | |||
146 | Returns |
|
146 | Returns | |
147 | ------- |
|
147 | ------- | |
148 | stdout : str |
|
148 | stdout : str | |
149 | stderr : str |
|
149 | stderr : str | |
150 | """ |
|
150 | """ | |
151 | return get_output_error_code(cmd)[:2] |
|
151 | return get_output_error_code(cmd)[:2] | |
152 |
|
152 | |||
153 | def get_output_error_code(cmd): |
|
153 | def get_output_error_code(cmd): | |
154 | """Return (standard output, standard error, return code) of executing cmd |
|
154 | """Return (standard output, standard error, return code) of executing cmd | |
155 | in a shell. |
|
155 | in a shell. | |
156 |
|
156 | |||
157 | Accepts the same arguments as os.system(). |
|
157 | Accepts the same arguments as os.system(). | |
158 |
|
158 | |||
159 | Parameters |
|
159 | Parameters | |
160 | ---------- |
|
160 | ---------- | |
161 | cmd : str or list |
|
161 | cmd : str or list | |
162 | A command to be executed in the system shell. |
|
162 | A command to be executed in the system shell. | |
163 |
|
163 | |||
164 | Returns |
|
164 | Returns | |
165 | ------- |
|
165 | ------- | |
166 | stdout : str |
|
166 | stdout : str | |
167 | stderr : str |
|
167 | stderr : str | |
168 | returncode: int |
|
168 | returncode: int | |
169 | """ |
|
169 | """ | |
170 |
|
170 | |||
171 | out_err, p = process_handler(cmd, lambda p: (p.communicate(), p)) |
|
171 | out_err, p = process_handler(cmd, lambda p: (p.communicate(), p)) | |
172 | if out_err is None: |
|
172 | if out_err is None: | |
173 | return '', '', p.returncode |
|
173 | return '', '', p.returncode | |
174 | out, err = out_err |
|
174 | out, err = out_err | |
175 | return py3compat.bytes_to_str(out), py3compat.bytes_to_str(err), p.returncode |
|
175 | return py3compat.bytes_to_str(out), py3compat.bytes_to_str(err), p.returncode | |
176 |
|
176 | |||
177 | def arg_split(s, posix=False, strict=True): |
|
177 | def arg_split(s, posix=False, strict=True): | |
178 | """Split a command line's arguments in a shell-like manner. |
|
178 | """Split a command line's arguments in a shell-like manner. | |
179 |
|
179 | |||
180 | This is a modified version of the standard library's shlex.split() |
|
180 | This is a modified version of the standard library's shlex.split() | |
181 | function, but with a default of posix=False for splitting, so that quotes |
|
181 | function, but with a default of posix=False for splitting, so that quotes | |
182 | in inputs are respected. |
|
182 | in inputs are respected. | |
183 |
|
183 | |||
184 | if strict=False, then any errors shlex.split would raise will result in the |
|
184 | if strict=False, then any errors shlex.split would raise will result in the | |
185 | unparsed remainder being the last element of the list, rather than raising. |
|
185 | unparsed remainder being the last element of the list, rather than raising. | |
186 | This is because we sometimes use arg_split to parse things other than |
|
186 | This is because we sometimes use arg_split to parse things other than | |
187 | command-line args. |
|
187 | command-line args. | |
188 | """ |
|
188 | """ | |
189 |
|
189 | |||
190 | # Unfortunately, python's shlex module is buggy with unicode input: |
|
|||
191 | # http://bugs.python.org/issue1170 |
|
|||
192 | # At least encoding the input when it's unicode seems to help, but there |
|
|||
193 | # may be more problems lurking. Apparently this is fixed in python3. |
|
|||
194 | is_unicode = False |
|
|||
195 | if (not py3compat.PY3) and isinstance(s, unicode): |
|
|||
196 | is_unicode = True |
|
|||
197 | s = s.encode('utf-8') |
|
|||
198 | lex = shlex.shlex(s, posix=posix) |
|
190 | lex = shlex.shlex(s, posix=posix) | |
199 | lex.whitespace_split = True |
|
191 | lex.whitespace_split = True | |
200 | # Extract tokens, ensuring that things like leaving open quotes |
|
192 | # Extract tokens, ensuring that things like leaving open quotes | |
201 | # does not cause this to raise. This is important, because we |
|
193 | # does not cause this to raise. This is important, because we | |
202 | # sometimes pass Python source through this (e.g. %timeit f(" ")), |
|
194 | # sometimes pass Python source through this (e.g. %timeit f(" ")), | |
203 | # and it shouldn't raise an exception. |
|
195 | # and it shouldn't raise an exception. | |
204 | # It may be a bad idea to parse things that are not command-line args |
|
196 | # It may be a bad idea to parse things that are not command-line args | |
205 | # through this function, but we do, so let's be safe about it. |
|
197 | # through this function, but we do, so let's be safe about it. | |
206 | lex.commenters='' #fix for GH-1269 |
|
198 | lex.commenters='' #fix for GH-1269 | |
207 | tokens = [] |
|
199 | tokens = [] | |
208 | while True: |
|
200 | while True: | |
209 | try: |
|
201 | try: | |
210 | tokens.append(next(lex)) |
|
202 | tokens.append(next(lex)) | |
211 | except StopIteration: |
|
203 | except StopIteration: | |
212 | break |
|
204 | break | |
213 | except ValueError: |
|
205 | except ValueError: | |
214 | if strict: |
|
206 | if strict: | |
215 | raise |
|
207 | raise | |
216 | # couldn't parse, get remaining blob as last token |
|
208 | # couldn't parse, get remaining blob as last token | |
217 | tokens.append(lex.token) |
|
209 | tokens.append(lex.token) | |
218 | break |
|
210 | break | |
219 |
|
211 | |||
220 | if is_unicode: |
|
|||
221 | # Convert the tokens back to unicode. |
|
|||
222 | tokens = [x.decode('utf-8') for x in tokens] |
|
|||
223 | return tokens |
|
212 | return tokens |
General Comments 0
You need to be logged in to leave comments.
Login now