gh-138013: Move I/O tests to test_io (#138365)

Centralize `io` tests into the `test_io` module so they are easier to
find and work on. This will make it easier to split `test_general` which
takes 30+ seconds in a debug build on my machine.

This renames `test_bufio` to be `test_bufferedio` so that it matches
the implementation file name (`bufferedio.c`).

Validation performed:
Tests are run in parallel after change:

```bash
./python.exe -m test test_io  -uall,largefile,extralargefile -M12G -j8
```

Docstring reformat in `test_io/__init__.py` looks reasonable:

```python
>>> import test.test_io
>>> help(test.test_io)
```

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

diff --git a/Lib/test/libregrtest/findtests.py b/Lib/test/libregrtest/findtests.py
index f01c1240774707207a5d3300e548bb42bccc3895..79afaf9083ae596efd15c03e33a186c319de635c 100644 (file)
--- a/Lib/test/libregrtest/findtests.py
+++ b/Lib/test/libregrtest/findtests.py
@@ -24,6 +24,7 @@ SPLITTESTDIRS: set[TestName] = {
     "test_future_stmt",
     "test_gdb",
     "test_inspect",
+    "test_io",
     "test_pydoc",
     "test_multiprocessing_fork",
     "test_multiprocessing_forkserver",

diff --git a/Lib/test/test_io/__init__.py b/Lib/test/test_io/__init__.py
index 4b16ecc31156a512db4a28fe272e5339994a4538..c94fad3e779381dcf6c67cf6cfd1fb0c3cb58a1d 100644 (file)
--- a/Lib/test/test_io/__init__.py
+++ b/Lib/test/test_io/__init__.py
@@ -1,3 +1,26 @@
+"""Tests for the io module and its implementations (_io and _pyio)
+
+Tests are split across multiple files to increase
+parallelism and focus on specific implementation pieces.
+
+* test_io
+  * test_bufferedio - tests file buffering
+  * test_memoryio - tests BytesIO and StringIO
+  * test_fileio - tests FileIO
+  * test_file - tests the file interface
+  * test_general - tests everything else in the io module
+  * test_univnewlines - tests universal newline support
+  * test_largefile - tests operations on a file greater than 2**32 bytes
+    (only enabled with -ulargefile)
+* test_free_threading/test_io - tests thread safety of io objects
+
+.. attention::
+   When writing tests for io, it's important to test both the C and Python
+   implementations. This is usually done by writing a base test that refers to
+   the type it is testing as an attribute. Then it provides custom subclasses to
+   test both implementations. This directory contains lots of examples.
+"""
+
 import os
 from test.support import load_package_tests
 

diff --git a/Lib/test/test_bufio.py b/Lib/test/test_io/test_bufferedio.py
similarity index 100%
rename from Lib/test/test_bufio.py
rename to Lib/test/test_io/test_bufferedio.py

diff --git a/Lib/test/test_file.py b/Lib/test/test_io/test_file.py
similarity index 100%
rename from Lib/test/test_file.py
rename to Lib/test/test_io/test_file.py

diff --git a/Lib/test/test_fileio.py b/Lib/test/test_io/test_fileio.py
similarity index 100%
rename from Lib/test/test_fileio.py
rename to Lib/test/test_io/test_fileio.py

diff --git a/Lib/test/test_io/test_general.py b/Lib/test/test_io/test_general.py
index e3d7d26a7e0f9c46df530fdd7a0718d569275a7a..30fe1e2f866091a252d73222eb511437c823731b 100644 (file)
--- a/Lib/test/test_io/test_general.py
+++ b/Lib/test/test_io/test_general.py
@@ -1,24 +1,7 @@
-"""Unit tests for the io module."""
-
-# Tests of io are scattered over the test suite:
-# * test_bufio - tests file buffering
-# * test_memoryio - tests BytesIO and StringIO
-# * test_fileio - tests FileIO
-# * test_file - tests the file interface
-# * test_io.test_general - tests everything else in the io module
-# * test_univnewlines - tests universal newline support
-# * test_largefile - tests operations on a file greater than 2**32 bytes
-#     (only enabled with -ulargefile)
-# * test_free_threading/test_io - tests thread safety of io objects
-
-################################################################################
-# ATTENTION TEST WRITERS!!!
-################################################################################
-# When writing tests for io, it's important to test both the C and Python
-# implementations. This is usually done by writing a base test that refers to
-# the type it is testing as an attribute. Then it provides custom subclasses to
-# test both implementations. This file has lots of examples.
-################################################################################
+"""General tests for the io module.
+
+New tests should go in more specific modules; see test_io/__init__.py
+"""
 
 import abc
 import array

diff --git a/Lib/test/test_largefile.py b/Lib/test/test_io/test_largefile.py
similarity index 100%
rename from Lib/test/test_largefile.py
rename to Lib/test/test_io/test_largefile.py

diff --git a/Lib/test/test_memoryio.py b/Lib/test/test_io/test_memoryio.py
similarity index 100%
rename from Lib/test/test_memoryio.py
rename to Lib/test/test_io/test_memoryio.py

diff --git a/Lib/test/test_univnewlines.py b/Lib/test/test_io/test_univnewlines.py
similarity index 100%
rename from Lib/test/test_univnewlines.py
rename to Lib/test/test_io/test_univnewlines.py