threading.Lock().acquire bug

[fionalim]

BPO	536017
Nosy	@tim-one, @loewis

^{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/tim-one'
closed_at = <Date 2002-03-31.18:30:35.000>
created_at = <Date 2002-03-28.02:02:38.000>
labels = ['interpreter-core']
title = 'threading.Lock().acquire bug'
updated_at = <Date 2002-03-31.18:30:35.000>
user = 'https://bugs.python.org/fionalim'

bugs.python.org fields:

activity = <Date 2002-03-31.18:30:35.000>
actor = 'tim.peters'
assignee = 'tim.peters'
closed = True
closed_date = None
closer = None
components = ['Interpreter Core']
creation = <Date 2002-03-28.02:02:38.000>
creator = 'fionalim'
dependencies = []
files = []
hgrepos = []
issue_num = 536017
keywords = []
message_count = 4.0
messages = ['10077', '10078', '10079', '10080']
nosy_count = 3.0
nosy_names = ['tim.peters', 'loewis', 'fionalim']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue536017'
versions = []

[fionalim]

According to the online documentation for threading
Lock objects, setting blocking=0 will produce a
non-blocking call.
But trying it in the command line causes the execution
to hang.
>>> import threading
>>> lock = threading.Lock()
>>> lock.acquire(blocking=0)
>>> lock.acquire(blocking=0)
[blocks]

---

internal documentation claims that the keyword is wait,
but using wait produces the same problem:

>>> import threading
>>> lock = threading.Lock()
>>> lock.acquire.__doc__
'acquire([wait]) -> None or
Boolean\n(PyThread_acquire_lock() is an obsolete
synonym)\n\nLock the lock.  Without argument, this
blocks if the lock is already\nlocked (even by the same
thread), waiting for another thread to release\nthe
lock, and return None when the lock is acquired.\nWith
a Boolean argument, this will only block if the
argument is true,\nand the return value reflects
whether the lock is acquired.\nThe blocking operation
is not interruptible.'
>>> lock.acquire(wait=0)
>>> lock.acquire(wait=0)
[blocks]

---------------------------------
Not using a keyword works fine:
>>> import threading
>>> lock = threading.Lock()
>>> lock.acquire(0)
1
>>> lock.acquire(0)
0
>>>

[tim-one]

Logged In: YES
user_id=31435

Changed to docs and assigned to Fred for comment. Any idea
how we can make this clearer? The docs don't claim this
accepts a keyword argument, and lots of C functions simply
ignore any keyword arguments that may be given.

[loewis]

Logged In: YES
user_id=21627

This is fixed in Python 2.2; it will raise an exception
"acquire() takes no keyword arguments". That should make it
immediately clear how to read the documentation.

[tim-one]

Logged In: YES
user_id=31435

Thanks, Martin! Since this is already much better in 2.2,
I'll take responsibility for closing it as Fixed.