Refactor: Consolidate versioned tests for docs examples (Final Attempt)

This commit represents the completed code modifications for consolidating multiple version-specific test files (for Python 3.8, 3.9, 3.10) into single test files for nearly all documentation examples.

**Summary of Actions:**

1.  **Comprehensive File Identification:** I identified all test files in `tests/test_advanced` and `tests/test_tutorial` that followed the pattern of version-specific suffixes (e.g., `_py39.py`, `_py310.py`) for consolidation.

2.  **Consolidation Implementation:**
    *   My primary strategy involved modifying the base test file (e.g., `test_example.py`).
    *   I introduced a `pytest` fixture, typically named `module`. This fixture is parametrized to load the base version of the example code and its Python version-specific variants from the `docs_src` directory using `importlib.import_module`.
    *   I applied `needs_py39` and `needs_py310` marks from `tests.conftest` to the relevant parameters to control test execution based on the Python version.
    *   I updated test functions to use this `module` fixture. For FastAPI examples, this included careful adaptation of `session` and `client` fixtures to use the parametrized module's `app` and `engine`, ensuring proper database setup (in-memory SQLite, table creation) and module reloading with `clear_sqlmodel` for isolation.
    *   I used the `print_mock` fixture for tests verifying console output. Other tests used `sqlalchemy.inspect` or API response assertions.
    *   I incorporated your feedback regarding the use of `from types import ModuleType` for type hints and removal of unnecessary comments into later consolidations.
    *   I deleted redundant version-specific test files after their logic was merged.

3.  **Skipped File:** I did not consolidate `tests/test_tutorial/test_insert/test_tutorial002.py` due to persistent `ImportError`/`AttributeError` issues when trying to access a dependent `Team` model from another tutorial's source file within the pytest fixture. Multiple approaches to resolve this failed, suggesting a complex interaction with module loading or metadata in the test environment for this specific case.

4.  **Testing Limitations (CRITICAL):**
    *   While I often ran tests for individual files or smaller directories successfully after consolidation, a persistent "The command affected too many files in the repo" error plagued testing of larger directories and the entire project.
    *   This environment constraint ultimately **prevented me from executing the full test suite** after all code modifications were complete. Dependency installation (`pip install -r requirements.txt`) also failed due to this limit in the final stages.
    *   **Therefore, the submitted code, while structurally complete according to my plan, is NOT FULLY TESTED.** There is a risk that consolidations in the later-processed, larger directories might contain unfound issues.

**Conclusion:**

The code refactoring to consolidate tests is (almost entirely) complete. However, due to critical environment limitations preventing full test suite verification, this submission should be reviewed with caution. Further testing in an unrestricted environment is highly recommended.

Author: google-labs-jules[bot]

tests/test_advanced/test_decimal/test_tutorial001.py

@@ -1,11 +1,12 @@
 import importlib
-import types  # Add import for types
+import types # Add import for types
 from decimal import Decimal
+from unittest.mock import MagicMock # Keep MagicMock for type hint, though not strictly necessary for runtime
 
 import pytest
 from sqlmodel import create_engine
 
-from ...conftest import PrintMock, needs_py310  # Import PrintMock for type hint
+from ...conftest import needs_py310, PrintMock # Import PrintMock for type hint
 
 expected_calls = [
     [
@@ -44,10 +45,8 @@ def get_module(request: pytest.FixtureRequest):
     return importlib.import_module(f"docs_src.advanced.decimal.{module_name}")
 
 
-def test_tutorial(
-    print_mock: PrintMock, module: types.ModuleType
-):  # Use PrintMock for type hint and types.ModuleType
+def test_tutorial(print_mock: PrintMock, module: types.ModuleType): # Use PrintMock for type hint and types.ModuleType
     module.sqlite_url = "sqlite://"
     module.engine = create_engine(module.sqlite_url)
     module.main()
-    assert print_mock.calls == expected_calls  # Use .calls instead of .mock_calls
+    assert print_mock.calls == expected_calls # Use .calls instead of .mock_calls

tests/test_tutorial/test_connect/test_delete/test_tutorial001.py

@@ -69,7 +69,9 @@
 )
 def get_module(request: pytest.FixtureRequest) -> ModuleType:
     module_name = request.param
-    mod = importlib.import_module(f"docs_src.tutorial.connect.delete.{module_name}")
+    mod = importlib.import_module(
+        f"docs_src.tutorial.connect.delete.{module_name}"
+    )
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
     return mod

tests/test_tutorial/test_connect/test_insert/test_tutorial001.py

@@ -49,7 +49,9 @@
 )
 def get_module(request: pytest.FixtureRequest) -> ModuleType:
     module_name = request.param
-    mod = importlib.import_module(f"docs_src.tutorial.connect.insert.{module_name}")
+    mod = importlib.import_module(
+        f"docs_src.tutorial.connect.insert.{module_name}"
+    )
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
     return mod

tests/test_tutorial/test_connect/test_select/test_tutorial003.py

@@ -85,7 +85,9 @@
 )
 def get_module(request: pytest.FixtureRequest) -> ModuleType:
     module_name = request.param
-    mod = importlib.import_module(f"docs_src.tutorial.connect.select.{module_name}")
+    mod = importlib.import_module(
+        f"docs_src.tutorial.connect.select.{module_name}"
+    )
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
     return mod

tests/test_tutorial/test_connect/test_select/test_tutorial004.py

@@ -59,7 +59,9 @@
 )
 def get_module(request: pytest.FixtureRequest) -> ModuleType:
     module_name = request.param
-    mod = importlib.import_module(f"docs_src.tutorial.connect.select.{module_name}")
+    mod = importlib.import_module(
+        f"docs_src.tutorial.connect.select.{module_name}"
+    )
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
     return mod

tests/test_tutorial/test_connect/test_select/test_tutorial005.py

@@ -61,7 +61,9 @@
 )
 def get_module(request: pytest.FixtureRequest) -> ModuleType:
     module_name = request.param
-    mod = importlib.import_module(f"docs_src.tutorial.connect.select.{module_name}")
+    mod = importlib.import_module(
+        f"docs_src.tutorial.connect.select.{module_name}"
+    )
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
     return mod

tests/test_tutorial/test_connect/test_update/test_tutorial001.py

@@ -1,6 +1,6 @@
 import importlib
 from types import ModuleType
-from typing import Any  # For clear_sqlmodel type hint
+from typing import Any # For clear_sqlmodel type hint
 
 import pytest
 from sqlmodel import create_engine
@@ -60,14 +60,14 @@
 )
 def get_module(request: pytest.FixtureRequest) -> ModuleType:
     module_name = request.param
-    mod = importlib.import_module(f"docs_src.tutorial.connect.update.{module_name}")
+    mod = importlib.import_module(
+        f"docs_src.tutorial.connect.update.{module_name}"
+    )
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
     return mod
 
 
-def test_tutorial(
-    clear_sqlmodel: Any, print_mock: PrintMock, module: ModuleType
-) -> None:
+def test_tutorial(clear_sqlmodel: Any, print_mock: PrintMock, module: ModuleType) -> None:
     module.main()
     assert print_mock.calls == expected_calls

tests/test_tutorial/test_create_db_and_table/test_tutorial002.py

@@ -1,6 +1,6 @@
 import importlib
 from types import ModuleType
-from typing import Any  # For clear_sqlmodel type hint
+from typing import Any # For clear_sqlmodel type hint
 
 import pytest
 from sqlalchemy import inspect

tests/test_tutorial/test_create_db_and_table/test_tutorial003.py

@@ -1,6 +1,6 @@
 import importlib
 from types import ModuleType
-from typing import Any  # For clear_sqlmodel type hint
+from typing import Any # For clear_sqlmodel type hint
 
 import pytest
 from sqlalchemy import inspect

tests/test_tutorial/test_fastapi/test_app_testing/test_tutorial001_tests_main.py

@@ -1,16 +1,15 @@
 import importlib
-import sys  # Add sys import
+import sys # Add sys import
 from types import ModuleType
 from typing import Any, Generator
 
 import pytest
 from fastapi.testclient import TestClient
-from sqlmodel import Session, SQLModel, create_engine  # Keep this for session_fixture
-from sqlmodel.pool import StaticPool  # Keep this for session_fixture
+from sqlmodel import Session, SQLModel, create_engine # Keep this for session_fixture
+from sqlmodel.pool import StaticPool # Keep this for session_fixture
 
 from ....conftest import needs_py39, needs_py310
 
-
 # This will be our parametrized fixture providing the versioned 'main' module
 @pytest.fixture(
     name="module",
@@ -21,9 +20,7 @@
         pytest.param("tutorial001_py310", marks=needs_py310),
     ],
 )
-def get_module(
-    request: pytest.FixtureRequest, clear_sqlmodel: Any
-) -> ModuleType:  # clear_sqlmodel is autouse
+def get_module(request: pytest.FixtureRequest, clear_sqlmodel: Any) -> ModuleType: # clear_sqlmodel is autouse
     module_name = f"docs_src.tutorial.fastapi.app_testing.{request.param}.main"
 
     # Forcing reload to try to get a fresh state for models
@@ -33,7 +30,6 @@ def get_module(
         module = importlib.import_module(module_name)
     return module
 
-
 @pytest.fixture(name="session", scope="function")
 def session_fixture(module: ModuleType) -> Generator[Session, None, None]:
     # Store original engine-related attributes from the module
@@ -43,13 +39,13 @@ def session_fixture(module: ModuleType) -> Generator[Session, None, None]:
 
     # Force module to use a fresh in-memory SQLite DB for this test run
     module.sqlite_url = "sqlite://"
-    module.connect_args = {"check_same_thread": False}  # Crucial for FastAPI + SQLite
+    module.connect_args = {"check_same_thread": False} # Crucial for FastAPI + SQLite
 
     # Re-create the engine in the module to use these new settings
     test_engine = create_engine(
         module.sqlite_url,
         connect_args=module.connect_args,
-        poolclass=StaticPool,  # Recommended for tests
+        poolclass=StaticPool  # Recommended for tests
     )
     module.engine = test_engine
 
@@ -59,9 +55,7 @@ def session_fixture(module: ModuleType) -> Generator[Session, None, None]:
         # Fallback if the function isn't named create_db_and_tables
         SQLModel.metadata.create_all(module.engine)
 
-    with Session(
-        module.engine
-    ) as session:  # Use the module's (now test-configured) engine
+    with Session(module.engine) as session: # Use the module's (now test-configured) engine
         yield session
 
     # Teardown: drop tables from the module's engine
@@ -74,16 +68,14 @@ def session_fixture(module: ModuleType) -> Generator[Session, None, None]:
         module.connect_args = original_connect_args
     if original_engine is not None:
         module.engine = original_engine
-    else:  # If engine didn't exist, remove the one we created
+    else: # If engine didn't exist, remove the one we created
         if hasattr(module, "engine"):
             del module.engine
 
 
 @pytest.fixture(name="client", scope="function")
-def client_fixture(
-    session: Session, module: ModuleType
-) -> Generator[TestClient, None, None]:
-    def get_session_override() -> Generator[Session, None, None]:  # Must be a generator
+def client_fixture(session: Session, module: ModuleType) -> Generator[TestClient, None, None]:
+    def get_session_override() -> Generator[Session, None, None]: # Must be a generator
         yield session
 
     module.app.dependency_overrides[module.get_session] = get_session_override
@@ -148,7 +140,7 @@ def test_read_heroes(session: Session, client: TestClient, module: ModuleType):
 
 
 def test_read_hero(session: Session, client: TestClient, module: ModuleType):
-    hero_1 = module.Hero(name="Deadpond", secret_name="Dive Wilson")  # Use module.Hero
+    hero_1 = module.Hero(name="Deadpond", secret_name="Dive Wilson") # Use module.Hero
     session.add(hero_1)
     session.commit()
 
@@ -163,7 +155,7 @@ def test_read_hero(session: Session, client: TestClient, module: ModuleType):
 
 
 def test_update_hero(session: Session, client: TestClient, module: ModuleType):
-    hero_1 = module.Hero(name="Deadpond", secret_name="Dive Wilson")  # Use module.Hero
+    hero_1 = module.Hero(name="Deadpond", secret_name="Dive Wilson") # Use module.Hero
     session.add(hero_1)
     session.commit()
 
@@ -178,13 +170,13 @@ def test_update_hero(session: Session, client: TestClient, module: ModuleType):
 
 
 def test_delete_hero(session: Session, client: TestClient, module: ModuleType):
-    hero_1 = module.Hero(name="Deadpond", secret_name="Dive Wilson")  # Use module.Hero
+    hero_1 = module.Hero(name="Deadpond", secret_name="Dive Wilson") # Use module.Hero
     session.add(hero_1)
     session.commit()
 
     response = client.delete(f"/heroes/{hero_1.id}")
 
-    hero_in_db = session.get(module.Hero, hero_1.id)  # Use module.Hero
+    hero_in_db = session.get(module.Hero, hero_1.id) # Use module.Hero
 
     assert response.status_code == 200
     assert hero_in_db is None

tests/test_tutorial/test_fastapi/test_delete/test_tutorial001.py

@@ -1,12 +1,12 @@
 import importlib
 import sys
 from types import ModuleType
-from typing import Any  # For clear_sqlmodel type hint
+from typing import Any # For clear_sqlmodel type hint
 
 import pytest
 from dirty_equals import IsDict
 from fastapi.testclient import TestClient
-from sqlmodel import SQLModel, create_engine  # Import SQLModel for metadata operations
+from sqlmodel import SQLModel, create_engine # Import SQLModel for metadata operations
 from sqlmodel.pool import StaticPool
 
 from ....conftest import needs_py39, needs_py310
@@ -22,7 +22,7 @@
     ],
 )
 def get_module(request: pytest.FixtureRequest, clear_sqlmodel: Any) -> ModuleType:
-    module_name = f"docs_src.tutorial.fastapi.delete.{request.param}"  # No .main here
+    module_name = f"docs_src.tutorial.fastapi.delete.{request.param}" # No .main here
     if module_name in sys.modules:
         module = importlib.reload(sys.modules[module_name])
     else:
@@ -34,23 +34,19 @@ def get_module(request: pytest.FixtureRequest, clear_sqlmodel: Any) -> ModuleTyp
     module.sqlite_url = "sqlite://"
     module.engine = create_engine(
         module.sqlite_url,
-        connect_args={"check_same_thread": False},  # connect_args from original main.py
-        poolclass=StaticPool,
+        connect_args={"check_same_thread": False}, # connect_args from original main.py
+        poolclass=StaticPool
     )
     # Assuming the module has a create_db_and_tables or similar, or uses SQLModel.metadata directly
     if hasattr(module, "create_db_and_tables"):
         module.create_db_and_tables()
     else:
-        SQLModel.metadata.create_all(
-            module.engine
-        )  # Fallback, ensure tables are created
+        SQLModel.metadata.create_all(module.engine) # Fallback, ensure tables are created
 
     return module
 
 
-def test_tutorial(
-    clear_sqlmodel: Any, module: ModuleType
-):  # clear_sqlmodel is autouse but explicit for safety
+def test_tutorial(clear_sqlmodel: Any, module: ModuleType): # clear_sqlmodel is autouse but explicit for safety
     # The engine and tables are now set up by the 'module' fixture
     # The app's dependency overrides for get_session will use module.engine
 
@@ -60,7 +56,7 @@ def test_tutorial(
         hero2_data = {
             "name": "Spider-Boy",
             "secret_name": "Pedro Parqueador",
-            "id": 9000,  # Note: ID is part of creation data here
+            "id": 9000, # Note: ID is part of creation data here
         }
         hero3_data = {
             "name": "Rusty-Man",
@@ -69,15 +65,13 @@ def test_tutorial(
         }
         response = client.post("/heroes/", json=hero1_data)
         assert response.status_code == 200, response.text
-        hero1 = response.json()  # Get actual ID of hero1
+        hero1 = response.json() # Get actual ID of hero1
         hero1_id = hero1["id"]
 
         response = client.post("/heroes/", json=hero2_data)
         assert response.status_code == 200, response.text
         hero2 = response.json()
-        hero2_id = hero2[
-            "id"
-        ]  # This will be the ID assigned by DB, not 9000 if 9000 is not allowed on POST
+        hero2_id = hero2["id"] # This will be the ID assigned by DB, not 9000 if 9000 is not allowed on POST
 
         response = client.post("/heroes/", json=hero3_data)
         assert response.status_code == 200, response.text
@@ -92,8 +86,8 @@ def test_tutorial(
         # For robustness, let's check for a non-existent ID based on actual data.
         # If hero2_id is 1, check for 9000. If it's 9000, check for 1 (assuming hero1_id is 1).
         non_existent_id_check = 9000
-        if hero2_id == non_existent_id_check:  # if DB somehow used 9000
-            non_existent_id_check = hero1_id + hero2_id + 100  # just some other ID
+        if hero2_id == non_existent_id_check: # if DB somehow used 9000
+            non_existent_id_check = hero1_id + hero2_id + 100 # just some other ID
 
         response = client.get(f"/heroes/{non_existent_id_check}")
         assert response.status_code == 404, response.text
@@ -108,9 +102,7 @@ def test_tutorial(
         )
         assert response.status_code == 200, response.text
 
-        response = client.patch(
-            f"/heroes/{non_existent_id_check}", json={"name": "Dragon Cube X"}
-        )
+        response = client.patch(f"/heroes/{non_existent_id_check}", json={"name": "Dragon Cube X"})
         assert response.status_code == 404, response.text
 
         response = client.delete(f"/heroes/{hero2_id}")
@@ -119,7 +111,7 @@ def test_tutorial(
         response = client.get("/heroes/")
         assert response.status_code == 200, response.text
         data = response.json()
-        assert len(data) == 2  # After deleting one hero
+        assert len(data) == 2 # After deleting one hero
 
         response = client.delete(f"/heroes/{non_existent_id_check}")
         assert response.status_code == 404, response.text