Make _Py_PackageContext of type "const char *"

[serhiy-storchaka]

BPO	28748
Nosy	@brettcannon, @ncoghlan, @ericsnowcurrently, @serhiy-storchaka
PRs	[Do Not Merge] Convert Misc/NEWS so that it is managed by towncrier #552
Files	_Py_PackageContext-const.patch _Py_PackageContext-const-2.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 2016-11-21.08:27:08.292>
created_at = <Date 2016-11-20.09:32:00.472>
labels = ['interpreter-core', 'type-feature', '3.7']
title = 'Make _Py_PackageContext of type "const char *"'
updated_at = <Date 2017-03-31.16:36:10.152>
user = 'https://github.com/serhiy-storchaka'

bugs.python.org fields:

activity = <Date 2017-03-31.16:36:10.152>
actor = 'dstufft'
assignee = 'none'
closed = True
closed_date = <Date 2016-11-21.08:27:08.292>
closer = 'serhiy.storchaka'
components = ['Interpreter Core']
creation = <Date 2016-11-20.09:32:00.472>
creator = 'serhiy.storchaka'
dependencies = []
files = ['45556', '45567']
hgrepos = []
issue_num = 28748
keywords = ['patch']
message_count = 6.0
messages = ['281256', '281266', '281298', '281331', '281333', '281334']
nosy_count = 5.0
nosy_names = ['brett.cannon', 'ncoghlan', 'python-dev', 'eric.snow', 'serhiy.storchaka']
pr_nums = ['552']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue28748'
versions = ['Python 3.7']

[serhiy-storchaka]

Currently _Py_PackageContext has type "char *". But it is either NULL or a pointer to internal readonly UTF-8 representation of Unicode object. Adding the const qualifier makes it clear that the data is immutable. I don't think this change will break third-party code.

[ncoghlan]

It technically could (if they're passing it to a function that takes a "char *"), but if they are and they can't change the affected function to take "const char *" instead, then that's an actual bug in the way they're using it.

So +1 from me for explicitly declaring the immutability in 3.7+ - it will need a note in the What's New porting guide though.

[serhiy-storchaka]

Added a What's New note.

On GitHub I found only three projects (besides clones of CPython sources) that use _Py_PackageContext. They are not affected by this change.

[ncoghlan]

Ah, my apologies - for some reason I completely failed to notice the leading underscore until I saw you refer to this as a private variable in the What's New note.

That means the note only needs to go in the NEWS file for the benefit of maintainers, rather than in the public porting notes. Sorry for overcomplicating things :)

Aside from my confusion about this actually being a private interface, the patch looks good to me.

[python-dev]

New changeset d2dd6578aa16 by Serhiy Storchaka in branch 'default':
Issue bpo-28748: Private variable _Py_PackageContext is now of type "const char *"
https://hg.python.org/cpython/rev/d2dd6578aa16

[serhiy-storchaka]

Thanks Nick.