Derby #1: Convert 137 sites to Argument Clinic in Modules/posixmodule.c

[larryhastings]

BPO	20170
Nosy	@loewis, @larryhastings, @zware, @serhiy-storchaka
Files	larry.clinicize.posixmodule.1.diff larry.clinicize.posixmodule.2.diff larry.clinicize.posixmodule.3.diff larry.clinicize.posixmodule.4.diff: attempt Update Python Software Foundation Copyright Year. #4 larry.clinicize.posixmodule.5.diff larry.clinicize.posixmodule.6.diff larry.clinicize.posixmodule.7.diff

^{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/larryhastings'
closed_at = <Date 2014-08-05.04:08:51.455>
created_at = <Date 2014-01-07.23:43:05.768>
labels = ['extension-modules', 'easy', 'type-feature']
title = 'Derby #1: Convert 137 sites to Argument Clinic in Modules/posixmodule.c'
updated_at = <Date 2014-08-05.04:08:51.454>
user = 'https://github.com/larryhastings'

bugs.python.org fields:

activity = <Date 2014-08-05.04:08:51.454>
actor = 'larry'
assignee = 'larry'
closed = True
closed_date = <Date 2014-08-05.04:08:51.455>
closer = 'larry'
components = ['Extension Modules']
creation = <Date 2014-01-07.23:43:05.768>
creator = 'larry'
dependencies = []
files = ['33789', '33797', '33798', '36136', '36164', '36172', '36240']
hgrepos = []
issue_num = 20170
keywords = ['patch', 'easy']
message_count = 22.0
messages = ['207615', '209620', '209644', '209646', '209648', '209659', '209662', '209702', '224117', '224158', '224172', '224183', '224308', '224320', '224370', '224428', '224510', '224669', '224716', '224744', '224799', '224800']
nosy_count = 5.0
nosy_names = ['loewis', 'larry', 'python-dev', 'zach.ware', 'serhiy.storchaka']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue20170'
versions = ['Python 3.5']

[larryhastings]

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/posixmodule.c: 137 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

[larryhastings]

Submitting this just so I beat the deadline. I'm *about* half done, but I'm still working on it, so I'm just going to keep going--should only be another couple of hours.

(If somebody else pulls this stunt, I guess I'll accept their final patch too.)

[larryhastings]

Here's a complete patch, converts everything that I think should be converted for 3.4. With this patch applied, all unit tests pass on my 64-bit Linux box. I plan to also run tests with the buildbots before checking it in.

The patch... well, it's 14,000 lines. 409k bytes. Do we have any takers?

[larryhastings]

By the way, my plan is to turn on the file preset just before checkin. The patch is *much* easier to read without turning that on first; with the file preset, now you have to keep two windows in sync to compare calls to PyArg_*().

[larryhastings]

Sorry for the fresh update, but here's revision 3. Only changes:

• Gave os.access a -> bool return converter.

• Fixed up a lot of whitespace. Now, major "things" are separated by
  two empty lines, but removed whitespace between

    #ifdef HAVE_SOMETHING

and

/*[clinic input]
os.something

(I used to randomly have blank lines there. No more!)

[larryhastings]

Actually, forget about the file output preset. It wouldn't work for posixmodule. > 80% of the entry points are #ifdef conditional on platform functionality. Which means the Clinic generated stuff needs to be #ifdef too.

It wouldn't be that hard to add the ability to #ifdef your generated code... but then what? Should it generate an #endif too, right before the end of the block?

If it closed the #ifdef, then it'd look dumb:

    /*[clinic input]*
    ifdef HAVE_WHATNOT
    os.whatnot
    [clinic start generated code]*/
    #ifdef HAVE_WHATNOT
    ...
    static PyObject *
    os_whatnot(PyModuleType *)
    #endif /* HAVE_WHATNOT */
    /*[clinic end generated code: output=... ]*/
    #ifdef HAVE_WHATNOT
    {
        ...
    }
    #endif /* HAVE_WHATNOT */

If it didn't close the #ifdef, well, that looks dumb too:

    /*[clinic input]*
    ifdef HAVE_WHATNOT
    os.whatnot
    [clinic start generated code]*/
    #ifdef HAVE_WHATNOT
    ...
    static PyObject *
    os_whatnot(PyModuleType *)
    /*[clinic end generated code: output=... ]*/
    {
        ...
    }
    #endif /* HAVE_WHATNOT */

though maybe that's less dumb.

[serhiy-storchaka]

The curses module also has many conditionally implemented functions.

I think Argument Clinic can detect preprocessor instructions (#if/#ifdef/#ifndef/#else/#endif) and generate needed #if/#endif in generated file. This would be more robust than explicitly repeat condition in clinic declaration, because external conditions can be changed.