fixtures: fix catastrophic performance problem in `reorder_items`
Fix #12355. In the issue, it was reported that the `reorder_items` has quadratic (or worse...) behavior with certain simple parametrizations. After some debugging I found that the problem happens because the "Fix items_by_argkey order" loop keeps adding the same item to the deque, and it reaches epic sizes which causes the slowdown. I don't claim to understand how the `reorder_items` algorithm works, but if as far as I understand, if an item already exists in the deque, the correct thing to do is to move it to the front. Since a deque doesn't have such an (efficient) operation, this switches to `OrderedDict` which can efficiently append from both sides, deduplicate and move to front.
This commit is contained in:
parent
1eee63a891
commit
e89d23b247
|
@ -0,0 +1 @@
|
||||||
|
Fix possible catastrophic performance slowdown on a certain parametrization pattern involving many higher-scoped parameters.
|
|
@ -25,6 +25,7 @@ from typing import Mapping
|
||||||
from typing import MutableMapping
|
from typing import MutableMapping
|
||||||
from typing import NoReturn
|
from typing import NoReturn
|
||||||
from typing import Optional
|
from typing import Optional
|
||||||
|
from typing import OrderedDict
|
||||||
from typing import overload
|
from typing import overload
|
||||||
from typing import Sequence
|
from typing import Sequence
|
||||||
from typing import Set
|
from typing import Set
|
||||||
|
@ -77,8 +78,6 @@ if sys.version_info < (3, 11):
|
||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from typing import Deque
|
|
||||||
|
|
||||||
from _pytest.main import Session
|
from _pytest.main import Session
|
||||||
from _pytest.python import CallSpec2
|
from _pytest.python import CallSpec2
|
||||||
from _pytest.python import Function
|
from _pytest.python import Function
|
||||||
|
@ -215,16 +214,18 @@ def get_parametrized_fixture_argkeys(
|
||||||
|
|
||||||
def reorder_items(items: Sequence[nodes.Item]) -> List[nodes.Item]:
|
def reorder_items(items: Sequence[nodes.Item]) -> List[nodes.Item]:
|
||||||
argkeys_by_item: Dict[Scope, Dict[nodes.Item, OrderedSet[FixtureArgKey]]] = {}
|
argkeys_by_item: Dict[Scope, Dict[nodes.Item, OrderedSet[FixtureArgKey]]] = {}
|
||||||
items_by_argkey: Dict[Scope, Dict[FixtureArgKey, Deque[nodes.Item]]] = {}
|
items_by_argkey: Dict[
|
||||||
|
Scope, Dict[FixtureArgKey, OrderedDict[nodes.Item, None]]
|
||||||
|
] = {}
|
||||||
for scope in HIGH_SCOPES:
|
for scope in HIGH_SCOPES:
|
||||||
scoped_argkeys_by_item = argkeys_by_item[scope] = {}
|
scoped_argkeys_by_item = argkeys_by_item[scope] = {}
|
||||||
scoped_items_by_argkey = items_by_argkey[scope] = defaultdict(deque)
|
scoped_items_by_argkey = items_by_argkey[scope] = defaultdict(OrderedDict)
|
||||||
for item in items:
|
for item in items:
|
||||||
argkeys = dict.fromkeys(get_parametrized_fixture_argkeys(item, scope))
|
argkeys = dict.fromkeys(get_parametrized_fixture_argkeys(item, scope))
|
||||||
if argkeys:
|
if argkeys:
|
||||||
scoped_argkeys_by_item[item] = argkeys
|
scoped_argkeys_by_item[item] = argkeys
|
||||||
for argkey in argkeys:
|
for argkey in argkeys:
|
||||||
scoped_items_by_argkey[argkey].append(item)
|
scoped_items_by_argkey[argkey][item] = None
|
||||||
|
|
||||||
items_set = dict.fromkeys(items)
|
items_set = dict.fromkeys(items)
|
||||||
return list(
|
return list(
|
||||||
|
@ -237,7 +238,9 @@ def reorder_items(items: Sequence[nodes.Item]) -> List[nodes.Item]:
|
||||||
def reorder_items_atscope(
|
def reorder_items_atscope(
|
||||||
items: OrderedSet[nodes.Item],
|
items: OrderedSet[nodes.Item],
|
||||||
argkeys_by_item: Mapping[Scope, Mapping[nodes.Item, OrderedSet[FixtureArgKey]]],
|
argkeys_by_item: Mapping[Scope, Mapping[nodes.Item, OrderedSet[FixtureArgKey]]],
|
||||||
items_by_argkey: Mapping[Scope, Mapping[FixtureArgKey, "Deque[nodes.Item]"]],
|
items_by_argkey: Mapping[
|
||||||
|
Scope, Mapping[FixtureArgKey, OrderedDict[nodes.Item, None]]
|
||||||
|
],
|
||||||
scope: Scope,
|
scope: Scope,
|
||||||
) -> OrderedSet[nodes.Item]:
|
) -> OrderedSet[nodes.Item]:
|
||||||
if scope is Scope.Function or len(items) < 3:
|
if scope is Scope.Function or len(items) < 3:
|
||||||
|
@ -274,7 +277,10 @@ def reorder_items_atscope(
|
||||||
for other_scope in HIGH_SCOPES:
|
for other_scope in HIGH_SCOPES:
|
||||||
other_scoped_items_by_argkey = items_by_argkey[other_scope]
|
other_scoped_items_by_argkey = items_by_argkey[other_scope]
|
||||||
for argkey in argkeys_by_item[other_scope].get(i, ()):
|
for argkey in argkeys_by_item[other_scope].get(i, ()):
|
||||||
other_scoped_items_by_argkey[argkey].appendleft(i)
|
other_scoped_items_by_argkey[argkey][i] = None
|
||||||
|
other_scoped_items_by_argkey[argkey].move_to_end(
|
||||||
|
i, last=False
|
||||||
|
)
|
||||||
break
|
break
|
||||||
if no_argkey_items:
|
if no_argkey_items:
|
||||||
reordered_no_argkey_items = reorder_items_atscope(
|
reordered_no_argkey_items = reorder_items_atscope(
|
||||||
|
|
|
@ -2219,6 +2219,25 @@ class TestAutouseManagement:
|
||||||
reprec = pytester.inline_run("-s")
|
reprec = pytester.inline_run("-s")
|
||||||
reprec.assertoutcome(passed=2)
|
reprec.assertoutcome(passed=2)
|
||||||
|
|
||||||
|
def test_reordering_catastrophic_performance(self, pytester: Pytester) -> None:
|
||||||
|
"""Check that a certain high-scope parametrization pattern doesn't cause
|
||||||
|
a catasrophic slowdown.
|
||||||
|
|
||||||
|
Regression test for #12355.
|
||||||
|
"""
|
||||||
|
pytester.makepyfile("""
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
params = tuple("abcdefghijklmnopqrstuvwxyz")
|
||||||
|
@pytest.mark.parametrize(params, [range(len(params))] * 3, scope="module")
|
||||||
|
def test_parametrize(a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z):
|
||||||
|
pass
|
||||||
|
""")
|
||||||
|
|
||||||
|
result = pytester.runpytest()
|
||||||
|
|
||||||
|
result.assert_outcomes(passed=3)
|
||||||
|
|
||||||
|
|
||||||
class TestFixtureMarker:
|
class TestFixtureMarker:
|
||||||
def test_parametrize(self, pytester: Pytester) -> None:
|
def test_parametrize(self, pytester: Pytester) -> None:
|
||||||
|
|
Loading…
Reference in New Issue