File tree 1 file changed +6
-5
lines changed
1 file changed +6
-5
lines changed Original file line number Diff line number Diff line change @@ -199,20 +199,21 @@ def run(
199
199
check_returncode : bool = True ,
200
200
callback : Optional [ProgressCallbackProtocol ] = None ,
201
201
):
202
- """Run 'cmd' in a shell and return the combined contents of stdout and
203
- stderr (Blocking). Throws an exception if the command exits non-zero.
202
+ """Run 'args' in a shell and return the combined contents of stdout and
203
+ stderr (Blocking). Throws an exception if the command exits non-zero.
204
+
205
+ Keyword arguments are passthrough to {class}`subprocess.Popen`.
204
206
205
207
Parameters
206
208
----------
207
- cmd : list or str, or single str, if shell=True
209
+ args : list or str, or single str, if shell=True
208
210
the command to run
209
211
210
212
shell : boolean
211
213
boolean indicating whether we are using advanced shell
212
214
features. Use only when absolutely necessary, since this allows a lot
213
215
more freedom which could be exploited by malicious code. See the
214
- warning here:
215
- http://docs.python.org/library/subprocess.html#popen-constructor
216
+ warning here: http://docs.python.org/library/subprocess.html#popen-constructor
216
217
217
218
cwd : str
218
219
dir command is run from. Defaults to ``path``.
You can’t perform that action at this time.
0 commit comments