Skip to content

gh-134087: enforce signature of threading.RLock #134178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Doc/whatsnew/3.15.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,15 @@ sysconfig
(Contributed by Filipe Laíns in :gh:`92897`.)


threading
---------

* Remove support for arbitrary positional or keyword arguments in the C
implementation of :class:`~threading.RLock` objects. This was deprecated
in Python 3.14.
(Contributed by Bénédikt Tran in :gh:`134087`.)


typing
------

Expand Down
5 changes: 5 additions & 0 deletions Lib/test/lock_tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,11 @@ def test_constructor(self):
lock = self.locktype()
del lock

def test_constructor_noargs(self):
self.assertRaises(TypeError, self.locktype, 1)
self.assertRaises(TypeError, self.locktype, x=1)
self.assertRaises(TypeError, self.locktype, 1, x=2)

def test_repr(self):
lock = self.locktype()
self.assertRegex(repr(lock), "<unlocked .* object (.*)?at .*>")
Expand Down
6 changes: 4 additions & 2 deletions Lib/test/test_threading.py
Original file line number Diff line number Diff line change
Expand Up @@ -2137,8 +2137,7 @@ def test_signature(self): # gh-102029
]
for args, kwargs in arg_types:
with self.subTest(args=args, kwargs=kwargs):
with self.assertWarns(DeprecationWarning):
threading.RLock(*args, **kwargs)
self.assertRaises(TypeError, threading.RLock, *args, **kwargs)

# Subtypes with custom `__init__` are allowed (but, not recommended):
class CustomRLock(self.locktype):
Expand All @@ -2156,6 +2155,9 @@ class ConditionAsRLockTests(lock_tests.RLockTests):
# Condition uses an RLock by default and exports its API.
locktype = staticmethod(threading.Condition)

def test_constructor_noargs(self):
self.skipTest("Condition allows positional arguments")

def test_recursion_count(self):
self.skipTest("Condition does not expose _recursion_count()")

Expand Down
13 changes: 3 additions & 10 deletions Lib/threading.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ def gettrace():

Lock = _LockType

def RLock(*args, **kwargs):
def RLock():
"""Factory function that returns a new reentrant lock.

A reentrant lock must be released by the thread that acquired it. Once a
Expand All @@ -132,16 +132,9 @@ def RLock(*args, **kwargs):
acquired it.

"""
if args or kwargs:
import warnings
warnings.warn(
'Passing arguments to RLock is deprecated and will be removed in 3.15',
DeprecationWarning,
stacklevel=2,
)
if _CRLock is None:
return _PyRLock(*args, **kwargs)
return _CRLock(*args, **kwargs)
return _PyRLock()
return _CRLock()

class _RLock:
"""This class implements reentrant lock objects.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Remove support for arbitrary positional or keyword arguments in the C
implementation of :class:`threading.RLock` objects. This was deprecated
since Python 3.14. Patch by Bénédikt Tran.
82 changes: 43 additions & 39 deletions Modules/_threadmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@
# include <signal.h> // SIGINT
#endif

#include "clinic/_threadmodule.c.h"

// ThreadError is just an alias to PyExc_RuntimeError
#define ThreadError PyExc_RuntimeError

Expand All @@ -31,6 +29,7 @@ static struct PyModuleDef thread_module;
typedef struct {
PyTypeObject *excepthook_type;
PyTypeObject *lock_type;
PyTypeObject *rlock_type;
PyTypeObject *local_type;
PyTypeObject *local_dummy_type;
PyTypeObject *thread_handle_type;
Expand All @@ -48,6 +47,17 @@ get_thread_state(PyObject *module)
return (thread_module_state *)state;
}

static inline thread_module_state*
get_thread_state_by_cls(PyTypeObject *cls)
{
// Use PyType_GetModuleByDef() to handle (R)Lock subclasses.
PyObject *module = PyType_GetModuleByDef(cls, &thread_module);
if (module == NULL) {
return NULL;
}
return get_thread_state(module);
}


#ifdef MS_WINDOWS
typedef HRESULT (WINAPI *PF_GET_THREAD_DESCRIPTION)(HANDLE, PCWSTR*);
Expand All @@ -59,9 +69,14 @@ static PF_SET_THREAD_DESCRIPTION pSetThreadDescription = NULL;

/*[clinic input]
module _thread
class _thread.lock "lockobject *" "clinic_state()->lock_type"
class _thread.RLock "rlockobject *" "clinic_state()->rlock_type"
[clinic start generated code]*/
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=be8dbe5cc4b16df7]*/
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=c5a0f8c492a0c263]*/

#define clinic_state() get_thread_state_by_cls(type)
#include "clinic/_threadmodule.c.h"
#undef clinic_state

// _ThreadHandle type

Expand Down Expand Up @@ -916,25 +931,21 @@ lock__at_fork_reinit(PyObject *op, PyObject *Py_UNUSED(dummy))
}
#endif /* HAVE_FORK */

static lockobject *newlockobject(PyObject *module);
/*[clinic input]
@classmethod
_thread.lock.__new__ as lock_new
[clinic start generated code]*/

static PyObject *
lock_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
lock_new_impl(PyTypeObject *type)
/*[clinic end generated code: output=eab660d5a4c05c8a input=260208a4e277d250]*/
{
// convert to AC?
if (!_PyArg_NoKeywords("lock", kwargs)) {
goto error;
}
if (!_PyArg_CheckPositional("lock", PyTuple_GET_SIZE(args), 0, 0)) {
goto error;
lockobject *self = (lockobject *)type->tp_alloc(type, 0);
if (self == NULL) {
return NULL;
}

PyObject *module = PyType_GetModuleByDef(type, &thread_module);
assert(module != NULL);
return (PyObject *)newlockobject(module);

error:
return NULL;
self->lock = (PyMutex){0};
return (PyObject *)self;
}


Expand Down Expand Up @@ -1186,8 +1197,14 @@ PyDoc_STRVAR(rlock_is_owned_doc,
\n\
For internal use by `threading.Condition`.");

/*[clinic input]
@classmethod
_thread.RLock.__new__ as rlock_new
[clinic start generated code]*/

static PyObject *
rlock_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
rlock_new_impl(PyTypeObject *type)
/*[clinic end generated code: output=bb4fb1edf6818df5 input=013591361bf1ac6e]*/
{
rlockobject *self = (rlockobject *) type->tp_alloc(type, 0);
if (self == NULL) {
Expand Down Expand Up @@ -1267,20 +1284,6 @@ static PyType_Spec rlock_type_spec = {
.slots = rlock_type_slots,
};

static lockobject *
newlockobject(PyObject *module)
{
thread_module_state *state = get_thread_state(module);

PyTypeObject *type = state->lock_type;
lockobject *self = (lockobject *)type->tp_alloc(type, 0);
if (self == NULL) {
return NULL;
}
self->lock = (PyMutex){0};
return self;
}

/* Thread-local objects */

/* Quick overview:
Expand Down Expand Up @@ -2035,7 +2038,8 @@ Note: the default signal handler for SIGINT raises ``KeyboardInterrupt``."
static PyObject *
thread_PyThread_allocate_lock(PyObject *module, PyObject *Py_UNUSED(ignored))
{
return (PyObject *) newlockobject(module);
thread_module_state *state = get_thread_state(module);
return lock_new_impl(state->lock_type);
}

PyDoc_STRVAR(allocate_lock_doc,
Expand Down Expand Up @@ -2645,15 +2649,13 @@ thread_module_exec(PyObject *module)
}

// RLock
PyTypeObject *rlock_type = (PyTypeObject *)PyType_FromSpec(&rlock_type_spec);
if (rlock_type == NULL) {
state->rlock_type = (PyTypeObject *)PyType_FromModuleAndSpec(module, &rlock_type_spec, NULL);
if (state->rlock_type == NULL) {
return -1;
}
if (PyModule_AddType(module, rlock_type) < 0) {
Py_DECREF(rlock_type);
if (PyModule_AddType(module, state->rlock_type) < 0) {
return -1;
}
Py_DECREF(rlock_type);

// Local dummy
state->local_dummy_type = (PyTypeObject *)PyType_FromSpec(&local_dummy_type_spec);
Expand Down Expand Up @@ -2740,6 +2742,7 @@ thread_module_traverse(PyObject *module, visitproc visit, void *arg)
thread_module_state *state = get_thread_state(module);
Py_VISIT(state->excepthook_type);
Py_VISIT(state->lock_type);
Py_VISIT(state->rlock_type);
Py_VISIT(state->local_type);
Py_VISIT(state->local_dummy_type);
Py_VISIT(state->thread_handle_type);
Expand All @@ -2752,6 +2755,7 @@ thread_module_clear(PyObject *module)
thread_module_state *state = get_thread_state(module);
Py_CLEAR(state->excepthook_type);
Py_CLEAR(state->lock_type);
Py_CLEAR(state->rlock_type);
Py_CLEAR(state->local_type);
Py_CLEAR(state->local_dummy_type);
Py_CLEAR(state->thread_handle_type);
Expand Down
50 changes: 48 additions & 2 deletions Modules/clinic/_threadmodule.c.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading