gh-116738: Make csv module thread-safe (gh-141365)

Added a critical section to protect the states of `ReaderObj` and `WriterObj` in the free-threading build. Without the critical sections, both new free-threading tests were crashing.
This commit is contained in:
Alper 2025-11-21 08:22:31 -08:00 committed by GitHub
parent f15f6d0ba3
commit fb26d9c2ef
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 81 additions and 9 deletions

View file

@ -0,0 +1,50 @@
import csv
import io
import unittest
from test.support import threading_helper
from test.support.threading_helper import run_concurrently
NTHREADS = 10
@threading_helper.requires_working_threading()
class TestCSV(unittest.TestCase):
def test_concurrent_reader_next(self):
input_rows = [f"{i},{i},{i}" for i in range(50)]
input_stream = io.StringIO("\n".join(input_rows))
reader = csv.reader(input_stream)
output_rows = []
def read_row():
for row in reader:
self.assertEqual(len(row), 3)
output_rows.append(",".join(row))
run_concurrently(worker_func=read_row, nthreads=NTHREADS)
self.assertSetEqual(set(input_rows), set(output_rows))
def test_concurrent_writer_writerow(self):
output_stream = io.StringIO()
writer = csv.writer(output_stream)
row_per_thread = 10
expected_rows = []
def write_row():
for i in range(row_per_thread):
writer.writerow([i, i, i])
expected_rows.append(f"{i},{i},{i}")
run_concurrently(worker_func=write_row, nthreads=NTHREADS)
# Rewind to the start of the stream and parse the rows
output_stream.seek(0)
output_rows = [line.strip() for line in output_stream.readlines()]
self.assertEqual(len(output_rows), NTHREADS * row_per_thread)
self.assertListEqual(sorted(output_rows), sorted(expected_rows))
if __name__ == "__main__":
unittest.main()

View file

@ -0,0 +1,2 @@
Make csv module thread-safe on the :term:`free threaded <free threading>`
build.

View file

@ -918,7 +918,7 @@ parse_reset(ReaderObj *self)
}
static PyObject *
Reader_iternext(PyObject *op)
Reader_iternext_lock_held(PyObject *op)
{
ReaderObj *self = _ReaderObj_CAST(op);
@ -985,6 +985,16 @@ Reader_iternext(PyObject *op)
return fields;
}
static PyObject *
Reader_iternext(PyObject *op)
{
PyObject *result;
Py_BEGIN_CRITICAL_SECTION(op);
result = Reader_iternext_lock_held(op);
Py_END_CRITICAL_SECTION();
return result;
}
static void
Reader_dealloc(PyObject *op)
{
@ -1303,15 +1313,8 @@ join_append_lineterminator(WriterObj *self)
return 1;
}
PyDoc_STRVAR(csv_writerow_doc,
"writerow($self, row, /)\n"
"--\n\n"
"Construct and write a CSV record from an iterable of fields.\n"
"\n"
"Non-string elements will be converted to string.");
static PyObject *
csv_writerow(PyObject *op, PyObject *seq)
csv_writerow_lock_held(PyObject *op, PyObject *seq)
{
WriterObj *self = _WriterObj_CAST(op);
DialectObj *dialect = self->dialect;
@ -1414,6 +1417,23 @@ csv_writerow(PyObject *op, PyObject *seq)
return result;
}
PyDoc_STRVAR(csv_writerow_doc,
"writerow($self, row, /)\n"
"--\n\n"
"Construct and write a CSV record from an iterable of fields.\n"
"\n"
"Non-string elements will be converted to string.");
static PyObject *
csv_writerow(PyObject *op, PyObject *seq)
{
PyObject *result;
Py_BEGIN_CRITICAL_SECTION(op);
result = csv_writerow_lock_held(op, seq);
Py_END_CRITICAL_SECTION();
return result;
}
PyDoc_STRVAR(csv_writerows_doc,
"writerows($self, rows, /)\n"
"--\n\n"