shlex.shlex punctuation_chars documentation should use posix=True

[evanunderscore]

BPO	28784
Nosy	@vsajip, @bitdancer, @evanunderscore

^{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 2017-01-27.13:05:18.914>
created_at = <Date 2016-11-24.07:44:10.159>
labels = ['type-bug', 'docs']
title = 'shlex.shlex punctuation_chars documentation should use posix=True'
updated_at = <Date 2017-01-27.13:05:18.912>
user = 'https://github.com/evanunderscore'

bugs.python.org fields:

activity = <Date 2017-01-27.13:05:18.912>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2017-01-27.13:05:18.914>
closer = 'python-dev'
components = ['Documentation']
creation = <Date 2016-11-24.07:44:10.159>
creator = 'evan_'
dependencies = []
files = []
hgrepos = []
issue_num = 28784
keywords = []
message_count = 2.0
messages = ['281612', '286353']
nosy_count = 5.0
nosy_names = ['vinay.sajip', 'r.david.murray', 'docs@python', 'python-dev', 'evan_']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue28784'
versions = ['Python 3.6']

[evanunderscore]

(This discussion started on bpo-28595.)

The new punctuation_chars keyword argument is intended to provide "compatibility with the parsing performed by common Unix shells like bash, dash, and sh", however the documentation and examples do not mention that the user should also set posix=True (which defaults to False for shlex.shlex but True for shlex.split).

Longer term (over several releases), perhaps the default for posix could be changed from False to True. Alternatively, the punctuation_chars argument could also be added to shlex.split, which would avoid having to interact with shlex.shlex directly.

[python-dev]

New changeset ff3312ce1d14 by Vinay Sajip in branch '3.6':
Fixes bpo-28784: Clarified use of shlex.shlex with punctuation_chars.
https://hg.python.org/cpython/rev/ff3312ce1d14

New changeset 46f8188f8646 by Vinay Sajip in branch 'default':
Closes bpo-28784: Merged update from 3.6.
https://hg.python.org/cpython/rev/46f8188f8646