Move test_cases to stdlib/@tests/test_cases (#11865)

Author: srittau

pyrightconfig.json

@@ -7,7 +7,7 @@
     ],
     "exclude": [
         // test cases use a custom config file
-        "stubs/**/@tests/test_cases"
+        "**/@tests/test_cases",
     ],
     "typeCheckingMode": "strict",
     // Allowed in base settings for incomplete stubs, checked in stricter settings

pyrightconfig.stricter.json

@@ -7,7 +7,7 @@
     ],
     "exclude": [
         // test cases use a custom pyrightconfig file
-        "stubs/**/@tests/test_cases",
+        "**/@tests/test_cases",
         "stdlib/distutils/command",
         "stdlib/distutils/dist.pyi",
         "stdlib/importlib/readers.pyi",

pyrightconfig.testcases.json

@@ -2,8 +2,7 @@
     "$schema": "https://raw.githubusercontent.com/microsoft/pyright/main/packages/vscode-pyright/schemas/pyrightconfig.schema.json",
     "typeshedPath": ".",
     "include": [
-        "test_cases",
-        "stubs/**/@tests/test_cases"
+        "**/@tests/test_cases",
     ],
     "typeCheckingMode": "strict",
     // Extra strict settings

test_cases/stdlib/asyncio/check_coroutines.py renamed to stdlib/@tests/test_cases/asyncio/check_coroutines.py

@@ -15,6 +15,7 @@
 from parse_metadata import read_metadata
 from utils import (
     REQS_FILE,
+    STDLIB_PATH,
     TEST_CASES_DIR,
     TESTS_DIR,
     VERSIONS_RE,
@@ -59,7 +60,8 @@ def assert_consistent_filetypes(
 
 def check_stdlib() -> None:
     """Check that the stdlib directory contains only the correct files."""
-    assert_consistent_filetypes(Path("stdlib"), kind=".pyi", allowed={"_typeshed/README.md", "VERSIONS"})
+    assert_consistent_filetypes(STDLIB_PATH, kind=".pyi", allowed={"_typeshed/README.md", "VERSIONS", TESTS_DIR})
+    check_tests_dir(tests_path("stdlib"))
 
 
 def check_stubs() -> None:
@@ -81,11 +83,13 @@ def check_stubs() -> None:
 
         tests_dir = tests_path(dist.name)
         if tests_dir.exists() and tests_dir.is_dir():
-            py_files_present = any(file.suffix == ".py" for file in tests_dir.iterdir())
-            error_message = (
-                f"Test-case files must be in an `{TESTS_DIR}/{TEST_CASES_DIR}` directory, not in the `{TESTS_DIR}` directory"
-            )
-            assert not py_files_present, error_message
+            check_tests_dir(tests_dir)
+
+
+def check_tests_dir(tests_dir: Path) -> None:
+    py_files_present = any(file.suffix == ".py" for file in tests_dir.iterdir())
+    error_message = f"Test-case files must be in an `{TESTS_DIR}/{TEST_CASES_DIR}` directory, not in the `{TESTS_DIR}` directory"
+    assert not py_files_present, error_message
 
 
 def check_distutils() -> None:
@@ -146,7 +150,7 @@ def check_versions_file() -> None:
 
 def _find_stdlib_modules() -> set[str]:
     modules = set[str]()
-    for path, _, files in os.walk("stdlib"):
+    for path, _, files in os.walk(STDLIB_PATH):
         for filename in files:
             base_module = ".".join(os.path.normpath(path).split(os.sep)[1:])
             if filename == "__init__.pyi":

test_cases/stdlib/asyncio/check_gather.py renamed to stdlib/@tests/test_cases/asyncio/check_gather.py

@@ -29,6 +29,7 @@
 from parse_metadata import PackageDependencies, get_recursive_requirements, read_metadata
 from utils import (
     PYTHON_VERSION,
+    TESTS_DIR,
     VERSIONS_RE as VERSION_LINE_RE,
     colored,
     get_gitignore_spec,
@@ -366,7 +367,7 @@ def test_stdlib(args: TestConfig) -> TestResult:
     stdlib = Path("stdlib")
     supported_versions = parse_versions(stdlib / "VERSIONS")
     for name in os.listdir(stdlib):
-        if name == "VERSIONS" or name.startswith("."):
+        if name in ("VERSIONS", TESTS_DIR) or name.startswith("."):
             continue
         module = Path(name).stem
         module_min_version, module_max_version = supported_versions[module]

test_cases/stdlib/asyncio/check_task.py renamed to stdlib/@tests/test_cases/asyncio/check_task.py

@@ -22,6 +22,7 @@ def colored(text: str, color: str | None = None, **kwargs: Any) -> str:  # type:
 
 PYTHON_VERSION: Final = f"{sys.version_info.major}.{sys.version_info.minor}"
 
+STDLIB_PATH = Path("stdlib")
 STUBS_PATH = Path("stubs")
 
 
@@ -139,15 +140,14 @@ def distribution_info(distribution_name: str) -> DistributionTests:
 
 
 def tests_path(distribution_name: str) -> Path:
-    assert distribution_name != "stdlib"
-    return STUBS_PATH / distribution_name / TESTS_DIR
+    if distribution_name == "stdlib":
+        return STDLIB_PATH / TESTS_DIR
+    else:
+        return STUBS_PATH / distribution_name / TESTS_DIR
 
 
 def test_cases_path(distribution_name: str) -> Path:
-    if distribution_name == "stdlib":
-        return Path(TEST_CASES_DIR)
-    else:
-        return tests_path(distribution_name) / TEST_CASES_DIR
+    return tests_path(distribution_name) / TEST_CASES_DIR
 
 
 def get_all_testcase_directories() -> list[DistributionTests]: