[doc] Py_UTF8Mode is not documented

[serhiy-storchaka]

BPO	33601
Nosy	@ncoghlan, @vstinner, @serhiy-storchaka, @Mariatta, @Vidhyavinu
PRs	bpo-33601: Document for Py_UTF8Mode #7143 bpo-33601 Py_UTF8Mode is not documented #31480
Files	init.html: c-api/init.html

^{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/Mariatta'
closed_at = None
created_at = <Date 2018-05-22.13:49:41.438>
labels = ['easy', '3.9', '3.10', '3.11', 'type-feature', 'docs']
title = '[doc] Py_UTF8Mode is not documented'
updated_at = <Date 2022-02-21.20:15:37.372>
user = 'https://github.com/serhiy-storchaka'

bugs.python.org fields:

activity = <Date 2022-02-21.20:15:37.372>
actor = 'vidhya'
assignee = 'Mariatta'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2018-05-22.13:49:41.438>
creator = 'serhiy.storchaka'
dependencies = []
files = ['50630']
hgrepos = []
issue_num = 33601
keywords = ['patch', 'easy']
message_count = 7.0
messages = ['317286', '317292', '317294', '338920', '413511', '413648', '413674']
nosy_count = 6.0
nosy_names = ['ncoghlan', 'vstinner', 'docs@python', 'serhiy.storchaka', 'Mariatta', 'vidhya']
pr_nums = ['7143', '31480']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue33601'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

Linked PRs

• gh-77782: Deprecate Py_HasFileSystemDefaultEncoding #106272
• [3.12] gh-77782: Deprecate Py_HasFileSystemDefaultEncoding (GH-106272) #106274
• gh-77782: Postpone Py_VerboseFlag removal to Python 3.15 #129024

[serhiy-storchaka]

Py_UTF8Mode was added to the limited API in 3.7, but it is not documented anywhere.

[vstinner]

I wasn't sure if I should document it, but after talking with Serhiy on IRC, I now agree that the new variable should be documented.

It should be documented at:
https://docs.python.org/dev/c-api/init.html#global-configuration-variables

[serhiy-storchaka]

If there are reasons of including it in the limited API, it should be documented.

[vstinner]

PR 7143 has been closed. So is there another candidate to write the doc?