✅ Simplify tests for code examples, one test file for multiple variants (#1664)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

tests/test_tutorial/test_one/test_tutorial001.py

@@ -1,22 +1,29 @@
-from unittest.mock import patch
+import importlib
+from types import ModuleType
 
+import pytest
 from sqlmodel import create_engine
 
-from ...conftest import get_testing_print_function
+from ...conftest import PrintMock, needs_py310
 
 
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial001 as mod
-
+@pytest.fixture(
+    name="mod",
+    params=[
+        "tutorial001",
+        pytest.param("tutorial001_py310", marks=needs_py310),
+    ],
+)
+def get_module(request: pytest.FixtureRequest) -> ModuleType:
+    mod = importlib.import_module(f"docs_src.tutorial.one.{request.param}")
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
-    calls = []
+    return mod
 
-    new_print = get_testing_print_function(calls)
 
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [
+def test_tutorial(print_mock: PrintMock, mod: ModuleType):
+    mod.main()
+    assert print_mock.calls == [
         [
             "Hero:",
             {

tests/test_tutorial/test_one/test_tutorial001_py310.py

@@ -1,30 +0,0 @@
-from unittest.mock import patch
-
-from sqlmodel import create_engine
-
-from ...conftest import get_testing_print_function, needs_py310
-
-
-@needs_py310
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial001_py310 as mod
-
-    mod.sqlite_url = "sqlite://"
-    mod.engine = create_engine(mod.sqlite_url)
-    calls = []
-
-    new_print = get_testing_print_function(calls)
-
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [
-        [
-            "Hero:",
-            {
-                "name": "Tarantula",
-                "secret_name": "Natalia Roman-on",
-                "age": 32,
-                "id": 4,
-            },
-        ]
-    ]

tests/test_tutorial/test_one/test_tutorial002.py

@@ -1,19 +1,26 @@
-from unittest.mock import patch
+import importlib
+from types import ModuleType
 
+import pytest
 from sqlmodel import create_engine
 
-from ...conftest import get_testing_print_function
+from ...conftest import PrintMock, needs_py310
 
 
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial002 as mod
-
+@pytest.fixture(
+    name="mod",
+    params=[
+        "tutorial002",
+        pytest.param("tutorial002_py310", marks=needs_py310),
+    ],
+)
+def get_module(request: pytest.FixtureRequest) -> ModuleType:
+    mod = importlib.import_module(f"docs_src.tutorial.one.{request.param}")
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
-    calls = []
+    return mod
 
-    new_print = get_testing_print_function(calls)
 
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [["Hero:", None]]
+def test_tutorial(print_mock: PrintMock, mod: ModuleType):
+    mod.main()
+    assert print_mock.calls == [["Hero:", None]]

tests/test_tutorial/test_one/test_tutorial002_py310.py

@@ -1,20 +0,0 @@
-from unittest.mock import patch
-
-from sqlmodel import create_engine
-
-from ...conftest import get_testing_print_function, needs_py310
-
-
-@needs_py310
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial002_py310 as mod
-
-    mod.sqlite_url = "sqlite://"
-    mod.engine = create_engine(mod.sqlite_url)
-    calls = []
-
-    new_print = get_testing_print_function(calls)
-
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [["Hero:", None]]

tests/test_tutorial/test_one/test_tutorial003.py

@@ -1,22 +1,29 @@
-from unittest.mock import patch
+import importlib
+from types import ModuleType
 
+import pytest
 from sqlmodel import create_engine
 
-from ...conftest import get_testing_print_function
+from ...conftest import PrintMock, needs_py310
 
 
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial003 as mod
-
+@pytest.fixture(
+    name="mod",
+    params=[
+        "tutorial003",
+        pytest.param("tutorial003_py310", marks=needs_py310),
+    ],
+)
+def get_module(request: pytest.FixtureRequest) -> ModuleType:
+    mod = importlib.import_module(f"docs_src.tutorial.one.{request.param}")
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
-    calls = []
+    return mod
 
-    new_print = get_testing_print_function(calls)
 
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [
+def test_tutorial(print_mock: PrintMock, mod: ModuleType):
+    mod.main()
+    assert print_mock.calls == [
         [
             "Hero:",
             {"name": "Deadpond", "secret_name": "Dive Wilson", "age": None, "id": 1},

tests/test_tutorial/test_one/test_tutorial003_py310.py

@@ -1,25 +0,0 @@
-from unittest.mock import patch
-
-from sqlmodel import create_engine
-
-from ...conftest import get_testing_print_function, needs_py310
-
-
-@needs_py310
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial003_py310 as mod
-
-    mod.sqlite_url = "sqlite://"
-    mod.engine = create_engine(mod.sqlite_url)
-    calls = []
-
-    new_print = get_testing_print_function(calls)
-
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [
-        [
-            "Hero:",
-            {"name": "Deadpond", "secret_name": "Dive Wilson", "age": None, "id": 1},
-        ]
-    ]

tests/test_tutorial/test_one/test_tutorial004.py

@@ -1,17 +1,28 @@
-from unittest.mock import patch
+import importlib
+from types import ModuleType
 
 import pytest
 from sqlalchemy.exc import MultipleResultsFound
 from sqlmodel import Session, create_engine, delete
 
-from ...conftest import get_testing_print_function
+from ...conftest import PrintMock, needs_py310
 
 
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial004 as mod
-
+@pytest.fixture(
+    name="mod",
+    params=[
+        "tutorial004",
+        pytest.param("tutorial004_py310", marks=needs_py310),
+    ],
+)
+def get_module(request: pytest.FixtureRequest) -> ModuleType:
+    mod = importlib.import_module(f"docs_src.tutorial.one.{request.param}")
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
+    return mod
+
+
+def test_tutorial(print_mock: PrintMock, mod: ModuleType):
     with pytest.raises(MultipleResultsFound):
         mod.main()
     with Session(mod.engine) as session:
@@ -21,13 +32,8 @@ def test_tutorial(clear_sqlmodel):
         session.add(mod.Hero(name="Test Hero", secret_name="Secret Test Hero", age=24))
         session.commit()
 
-    calls = []
-
-    new_print = get_testing_print_function(calls)
-
-    with patch("builtins.print", new=new_print):
-        mod.select_heroes()
-    assert calls == [
+    mod.select_heroes()
+    assert print_mock.calls == [
         [
             "Hero:",
             {

tests/test_tutorial/test_one/test_tutorial004_py310.py

@@ -1,41 +0,0 @@
-from unittest.mock import patch
-
-import pytest
-from sqlalchemy.exc import MultipleResultsFound
-from sqlmodel import Session, create_engine, delete
-
-from ...conftest import get_testing_print_function, needs_py310
-
-
-@needs_py310
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial004_py310 as mod
-
-    mod.sqlite_url = "sqlite://"
-    mod.engine = create_engine(mod.sqlite_url)
-    with pytest.raises(MultipleResultsFound):
-        mod.main()
-    with Session(mod.engine) as session:
-        # TODO: create delete() function
-        # TODO: add overloads for .exec() with delete object
-        session.exec(delete(mod.Hero))
-        session.add(mod.Hero(name="Test Hero", secret_name="Secret Test Hero", age=24))
-        session.commit()
-
-    calls = []
-
-    new_print = get_testing_print_function(calls)
-
-    with patch("builtins.print", new=new_print):
-        mod.select_heroes()
-    assert calls == [
-        [
-            "Hero:",
-            {
-                "id": 1,
-                "name": "Test Hero",
-                "secret_name": "Secret Test Hero",
-                "age": 24,
-            },
-        ]
-    ]

tests/test_tutorial/test_one/test_tutorial005.py

@@ -1,17 +1,28 @@
-from unittest.mock import patch
+import importlib
+from types import ModuleType
 
 import pytest
 from sqlalchemy.exc import NoResultFound
 from sqlmodel import Session, create_engine, delete
 
-from ...conftest import get_testing_print_function
+from ...conftest import PrintMock, needs_py310
 
 
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial005 as mod
-
+@pytest.fixture(
+    name="mod",
+    params=[
+        "tutorial005",
+        pytest.param("tutorial005_py310", marks=needs_py310),
+    ],
+)
+def get_module(request: pytest.FixtureRequest) -> ModuleType:
+    mod = importlib.import_module(f"docs_src.tutorial.one.{request.param}")
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
+    return mod
+
+
+def test_tutorial(print_mock: PrintMock, mod: ModuleType):
     with pytest.raises(NoResultFound):
         mod.main()
     with Session(mod.engine) as session:
@@ -21,13 +32,8 @@ def test_tutorial(clear_sqlmodel):
         session.add(mod.Hero(name="Test Hero", secret_name="Secret Test Hero", age=24))
         session.commit()
 
-    calls = []
-
-    new_print = get_testing_print_function(calls)
-
-    with patch("builtins.print", new=new_print):
-        mod.select_heroes()
-    assert calls == [
+    mod.select_heroes()
+    assert print_mock.calls == [
         [
             "Hero:",
             {

tests/test_tutorial/test_one/test_tutorial005_py310.py

@@ -1,41 +0,0 @@
-from unittest.mock import patch
-
-import pytest
-from sqlalchemy.exc import NoResultFound
-from sqlmodel import Session, create_engine, delete
-
-from ...conftest import get_testing_print_function, needs_py310
-
-
-@needs_py310
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial005_py310 as mod
-
-    mod.sqlite_url = "sqlite://"
-    mod.engine = create_engine(mod.sqlite_url)
-    with pytest.raises(NoResultFound):
-        mod.main()
-    with Session(mod.engine) as session:
-        # TODO: create delete() function
-        # TODO: add overloads for .exec() with delete object
-        session.exec(delete(mod.Hero))
-        session.add(mod.Hero(name="Test Hero", secret_name="Secret Test Hero", age=24))
-        session.commit()
-
-    calls = []
-
-    new_print = get_testing_print_function(calls)
-
-    with patch("builtins.print", new=new_print):
-        mod.select_heroes()
-    assert calls == [
-        [
-            "Hero:",
-            {
-                "id": 1,
-                "name": "Test Hero",
-                "secret_name": "Secret Test Hero",
-                "age": 24,
-            },
-        ]
-    ]

tests/test_tutorial/test_one/test_tutorial006.py

@@ -1,22 +1,29 @@
-from unittest.mock import patch
+import importlib
+from types import ModuleType
 
+import pytest
 from sqlmodel import create_engine
 
-from ...conftest import get_testing_print_function
+from ...conftest import PrintMock, needs_py310
 
 
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial006 as mod
-
+@pytest.fixture(
+    name="mod",
+    params=[
+        "tutorial006",
+        pytest.param("tutorial006_py310", marks=needs_py310),
+    ],
+)
+def get_module(request: pytest.FixtureRequest) -> ModuleType:
+    mod = importlib.import_module(f"docs_src.tutorial.one.{request.param}")
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
-    calls = []
+    return mod
 
-    new_print = get_testing_print_function(calls)
 
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [
+def test_tutorial(print_mock: PrintMock, mod: ModuleType):
+    mod.main()
+    assert print_mock.calls == [
         [
             "Hero:",
             {"name": "Deadpond", "secret_name": "Dive Wilson", "age": None, "id": 1},

tests/test_tutorial/test_one/test_tutorial006_py310.py

@@ -1,25 +0,0 @@
-from unittest.mock import patch
-
-from sqlmodel import create_engine
-
-from ...conftest import get_testing_print_function, needs_py310
-
-
-@needs_py310
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial006_py310 as mod
-
-    mod.sqlite_url = "sqlite://"
-    mod.engine = create_engine(mod.sqlite_url)
-    calls = []
-
-    new_print = get_testing_print_function(calls)
-
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [
-        [
-            "Hero:",
-            {"name": "Deadpond", "secret_name": "Dive Wilson", "age": None, "id": 1},
-        ]
-    ]

tests/test_tutorial/test_one/test_tutorial007.py

@@ -1,22 +1,29 @@
-from unittest.mock import patch
+import importlib
+from types import ModuleType
 
+import pytest
 from sqlmodel import create_engine
 
-from ...conftest import get_testing_print_function
+from ...conftest import PrintMock, needs_py310
 
 
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial007 as mod
-
+@pytest.fixture(
+    name="mod",
+    params=[
+        "tutorial007",
+        pytest.param("tutorial007_py310", marks=needs_py310),
+    ],
+)
+def get_module(request: pytest.FixtureRequest) -> ModuleType:
+    mod = importlib.import_module(f"docs_src.tutorial.one.{request.param}")
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
-    calls = []
+    return mod
 
-    new_print = get_testing_print_function(calls)
 
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [
+def test_tutorial(print_mock: PrintMock, mod: ModuleType):
+    mod.main()
+    assert print_mock.calls == [
         [
             "Hero:",
             {"name": "Deadpond", "secret_name": "Dive Wilson", "age": None, "id": 1},

tests/test_tutorial/test_one/test_tutorial007_py310.py

@@ -1,25 +0,0 @@
-from unittest.mock import patch
-
-from sqlmodel import create_engine
-
-from ...conftest import get_testing_print_function, needs_py310
-
-
-@needs_py310
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial007_py310 as mod
-
-    mod.sqlite_url = "sqlite://"
-    mod.engine = create_engine(mod.sqlite_url)
-    calls = []
-
-    new_print = get_testing_print_function(calls)
-
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [
-        [
-            "Hero:",
-            {"name": "Deadpond", "secret_name": "Dive Wilson", "age": None, "id": 1},
-        ]
-    ]

tests/test_tutorial/test_one/test_tutorial008.py

@@ -1,22 +1,29 @@
-from unittest.mock import patch
+import importlib
+from types import ModuleType
 
+import pytest
 from sqlmodel import create_engine
 
-from ...conftest import get_testing_print_function
+from ...conftest import PrintMock, needs_py310
 
 
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial008 as mod
-
+@pytest.fixture(
+    name="mod",
+    params=[
+        "tutorial008",
+        pytest.param("tutorial008_py310", marks=needs_py310),
+    ],
+)
+def get_module(request: pytest.FixtureRequest) -> ModuleType:
+    mod = importlib.import_module(f"docs_src.tutorial.one.{request.param}")
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
-    calls = []
+    return mod
 
-    new_print = get_testing_print_function(calls)
 
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [
+def test_tutorial(print_mock: PrintMock, mod: ModuleType):
+    mod.main()
+    assert print_mock.calls == [
         [
             "Hero:",
             {"name": "Deadpond", "secret_name": "Dive Wilson", "age": None, "id": 1},

tests/test_tutorial/test_one/test_tutorial008_py310.py

@@ -1,25 +0,0 @@
-from unittest.mock import patch
-
-from sqlmodel import create_engine
-
-from ...conftest import get_testing_print_function, needs_py310
-
-
-@needs_py310
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial008_py310 as mod
-
-    mod.sqlite_url = "sqlite://"
-    mod.engine = create_engine(mod.sqlite_url)
-    calls = []
-
-    new_print = get_testing_print_function(calls)
-
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [
-        [
-            "Hero:",
-            {"name": "Deadpond", "secret_name": "Dive Wilson", "age": None, "id": 1},
-        ]
-    ]

tests/test_tutorial/test_one/test_tutorial009.py

@@ -1,19 +1,26 @@
-from unittest.mock import patch
+import importlib
+from types import ModuleType
 
+import pytest
 from sqlmodel import create_engine
 
-from ...conftest import get_testing_print_function
+from ...conftest import PrintMock, needs_py310
 
 
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial009 as mod
-
+@pytest.fixture(
+    name="mod",
+    params=[
+        "tutorial009",
+        pytest.param("tutorial009_py310", marks=needs_py310),
+    ],
+)
+def get_module(request: pytest.FixtureRequest) -> ModuleType:
+    mod = importlib.import_module(f"docs_src.tutorial.one.{request.param}")
     mod.sqlite_url = "sqlite://"
     mod.engine = create_engine(mod.sqlite_url)
-    calls = []
+    return mod
 
-    new_print = get_testing_print_function(calls)
 
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [["Hero:", None]]
+def test_tutorial(print_mock: PrintMock, mod: ModuleType):
+    mod.main()
+    assert print_mock.calls == [["Hero:", None]]

tests/test_tutorial/test_one/test_tutorial009_py310.py

@@ -1,20 +0,0 @@
-from unittest.mock import patch
-
-from sqlmodel import create_engine
-
-from ...conftest import get_testing_print_function, needs_py310
-
-
-@needs_py310
-def test_tutorial(clear_sqlmodel):
-    from docs_src.tutorial.one import tutorial009_py310 as mod
-
-    mod.sqlite_url = "sqlite://"
-    mod.engine = create_engine(mod.sqlite_url)
-    calls = []
-
-    new_print = get_testing_print_function(calls)
-
-    with patch("builtins.print", new=new_print):
-        mod.main()
-    assert calls == [["Hero:", None]]