You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Derby #10: Convert 50 sites to Argument Clinic across 4 files #64378
This issue is part of the Great Argument Clinic Conversion Derby,
where we're trying to convert as much of Python 3.4 to use
Argument Clinic as we can before Release Candidate 1 on January 19.
This is one patch because there are changes that must be done in bytes_methods.h and bytes_methods.c that affect both of bytesobject.c and bytearrayobject.c. Those changes are in this patch as well.
All methods were converted except for two groups:
the various find methods which use the common argument parsing function 'stringlib_parse_args_finds_byte'
'new' and 'init' methods
Also note that both of these classes use some common function implementations found under 'stringlib'. However, since that code is in separate files, I'll upload the conversion patches to the relevant issue (and write an appropriate comment here).
In the previous patch I missed the 'clear' and 'copy' bytearray methods. This patch is a replacement for the previous one, with the additional conversion of these two methods.
I have no opinion on whether this is a good thing or not. Security backports should be few and far between, so I don't think it's a big problem if they are a bit more difficult.
How often are patches backported to 2.7? While I understand the sentiment, I'd like to understand the scale of the objection being raised. I suspect it's infrequent, making the objection a minor one.
I think it's worthwhile to maintain the ability to easily backport patches from 3.x to 2.7, especially given the security sensitive nature of the ssl module.
We discussed it in IRC a bit (and I got a little education). I can propose three remedies:
A) back out the Clinic conversion in _ssl.c
B) support Clinic in 2.7 just for _ssl.c
C) do a one-time backport of the Clinic generated code for _ssl.c
IMO these are in my reverse order of preference; I'd prefer C, then B, then A. But I'm not supporting _ssl.c, you guys are. And I want you maintainers to be happy. So I'll abide by / help you in implementing whatever you prefer.
FWIW, option C would mean doing an otherwise-inert backport of the current _ssl.c from trunk to 2.7, so that we could also backport (by hand) Modules/clinic/_ssl.c. Then, if in the future, when you change _ssl.c you still copy that file over and tweak it. But: if you change the arguments to a function, you'd have to *hand-edit* Modules/clinic/_ssl.c to match.
A) back out the Clinic conversion in _ssl.c
B) support Clinic in 2.7 just for _ssl.c
C) do a one-time backport of the Clinic generated code for _ssl.c
I'd rather have A or C than B.
By the way, this discussion seems to focus on 2.7, but the same issue happens with 3.4 (although Clinic already exists here, so we can just backport Serhiy's work).
Clinic's syntax is diverging from what shipped with 3.4. So if you copied _ssl.c over, it wouldn't work with the Clinic that shipped with 3.4.
Maybe the best thing is if Clinic in trunk supports "legacy mode", where the code it generates is compatible with previous Python versions. That's basically B but without doing something crazy like shipping Clinic with 2.7.
Activity
larryhastings commentedon Jan 8, 2014
This issue is part of the Great Argument Clinic Conversion Derby,
where we're trying to convert as much of Python 3.4 to use
Argument Clinic as we can before Release Candidate 1 on January 19.
This issue asks you to change the following bundle of files:
Modules/overlapped.c: 21 sites
Modules/_ssl.c: 20 sites
Objects/bytes_methods.c: 1 sites
Objects/bytesobject.c: 8 sites
Talk to me (larry) if you only want to attack part of a bundle.
For instructions on how to convert a function to work with Argument
Clinic, read the "howto":
http://docs.python.org/dev/howto/clinic.html
taleinat commentedon Jan 20, 2014
While converting Objects/stringlib/transmogrify.h as part of bpo-20180 (Derby #11), some changes to Objects/bytesobject.c and Objects/bytearrayobject.c were required. Those changes are included in the relevant patch attached to that issue.
taleinat commentedon Jan 21, 2014
Attached patch for AC conversion of Objects/bytesobject.c and Objects/bytearrayobject.c.
This is one patch because there are changes that must be done in bytes_methods.h and bytes_methods.c that affect both of bytesobject.c and bytearrayobject.c. Those changes are in this patch as well.
All methods were converted except for two groups:
Also note that both of these classes use some common function implementations found under 'stringlib'. However, since that code is in separate files, I'll upload the conversion patches to the relevant issue (and write an appropriate comment here).
taleinat commentedon Jan 21, 2014
Attached updated patch for bytes and bytearray.
In the previous patch I missed the 'clear' and 'copy' bytearray methods. This patch is a replacement for the previous one, with the additional conversion of these two methods.
python-dev commentedon Jul 27, 2014
New changeset 4d3d0659b55e by Martin v. Löwis in branch 'default':
Issue bpo-20179: Apply Argument Clinic to bytes and bytearray.
http://hg.python.org/cpython/rev/4d3d0659b55e
loewis commentedon Jul 27, 2014
Tal: Thanks for the patch. I applied it with updates to the current Argument Clinic.
_ssl and _overlapped are still to be done.
larryhastings commentedon Aug 4, 2014
All the Derby patches should only go into trunk at this point.
serhiy-storchaka commentedon Apr 6, 2015
Proposed patch converts the _ssl module to Argument Clinic. Total 39 methods converted.
alex commentedon Apr 6, 2015
I'm concerned the _ssl changes will make security backports significantly more difficult.
serhiy-storchaka commentedon Apr 6, 2015
_ssl.enum_certificates() and _ssl.enum_crls() is not converted because their parsing code look incorrect (bpo-23875).
serhiy-storchaka commentedon Apr 16, 2015
The patch updated to the tip.
python-dev commentedon May 3, 2015
New changeset 1eaaf27b3956 by Serhiy Storchaka in branch 'default':
Issue bpo-20179: Converted the _ssl module to Argument Clinic.
https://hg.python.org/cpython/rev/1eaaf27b3956
2 remaining items
pitrou commentedon May 3, 2015
I have no opinion on whether this is a good thing or not. Security backports should be few and far between, so I don't think it's a big problem if they are a bit more difficult.
larryhastings commentedon May 3, 2015
How often are patches backported to 2.7? While I understand the sentiment, I'd like to understand the scale of the objection being raised. I suspect it's infrequent, making the objection a minor one.
tiran commentedon May 3, 2015
You are right, patches are seldomly backported to Python 2.7. Features are never backported. Well, except for one exception: the ssl module. :)
dstufft commentedon May 3, 2015
I think it's worthwhile to maintain the ability to easily backport patches from 3.x to 2.7, especially given the security sensitive nature of the ssl module.
larryhastings commentedon May 3, 2015
We discussed it in IRC a bit (and I got a little education). I can propose three remedies:
A) back out the Clinic conversion in _ssl.c
B) support Clinic in 2.7 just for _ssl.c
C) do a one-time backport of the Clinic generated code for _ssl.c
IMO these are in my reverse order of preference; I'd prefer C, then B, then A. But I'm not supporting _ssl.c, you guys are. And I want you maintainers to be happy. So I'll abide by / help you in implementing whatever you prefer.
FWIW, option C would mean doing an otherwise-inert backport of the current _ssl.c from trunk to 2.7, so that we could also backport (by hand) Modules/clinic/_ssl.c. Then, if in the future, when you change _ssl.c you still copy that file over and tweak it. But: if you change the arguments to a function, you'd have to *hand-edit* Modules/clinic/_ssl.c to match.
pitrou commentedon May 3, 2015
Le 03/05/2015 23:06, Larry Hastings a écrit :
Can we have a transcript somewhere?
larryhastings commentedon May 3, 2015
Attached. Glad you asked right away, it would have been a lot harder to get later!
pitrou commentedon May 3, 2015
Thank you!
pitrou commentedon May 4, 2015
I'd rather have A or C than B.
By the way, this discussion seems to focus on 2.7, but the same issue happens with 3.4 (although Clinic already exists here, so we can just backport Serhiy's work).
larryhastings commentedon May 4, 2015
Clinic's syntax is diverging from what shipped with 3.4. So if you copied _ssl.c over, it wouldn't work with the Clinic that shipped with 3.4.
Maybe the best thing is if Clinic in trunk supports "legacy mode", where the code it generates is compatible with previous Python versions. That's basically B but without doing something crazy like shipping Clinic with 2.7.
taleinat commentedon Oct 8, 2018
Can someone clarify whether Modules/overlapped.c should be converted to use AC?
ZackerySpytz commentedon Jun 20, 2019
PR 14275 converts Modules/overlapped.c. Many methods now use METH_FASTCALL.
serhiy-storchaka commentedon Jul 10, 2020
New changeset 9650fe0 by Zackery Spytz in branch 'master':
bpo-20179: Convert the _overlapped module to the Argument Clinic (GH-14275)
9650fe0