✨ Document indexes and make them opt-in (#205)

tests/test_tutorial/test_where/test_tutorial003.py

@@ -17,7 +17,7 @@ def test_tutorial(clear_sqlmodel):
     with patch("builtins.print", new=new_print):
         mod.main()
 
-    assert calls == [
+    expected_calls = [
         [{"id": 6, "name": "Dr. Weird", "secret_name": "Steve Weird", "age": 36}],
         [{"id": 3, "name": "Rusty-Man", "secret_name": "Tommy Sharp", "age": 48}],
         [
@@ -29,3 +29,8 @@ def test_tutorial(clear_sqlmodel):
             }
         ],
     ]
+    for call in expected_calls:
+        assert call in calls, "This expected item should be in the list"
+        # Now that this item was checked, remove it from the list
+        calls.pop(calls.index(call))
+    assert len(calls) == 0, "The list should only have the expected items"

tests/test_tutorial/test_where/test_tutorial004.py

@@ -16,7 +16,7 @@ def test_tutorial(clear_sqlmodel):
 
     with patch("builtins.print", new=new_print):
         mod.main()
-    assert calls == [
+    expected_calls = [
         [{"id": 5, "name": "Black Lion", "secret_name": "Trevor Challa", "age": 35}],
         [{"id": 6, "name": "Dr. Weird", "secret_name": "Steve Weird", "age": 36}],
         [{"id": 3, "name": "Rusty-Man", "secret_name": "Tommy Sharp", "age": 48}],
@@ -29,3 +29,8 @@ def test_tutorial(clear_sqlmodel):
             }
         ],
     ]
+    for call in expected_calls:
+        assert call in calls, "This expected item should be in the list"
+        # Now that this item was checked, remove it from the list
+        calls.pop(calls.index(call))
+    assert len(calls) == 0, "The list should only have the expected items"

tests/test_tutorial/test_where/test_tutorial011.py

@@ -16,7 +16,7 @@ def test_tutorial(clear_sqlmodel):
 
     with patch("builtins.print", new=new_print):
         mod.main()
-    assert calls == [
+    expected_calls = [
         [{"id": 5, "name": "Black Lion", "secret_name": "Trevor Challa", "age": 35}],
         [{"id": 6, "name": "Dr. Weird", "secret_name": "Steve Weird", "age": 36}],
         [{"id": 3, "name": "Rusty-Man", "secret_name": "Tommy Sharp", "age": 48}],
@@ -29,3 +29,8 @@ def test_tutorial(clear_sqlmodel):
             }
         ],
     ]
+    for call in expected_calls:
+        assert call in calls, "This expected item should be in the list"
+        # Now that this item was checked, remove it from the list
+        calls.pop(calls.index(call))
+    assert len(calls) == 0, "The list should only have the expected items"