Clarify the interaction between locale coercion & UTF-8 mode

[ncoghlan]

BPO	33409
Nosy	@ncoghlan, @vstinner, @ned-deily, @miss-islington
PRs	bpo-33409: Clarify PEP 538/540 relationship #7534 [3.7] bpo-33409: Clarify PEP 538/540 relationship (GH-7534) #7555

^{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 = 'https://github.com/ncoghlan'
closed_at = <Date 2018-06-09.10:52:56.242>
created_at = <Date 2018-05-02.11:33:42.906>
labels = ['3.8', 'type-feature', '3.7', 'docs']
title = 'Clarify the interaction between locale coercion & UTF-8 mode'
updated_at = <Date 2018-06-09.10:52:56.242>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2018-06-09.10:52:56.242>
actor = 'ncoghlan'
assignee = 'ncoghlan'
closed = True
closed_date = <Date 2018-06-09.10:52:56.242>
closer = 'ncoghlan'
components = ['Documentation']
creation = <Date 2018-05-02.11:33:42.906>
creator = 'ncoghlan'
dependencies = []
files = []
hgrepos = []
issue_num = 33409
keywords = ['patch']
message_count = 6.0
messages = ['316069', '317795', '317802', '317848', '319137', '319138']
nosy_count = 4.0
nosy_names = ['ncoghlan', 'vstinner', 'ned.deily', 'miss-islington']
pr_nums = ['7534', '7555']
priority = 'high'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue33409'
versions = ['Python 3.7', 'Python 3.8']

[ncoghlan]

While Victor and I reconciled the respective designs & implementations of PEP 538/540 (with 538 relying on 540 to handle the "No suitable target locale" case, and 540 relying on 538 to handle extension modules like GNU readline), the interaction between the two mechanisms currently isn't clear in the documentation.

So, before 3.7rc1 goes out, we should:

1. Combine the presentation of the two PEPs in the What's New documentation to make it clearer that they're tackling different aspects of the same problem
2. Clarify in the reference docs for PYTHONCOERCECLOCALE and PYTHONUTF8MODE that they're independent settings (so you have to explicitly turn them *both* off if you truly want to force ASCII based text handling in the C or POSIX locale)

(Issue raised based on a Twitter discussion with Anthony Shaw at https://twitter.com/anthonypjshaw/status/991614899791933441)

[ncoghlan]

Ned, just adding you to the nosy list here, as I don't think this is a release blocker per se (since nothing's actually *broken*), but the current state of the PEP 538/540 docs is such that it isn't going to be clear to most readers why both mechanisms exist, or how they interact with each other.

[ned-deily]

Nick, thanks for the notification. I assume this means you are planning to provide one or more updates. If so, any idea when?

[ncoghlan]

I'm aiming for this week, so with the docstring-AST-induced delay I should even meet the original rc1 goal :)

[ncoghlan]

New changeset 1bcb8a6 by Nick Coghlan in branch 'master':
bpo-33409: Clarify PEP 538/540 relationship (GH-7534)
1bcb8a6

[miss-islington]

New changeset dd613cf by Miss Islington (bot) in branch '3.7':
bpo-33409: Clarify PEP 538/540 relationship (GH-7534)
dd613cf