Don't use a list argument together with shell=True in subprocess' docs

[4kir4]

BPO	21347
Nosy	@merwok, @bitdancer, @4kir4
Files	docs-subprocess-dont_use_list_with_shell_true.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2014-05-14.14:11:07.886>
created_at = <Date 2014-04-24.19:08:42.584>
labels = ['type-bug', 'docs']
title = "Don't use a list argument together with shell=True in subprocess' docs"
updated_at = <Date 2014-05-14.14:11:07.885>
user = 'https://github.com/4kir4'

bugs.python.org fields:

activity = <Date 2014-05-14.14:11:07.885>
actor = 'r.david.murray'
assignee = 'docs@python'
closed = True
closed_date = <Date 2014-05-14.14:11:07.886>
closer = 'r.david.murray'
components = ['Documentation']
creation = <Date 2014-04-24.19:08:42.584>
creator = 'akira'
dependencies = []
files = ['35026']
hgrepos = []
issue_num = 21347
keywords = ['patch']
message_count = 4.0
messages = ['217136', '217760', '218533', '218534']
nosy_count = 6.0
nosy_names = ['eric.araujo', 'r.david.murray', 'cvrebert', 'docs@python', 'akira', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue21347'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5']

[4kir4]

*Popen(["something"], shell=True)* works but it is similar to
*Popen(["something", "arg"], shell=True)* that passes "arg" to /bin/sh on POSIX systems instead of "something".

It is best to always use a string if shell=True is necessary.

It is a common confusion bpo-20344, msg98732, bpo-7839

http://stackoverflow.com/questions/21029154/understanding-python-subprocess-check-outputs-first-argument-and-shell-true
http://stackoverflow.com/questions/20787712/start-openoffice-process-with-python-to-use-with-pyuno-using-subprocess
http://stackoverflow.com/questions/17880847/python-subprocess-error-in-using-cp
http://stackoverflow.com/questions/17226912/why-does-simple-echo-in-subprocess-not-working
http://stackoverflow.com/questions/15109665/subprocess-call-using-string-vs-using-list
http://stackoverflow.com/questions/20128114/pythons-subprocess-does-not-interpret-as-expected-on-cygwin
http://stackoverflow.com/questions/16840427/python-on-linux-subprocess-popen-works-weird-with-shell-true
...

[4kir4]

I've checked the same documentation patch applies to both default (3.5) and 2.7 branches.

There are no more instances of the misleading usage left (after applying the patch).

[python-dev]

New changeset 5ef9a2c711f5 by R David Murray in branch '2.7':
bpo-21347: use string not list in shell=True example.
http://hg.python.org/cpython/rev/5ef9a2c711f5

New changeset 3b27f3acf0c4 by R David Murray in branch '3.4':
bpo-21347: use string not list in shell=True example.
http://hg.python.org/cpython/rev/3b27f3acf0c4

New changeset 217006c5455f by R David Murray in branch 'default':
Merge: bpo-21347: use string not list in shell=True example.
http://hg.python.org/cpython/rev/217006c5455f

[bitdancer]

Thanks, Akira.