Skip to content

Commit f42b68c

Browse files
committed
runner: rename SetupState.prepare -> setup
This is the usual terminology we use, and matches better with `teardown_exact()` and `pytest_runtest_setup()`.
1 parent f674f6d commit f42b68c

File tree

4 files changed

+22
-22
lines changed

4 files changed

+22
-22
lines changed

src/_pytest/fixtures.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ def _fill_fixtures_impl(function: "Function") -> None:
372372
fi = fm.getfixtureinfo(function.parent, function.obj, None)
373373
function._fixtureinfo = fi
374374
request = function._request = FixtureRequest(function, _ispytest=True)
375-
fm.session._setupstate.prepare(function)
375+
fm.session._setupstate.setup(function)
376376
request._fillfixtures()
377377
# Prune out funcargs for jstests.
378378
newfuncargs = {}

src/_pytest/runner.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ def show_test_item(item: Item) -> None:
151151

152152
def pytest_runtest_setup(item: Item) -> None:
153153
_update_current_test_var(item, "setup")
154-
item.session._setupstate.prepare(item)
154+
item.session._setupstate.setup(item)
155155

156156

157157
def pytest_runtest_call(item: Item) -> None:
@@ -417,7 +417,7 @@ class SetupState:
417417
418418
[]
419419
420-
During the setup phase of item1, prepare(item1) is called. What it does
420+
During the setup phase of item1, setup(item1) is called. What it does
421421
is:
422422
423423
push session to stack, run session.setup()
@@ -441,7 +441,7 @@ class SetupState:
441441
442442
[session]
443443
444-
During the setup phase of item2, prepare(item2) is called. What it does
444+
During the setup phase of item2, setup(item2) is called. What it does
445445
is:
446446
447447
push mod2 to stack, run mod2.setup()
@@ -477,26 +477,26 @@ def __init__(self) -> None:
477477
],
478478
] = {}
479479

480-
def prepare(self, item: Item) -> None:
480+
def setup(self, item: Item) -> None:
481481
"""Setup objects along the collector chain to the item."""
482482
needed_collectors = item.listchain()
483483

484484
# If a collector fails its setup, fail its entire subtree of items.
485485
# The setup is not retried for each item - the same exception is used.
486-
for col, (finalizers, prepare_exc) in self.stack.items():
486+
for col, (finalizers, exc) in self.stack.items():
487487
assert col in needed_collectors, "previous item was not torn down properly"
488-
if prepare_exc:
489-
raise prepare_exc
488+
if exc:
489+
raise exc
490490

491491
for col in needed_collectors[len(self.stack) :]:
492492
assert col not in self.stack
493493
# Push onto the stack.
494494
self.stack[col] = ([col.teardown], None)
495495
try:
496496
col.setup()
497-
except TEST_OUTCOME as e:
498-
self.stack[col] = (self.stack[col][0], e)
499-
raise e
497+
except TEST_OUTCOME as exc:
498+
self.stack[col] = (self.stack[col][0], exc)
499+
raise exc
500500

501501
def addfinalizer(self, finalizer: Callable[[], object], node: Node) -> None:
502502
"""Attach a finalizer to the given node.
@@ -520,7 +520,7 @@ def teardown_exact(self, nextitem: Optional[Item]) -> None:
520520
while self.stack:
521521
if list(self.stack.keys()) == needed_collectors[: len(self.stack)]:
522522
break
523-
node, (finalizers, prepare_exc) = self.stack.popitem()
523+
node, (finalizers, _) = self.stack.popitem()
524524
while finalizers:
525525
fin = finalizers.pop()
526526
try:

testing/python/fixtures.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ def test_funcarg_basic(self, pytester: Pytester) -> None:
131131
item = pytester.getitem(Path("test_funcarg_basic.py"))
132132
assert isinstance(item, Function)
133133
# Execute's item's setup, which fills fixtures.
134-
item.session._setupstate.prepare(item)
134+
item.session._setupstate.setup(item)
135135
del item.funcargs["request"]
136136
assert len(get_public_names(item.funcargs)) == 2
137137
assert item.funcargs["some"] == "test_func"
@@ -827,7 +827,7 @@ def test_func(something): pass
827827
req = item._request
828828

829829
# Execute item's setup.
830-
item.session._setupstate.prepare(item)
830+
item.session._setupstate.setup(item)
831831

832832
with pytest.raises(pytest.FixtureLookupError):
833833
req.getfixturevalue("notexists")
@@ -855,7 +855,7 @@ def test_func(something): pass
855855
"""
856856
)
857857
assert isinstance(item, Function)
858-
item.session._setupstate.prepare(item)
858+
item.session._setupstate.setup(item)
859859
item._request._fillfixtures()
860860
# successively check finalization calls
861861
parent = item.getparent(pytest.Module)

testing/test_runner.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def test_setup(self, pytester: Pytester) -> None:
2525
item = pytester.getitem("def test_func(): pass")
2626
ss = item.session._setupstate
2727
values = [1]
28-
ss.prepare(item)
28+
ss.setup(item)
2929
ss.addfinalizer(values.pop, item)
3030
assert values
3131
ss.teardown_exact(None)
@@ -34,7 +34,7 @@ def test_setup(self, pytester: Pytester) -> None:
3434
def test_teardown_exact_stack_empty(self, pytester: Pytester) -> None:
3535
item = pytester.getitem("def test_func(): pass")
3636
ss = item.session._setupstate
37-
ss.prepare(item)
37+
ss.setup(item)
3838
ss.teardown_exact(None)
3939
ss.teardown_exact(None)
4040
ss.teardown_exact(None)
@@ -49,9 +49,9 @@ def test_func(): pass
4949
)
5050
ss = item.session._setupstate
5151
with pytest.raises(ValueError):
52-
ss.prepare(item)
52+
ss.setup(item)
5353
with pytest.raises(ValueError):
54-
ss.prepare(item)
54+
ss.setup(item)
5555

5656
def test_teardown_multiple_one_fails(self, pytester: Pytester) -> None:
5757
r = []
@@ -67,7 +67,7 @@ def fin3():
6767

6868
item = pytester.getitem("def test_func(): pass")
6969
ss = item.session._setupstate
70-
ss.prepare(item)
70+
ss.setup(item)
7171
ss.addfinalizer(fin1, item)
7272
ss.addfinalizer(fin2, item)
7373
ss.addfinalizer(fin3, item)
@@ -87,7 +87,7 @@ def fin2():
8787

8888
item = pytester.getitem("def test_func(): pass")
8989
ss = item.session._setupstate
90-
ss.prepare(item)
90+
ss.setup(item)
9191
ss.addfinalizer(fin1, item)
9292
ss.addfinalizer(fin2, item)
9393
with pytest.raises(Exception) as err:
@@ -106,7 +106,7 @@ def fin_module():
106106
item = pytester.getitem("def test_func(): pass")
107107
mod = item.listchain()[-2]
108108
ss = item.session._setupstate
109-
ss.prepare(item)
109+
ss.setup(item)
110110
ss.addfinalizer(fin_module, mod)
111111
ss.addfinalizer(fin_func, item)
112112
with pytest.raises(Exception, match="oops1"):

0 commit comments

Comments
 (0)