pytest-split 0.8.2__py3-none-any.whl → 0.10.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  import enum
2
- import functools
3
2
  import heapq
3
+ from abc import ABC, abstractmethod
4
4
  from operator import itemgetter
5
5
  from typing import TYPE_CHECKING, NamedTuple
6
6
 
@@ -16,9 +16,25 @@ class TestGroup(NamedTuple):
16
16
  duration: float
17
17
 
18
18
 
19
- def least_duration(
20
- splits: int, items: "List[nodes.Item]", durations: "Dict[str, float]"
21
- ) -> "List[TestGroup]":
19
+ class AlgorithmBase(ABC):
20
+ """Abstract base class for the algorithm implementations."""
21
+
22
+ @abstractmethod
23
+ def __call__(
24
+ self, splits: int, items: "List[nodes.Item]", durations: "Dict[str, float]"
25
+ ) -> "List[TestGroup]":
26
+ pass
27
+
28
+ def __hash__(self) -> int:
29
+ return hash(self.__class__.__name__)
30
+
31
+ def __eq__(self, other: object) -> bool:
32
+ if not isinstance(other, AlgorithmBase):
33
+ return NotImplemented
34
+ return self.__class__.__name__ == other.__class__.__name__
35
+
36
+
37
+ class LeastDurationAlgorithm(AlgorithmBase):
22
38
  """
23
39
  Split tests into groups by runtime.
24
40
  It walks the test items, starting with the test with largest duration.
@@ -34,60 +50,65 @@ def least_duration(
34
50
  :return:
35
51
  List of groups
36
52
  """
37
- items_with_durations = _get_items_with_durations(items, durations)
38
53
 
39
- # add index of item in list
40
- items_with_durations_indexed = [
41
- (*tup, i) for i, tup in enumerate(items_with_durations)
42
- ]
54
+ def __call__(
55
+ self, splits: int, items: "List[nodes.Item]", durations: "Dict[str, float]"
56
+ ) -> "List[TestGroup]":
57
+ items_with_durations = _get_items_with_durations(items, durations)
43
58
 
44
- # Sort by name to ensure it's always the same order
45
- items_with_durations_indexed = sorted(
46
- items_with_durations_indexed, key=lambda tup: str(tup[0])
47
- )
48
-
49
- # sort in ascending order
50
- sorted_items_with_durations = sorted(
51
- items_with_durations_indexed, key=lambda tup: tup[1], reverse=True
52
- )
53
-
54
- selected: "List[List[Tuple[nodes.Item, int]]]" = [[] for _ in range(splits)]
55
- deselected: "List[List[nodes.Item]]" = [[] for _ in range(splits)]
56
- duration: "List[float]" = [0 for _ in range(splits)]
57
-
58
- # create a heap of the form (summed_durations, group_index)
59
- heap: "List[Tuple[float, int]]" = [(0, i) for i in range(splits)]
60
- heapq.heapify(heap)
61
- for item, item_duration, original_index in sorted_items_with_durations:
62
- # get group with smallest sum
63
- summed_durations, group_idx = heapq.heappop(heap)
64
- new_group_durations = summed_durations + item_duration
65
-
66
- # store assignment
67
- selected[group_idx].append((item, original_index))
68
- duration[group_idx] = new_group_durations
69
- for i in range(splits):
70
- if i != group_idx:
71
- deselected[i].append(item)
72
-
73
- # store new duration - in case of ties it sorts by the group_idx
74
- heapq.heappush(heap, (new_group_durations, group_idx))
75
-
76
- groups = []
77
- for i in range(splits):
78
- # sort the items by their original index to maintain relative ordering
79
- # we don't care about the order of deselected items
80
- s = [
81
- item for item, original_index in sorted(selected[i], key=lambda tup: tup[1])
59
+ # add index of item in list
60
+ items_with_durations_indexed = [
61
+ (*tup, i) for i, tup in enumerate(items_with_durations)
82
62
  ]
83
- group = TestGroup(selected=s, deselected=deselected[i], duration=duration[i])
84
- groups.append(group)
85
- return groups
86
-
87
63
 
88
- def duration_based_chunks(
89
- splits: int, items: "List[nodes.Item]", durations: "Dict[str, float]"
90
- ) -> "List[TestGroup]":
64
+ # Sort by name to ensure it's always the same order
65
+ items_with_durations_indexed = sorted(
66
+ items_with_durations_indexed, key=lambda tup: str(tup[0])
67
+ )
68
+
69
+ # sort in ascending order
70
+ sorted_items_with_durations = sorted(
71
+ items_with_durations_indexed, key=lambda tup: tup[1], reverse=True
72
+ )
73
+
74
+ selected: List[List[Tuple[nodes.Item, int]]] = [[] for _ in range(splits)]
75
+ deselected: List[List[nodes.Item]] = [[] for _ in range(splits)]
76
+ duration: List[float] = [0 for _ in range(splits)]
77
+
78
+ # create a heap of the form (summed_durations, group_index)
79
+ heap: List[Tuple[float, int]] = [(0, i) for i in range(splits)]
80
+ heapq.heapify(heap)
81
+ for item, item_duration, original_index in sorted_items_with_durations:
82
+ # get group with smallest sum
83
+ summed_durations, group_idx = heapq.heappop(heap)
84
+ new_group_durations = summed_durations + item_duration
85
+
86
+ # store assignment
87
+ selected[group_idx].append((item, original_index))
88
+ duration[group_idx] = new_group_durations
89
+ for i in range(splits):
90
+ if i != group_idx:
91
+ deselected[i].append(item)
92
+
93
+ # store new duration - in case of ties it sorts by the group_idx
94
+ heapq.heappush(heap, (new_group_durations, group_idx))
95
+
96
+ groups = []
97
+ for i in range(splits):
98
+ # sort the items by their original index to maintain relative ordering
99
+ # we don't care about the order of deselected items
100
+ s = [
101
+ item
102
+ for item, original_index in sorted(selected[i], key=lambda tup: tup[1])
103
+ ]
104
+ group = TestGroup(
105
+ selected=s, deselected=deselected[i], duration=duration[i]
106
+ )
107
+ groups.append(group)
108
+ return groups
109
+
110
+
111
+ class DurationBasedChunksAlgorithm(AlgorithmBase):
91
112
  """
92
113
  Split tests into groups by runtime.
93
114
  Ensures tests are split into non-overlapping groups.
@@ -99,28 +120,34 @@ def duration_based_chunks(
99
120
  :param durations: Our cached test runtimes. Assumes contains timings only of relevant tests
100
121
  :return: List of TestGroup
101
122
  """
102
- items_with_durations = _get_items_with_durations(items, durations)
103
- time_per_group = sum(map(itemgetter(1), items_with_durations)) / splits
104
-
105
- selected: "List[List[nodes.Item]]" = [[] for i in range(splits)]
106
- deselected: "List[List[nodes.Item]]" = [[] for i in range(splits)]
107
- duration: "List[float]" = [0 for i in range(splits)]
108
123
 
109
- group_idx = 0
110
- for item, item_duration in items_with_durations:
111
- if duration[group_idx] >= time_per_group:
112
- group_idx += 1
113
-
114
- selected[group_idx].append(item)
115
- for i in range(splits):
116
- if i != group_idx:
117
- deselected[i].append(item)
118
- duration[group_idx] += item_duration
119
-
120
- return [
121
- TestGroup(selected=selected[i], deselected=deselected[i], duration=duration[i])
122
- for i in range(splits)
123
- ]
124
+ def __call__(
125
+ self, splits: int, items: "List[nodes.Item]", durations: "Dict[str, float]"
126
+ ) -> "List[TestGroup]":
127
+ items_with_durations = _get_items_with_durations(items, durations)
128
+ time_per_group = sum(map(itemgetter(1), items_with_durations)) / splits
129
+
130
+ selected: List[List[nodes.Item]] = [[] for i in range(splits)]
131
+ deselected: List[List[nodes.Item]] = [[] for i in range(splits)]
132
+ duration: List[float] = [0 for i in range(splits)]
133
+
134
+ group_idx = 0
135
+ for item, item_duration in items_with_durations:
136
+ if duration[group_idx] >= time_per_group:
137
+ group_idx += 1
138
+
139
+ selected[group_idx].append(item)
140
+ for i in range(splits):
141
+ if i != group_idx:
142
+ deselected[i].append(item)
143
+ duration[group_idx] += item_duration
144
+
145
+ return [
146
+ TestGroup(
147
+ selected=selected[i], deselected=deselected[i], duration=duration[i]
148
+ )
149
+ for i in range(splits)
150
+ ]
124
151
 
125
152
 
126
153
  def _get_items_with_durations(
@@ -153,9 +180,8 @@ def _remove_irrelevant_durations(
153
180
 
154
181
 
155
182
  class Algorithms(enum.Enum):
156
- # values have to wrapped inside functools to avoid them being considered method definitions
157
- duration_based_chunks = functools.partial(duration_based_chunks)
158
- least_duration = functools.partial(least_duration)
183
+ duration_based_chunks = DurationBasedChunksAlgorithm()
184
+ least_duration = LeastDurationAlgorithm()
159
185
 
160
186
  @staticmethod
161
187
  def names() -> "List[str]":
@@ -6,7 +6,7 @@ if TYPE_CHECKING:
6
6
  from pytest_split.algorithms import TestGroup
7
7
 
8
8
 
9
- def ensure_ipynb_compatibility(group: "TestGroup", items: list) -> None:
9
+ def ensure_ipynb_compatibility(group: "TestGroup", items: list) -> None: # type: ignore[type-arg]
10
10
  """
11
11
  Ensures that group doesn't contain partial IPy notebook cells.
12
12
 
pytest_split/plugin.py CHANGED
@@ -15,7 +15,7 @@ if TYPE_CHECKING:
15
15
  from _pytest import nodes
16
16
  from _pytest.config import Config
17
17
  from _pytest.config.argparsing import Parser
18
- from _pytest.main import ExitCode
18
+ from _pytest.main import ExitCode # type: ignore[attr-defined]
19
19
 
20
20
 
21
21
  # Ugly hack for freezegun compatibility: https://github.com/spulec/freezegun/issues/286
@@ -193,9 +193,9 @@ class PytestSplitCachePlugin(Base):
193
193
  https://github.com/pytest-dev/pytest/blob/main/src/_pytest/main.py#L308
194
194
  """
195
195
  terminal_reporter = self.config.pluginmanager.get_plugin("terminalreporter")
196
- test_durations: "Dict[str, float]" = {}
196
+ test_durations: Dict[str, float] = {}
197
197
 
198
- for test_reports in terminal_reporter.stats.values():
198
+ for test_reports in terminal_reporter.stats.values(): # type: ignore[union-attr]
199
199
  for test_report in test_reports:
200
200
  if isinstance(test_report, TestReport):
201
201
  # These ifs be removed after this is solved: # https://github.com/spulec/freezegun/issues/286
@@ -224,8 +224,6 @@ class PytestSplitCachePlugin(Base):
224
224
  json.dump(self.cached_durations, f, sort_keys=True, indent=4)
225
225
 
226
226
  message = self.writer.markup(
227
- "\n\n[pytest-split] Stored test durations in {}".format(
228
- self.config.option.durations_path
229
- )
227
+ f"\n\n[pytest-split] Stored test durations in {self.config.option.durations_path}"
230
228
  )
231
229
  self.writer.line(message)
@@ -1,4 +1,4 @@
1
- Copyright (c) 2021 Jerry Pussinen
1
+ Copyright (c) 2024 Jerry Pussinen
2
2
 
3
3
  Permission is hereby granted, free of charge, to any person obtaining
4
4
  a copy of this software and associated documentation files (the
@@ -1,25 +1,25 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: pytest-split
3
- Version: 0.8.2
3
+ Version: 0.10.0
4
4
  Summary: Pytest plugin which splits the test suite to equally sized sub suites based on test execution time.
5
5
  Home-page: https://jerry-git.github.io/pytest-split
6
6
  License: MIT
7
7
  Keywords: pytest,plugin,split,tests
8
8
  Author: Jerry Pussinen
9
9
  Author-email: jerry.pussinen@gmail.com
10
- Requires-Python: >=3.7.1,<4.0
10
+ Requires-Python: >=3.8.1,<4.0
11
11
  Classifier: Development Status :: 4 - Beta
12
12
  Classifier: Intended Audience :: Developers
13
13
  Classifier: License :: OSI Approved :: MIT License
14
14
  Classifier: Operating System :: OS Independent
15
15
  Classifier: Programming Language :: Python
16
16
  Classifier: Programming Language :: Python :: 3
17
- Classifier: Programming Language :: Python :: 3.8
18
17
  Classifier: Programming Language :: Python :: 3.9
19
18
  Classifier: Programming Language :: Python :: 3.10
20
19
  Classifier: Programming Language :: Python :: 3.11
21
20
  Classifier: Programming Language :: Python :: 3.12
22
- Classifier: Programming Language :: Python :: 3.7
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Programming Language :: Python :: 3.8
23
23
  Classifier: Topic :: Software Development :: Libraries :: Python Modules
24
24
  Classifier: Typing :: Typed
25
25
  Requires-Dist: pytest (>=5,<9)
@@ -125,7 +125,7 @@ The `least_duration` algorithm walks the list of tests and assigns each test to
125
125
  * Clone this repository
126
126
  * Requirements:
127
127
  * [Poetry](https://python-poetry.org/)
128
- * Python 3.7+
128
+ * Python 3.8+
129
129
  * Create a virtual environment and install the dependencies
130
130
 
131
131
  ```sh
@@ -146,9 +146,8 @@ pytest
146
146
 
147
147
  ### Documentation
148
148
 
149
- The documentation is automatically generated from the content of the [docs directory](./docs) and from the docstrings
150
- of the public signatures of the source code. The documentation is updated and published as a [Github project page
151
- ](https://pages.github.com/) automatically as part each release.
149
+ The documentation is automatically generated from the content of the [docs directory](https://github.com/jerry-git/pytest-split/tree/master/docs) and from the docstrings
150
+ of the public signatures of the source code. The documentation is updated and published as a [Github Pages page](https://pages.github.com/) automatically as part each release.
152
151
 
153
152
  ### Releasing
154
153
 
@@ -162,7 +161,7 @@ Find the draft release from the
162
161
 
163
162
  ### Pre-commit
164
163
 
165
- Pre-commit hooks run all the auto-formatters (e.g. `black`), linters (e.g. `mypy`, `ruff`), and other quality
164
+ Pre-commit hooks run all the auto-formatting (`ruff format`), linters (e.g. `ruff` and `mypy`), and other quality
166
165
  checks to make sure the changeset is in good shape before a commit/push happens.
167
166
 
168
167
  You can install the hooks with (runs for each commit):
@@ -0,0 +1,11 @@
1
+ pytest_split/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
+ pytest_split/algorithms.py,sha256=nNvl6UQaQr8_720jwGtM_uXk2cvQx3w5BO8W_PrM3tI,6973
3
+ pytest_split/cli.py,sha256=_Cc3h5jwOJyX7NZT4yil_ymG0g6Rw0257gh_63VoqzE,1011
4
+ pytest_split/ipynb_compatibility.py,sha256=zBul7z3mB3UgM03IppqFpTZTdb2Vj1NrqxRC0kAgrCw,2104
5
+ pytest_split/plugin.py,sha256=z3dTS3rK0wI2bj62Yw2O3y8120UfMiWnc6CJJyig-0k,7857
6
+ pytest_split/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
7
+ pytest_split-0.10.0.dist-info/LICENSE,sha256=mMm6KABGgOUinR1qBjELBaTHOU91sKkaWnprZ0RBilU,1058
8
+ pytest_split-0.10.0.dist-info/METADATA,sha256=dBjba3qcE-RdUjL5LBpYKfTM401xKCvmOg3YUBvTK5E,9532
9
+ pytest_split-0.10.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
10
+ pytest_split-0.10.0.dist-info/entry_points.txt,sha256=TQBEnYSUICZtzsc1CUyiYrOHpEll6HBDzIFvjJyo9F8,114
11
+ pytest_split-0.10.0.dist-info/RECORD,,
@@ -1,4 +1,4 @@
1
1
  Wheel-Version: 1.0
2
- Generator: poetry-core 1.8.1
2
+ Generator: poetry-core 1.9.1
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
@@ -1,11 +0,0 @@
1
- LICENCE,sha256=9Enb-O6zwCRmtxw3bGyfdFDKjy5LgMj-GIIMb1VXrRY,1058
2
- pytest_split/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
3
- pytest_split/algorithms.py,sha256=-lLVwVQ2BqIjqzPP7U1GH5q4crytODq0LPwNewAwEcY,6126
4
- pytest_split/cli.py,sha256=_Cc3h5jwOJyX7NZT4yil_ymG0g6Rw0257gh_63VoqzE,1011
5
- pytest_split/ipynb_compatibility.py,sha256=G4TxNU7FA0vdlRaAbDJGrM4Sq3n0p2gEVad-piAjnUs,2078
6
- pytest_split/plugin.py,sha256=YSO4WTfH6o_Br0lFjIxzsmT4__iWyuQfRmAfScGrhsY,7839
7
- pytest_split/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
8
- pytest_split-0.8.2.dist-info/METADATA,sha256=QvAaHZ3glRAHn6hoJNjg8YZBeN0_ahpraeKRMxXKmNk,9478
9
- pytest_split-0.8.2.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
10
- pytest_split-0.8.2.dist-info/entry_points.txt,sha256=TQBEnYSUICZtzsc1CUyiYrOHpEll6HBDzIFvjJyo9F8,114
11
- pytest_split-0.8.2.dist-info/RECORD,,