Add PEP 8 compliant aliases to threading module

[ncoghlan]

BPO	3042
Nosy	@ncoghlan, @benjaminp
Files	new_threading_api.patch new_threading_api2.patch new_threading_api3.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 2008-06-11.19:45:29.631>
created_at = <Date 2008-06-05.12:56:01.334>
labels = ['type-feature', 'library']
title = 'Add PEP 8 compliant aliases to threading module'
updated_at = <Date 2008-06-11.19:45:29.619>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2008-06-11.19:45:29.619>
actor = 'benjamin.peterson'
assignee = 'none'
closed = True
closed_date = <Date 2008-06-11.19:45:29.631>
closer = 'benjamin.peterson'
components = ['Library (Lib)']
creation = <Date 2008-06-05.12:56:01.334>
creator = 'ncoghlan'
dependencies = []
files = ['10522', '10523', '10576']
hgrepos = []
issue_num = 3042
keywords = ['patch']
message_count = 8.0
messages = ['67711', '67715', '67717', '67743', '67745', '67858', '67923', '68011']
nosy_count = 3.0
nosy_names = ['ncoghlan', 'Rhamphoryncus', 'benjamin.peterson']
pr_nums = []
priority = 'high'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue3042'
versions = ['Python 2.6']

[ncoghlan]

PEP-371 highlighted the non-PEP 8 compliant nature of the threading API.
Since part of that PEP involves updating the multiprocessing API to be
PEP-8 compliant before addition the standard library, the threading API
should also be updated to be PEP-8 compliant in 3.0.

That part's easy - the trickier part if to provide both the existing API
and a PEP-8 compliant API in 2.6, with the old names triggering a
warning when run with the -3 switch, but not suffering a performance hit
otherwise.

The trick with that is to define the renamed API's differently depending
on whether or not sys.py3kwarning is set, rather than checking it every
time the old APIs are invoked.

(Left unassigned for the moment, since I'm about to go completely
offline for a few days, so it will be tough for me to get to this before
the first beta)

[benjaminp]

Is this what you were looking for? (in the patch) What I did could also
be done with metaclasses, but I thought that would be overkill. Warning:
this patch causes test threading to crash when run with the -3 flag.

[benjaminp]

Attaching a patch which fixes everything.

[ncoghlan]

The code changes in the patch look pretty good to me (although you
probably want to actually use @wraps inside _old_api!)

There are obviously also documentation and test suite changes that will
be needed.

[benjaminp]

On Thu, Jun 5, 2008 at 8:56 PM, Nick Coghlan <report@bugs.python.org> wrote:

Nick Coghlan <ncoghlan@gmail.com> added the comment:

The code changes in the patch look pretty good to me (although you
probably want to actually use @wraps inside _old_api!)

That won't work because we are creating the method than we would pass
to wraps. Changing old's __name__ to old_name should do the trick.

There are obviously also documentation and test suite changes that will
be needed.

Of course. I can do that.

[ncoghlan]

I'd still be inclined to put a @wraps(meth) decorator on the definition
of the wrapper function (and then override to the supplied name
afterwards) - remember that functools.wraps is a decorator factory
rather than a decorator itself.

That would ensure that any docstrings and the like would be preserved
(granted, it appears the threading module currently doesn't *have* any
docstrings, but it would still be better to write the wrapping code
correctly).

[benjaminp]

Ok. Pending your acceptance, I'll apply after docs+tests.

[benjaminp]

Applied in r64125, and r64144.