dycw-utilities 0.166.28__tar.gz → 0.166.30__tar.gz

{dycw_utilities-0.166.28 → dycw_utilities-0.166.30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.166.28
+Version: 0.166.30
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.166.28 → dycw_utilities-0.166.30}/pyproject.toml

@@ -246,7 +246,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.166.28"
+version = "0.166.30"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -279,7 +279,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.166.28"
+current_version = "0.166.30"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.166.28 → dycw_utilities-0.166.30}/src/tests/test_pytest.py

@@ -257,6 +257,72 @@ class TestPytestOptions:
         result.stdout.re_match_lines(list(matches))
 
 
+class TestRunFrac:
+    @mark.flaky
+    def test_basic(self, *, testdir: Testdir) -> None:
+        _ = testdir.makepyfile(
+            """
+            from utilities.pytest import run_frac
+
+            @run_frac()
+            def test_main() -> None:
+                assert True
+            """
+        )
+        self._run_test(testdir)
+
+    @mark.flaky
+    @mark.parametrize("asyncio_first", [param(True), param(False)])
+    def test_async(self, *, testdir: Testdir, asyncio_first: bool) -> None:
+        if asyncio_first:
+            _ = testdir.makepyfile(
+                """
+                from pytest import mark
+
+                from utilities.pytest import run_frac
+
+                @mark.asyncio
+                @run_frac()
+                async def test_main() -> None:
+                    assert True
+                """
+            )
+        else:
+            _ = testdir.makepyfile(
+                """
+                from pytest import mark
+
+                from utilities.pytest import run_frac
+
+                @run_frac()
+                @mark.asyncio
+                async def test_main() -> None:
+                    assert True
+                """
+            )
+        self._run_test(testdir)
+
+    @mark.flaky
+    def test_predicate(self, *, testdir: Testdir) -> None:
+        _ = testdir.makepyfile(
+            """
+            from utilities.pytest import run_frac
+
+            @run_frac(predicate=False)
+            def test_main() -> None:
+                assert True
+            """
+        )
+        testdir.runpytest().assert_outcomes(passed=1)
+
+    def _run_test(self, testdir: Testdir, /) -> None:
+        result = testdir.runpytest()
+        try:
+            result.assert_outcomes(passed=1)
+        except AssertionError:
+            result.assert_outcomes(skipped=1)
+
+
 class TestThrottle:
     delta: ClassVar[float] = 0.5
 

{dycw_utilities-0.166.28 → dycw_utilities-0.166.30}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.166.28"
+__version__ = "0.166.30"

{dycw_utilities-0.166.28 → dycw_utilities-0.166.30}/src/utilities/pytest.py

@@ -28,7 +28,9 @@ from utilities.platform import (
     IS_NOT_WINDOWS,
     IS_WINDOWS,
 )
-from utilities.types import MaybeCoro
+from utilities.random import bernoulli
+from utilities.text import to_bool
+from utilities.types import MaybeCallableBoolLike, MaybeCoro, Seed
 from utilities.whenever import SECOND, get_now_local
 
 if TYPE_CHECKING:
@@ -166,6 +168,66 @@ class _NodeIdToPathNotGetTailError(NodeIdToPathError):
 ##
 
 
+def run_frac[F: Callable[..., MaybeCoro[None]]](
+    *,
+    predicate: MaybeCallableBoolLike | None = None,
+    frac: float = 0.5,
+    seed: Seed | None = None,
+) -> Callable[[F], F]:
+    """Run a test only a fraction of the time.."""
+    return cast(
+        "Any", partial(_run_frac_inner, predicate=predicate, frac=frac, seed=seed)
+    )
+
+
+def _run_frac_inner[F: Callable[..., MaybeCoro[None]]](
+    func: F,
+    /,
+    *,
+    predicate: MaybeCallableBoolLike | None = None,
+    frac: float = 0.5,
+    seed: Seed | None = None,
+) -> F:
+    match bool(iscoroutinefunction(func)):
+        case False:
+
+            @wraps(func)
+            def run_frac_sync(*args: Any, **kwargs: Any) -> None:
+                _skipif_frac(predicate=predicate, frac=frac, seed=seed)
+                cast("Callable[..., None]", func)(*args, **kwargs)
+
+            return cast("Any", run_frac_sync)
+
+        case True:
+
+            @wraps(func)
+            async def run_frac_async(*args: Any, **kwargs: Any) -> None:
+                _skipif_frac(predicate=predicate, frac=frac, seed=seed)
+                await cast("Callable[..., Coro[None]]", func)(*args, **kwargs)
+
+            return cast("Any", run_frac_async)
+
+        case never:
+            assert_never(never)
+
+
+def _skipif_frac(
+    *,
+    predicate: MaybeCallableBoolLike | None = None,
+    frac: float = 0.5,
+    seed: Seed | None = None,
+) -> None:
+    if skip is None:
+        return  # pragma: no cover
+    if ((predicate is None) or to_bool(predicate)) and bernoulli(
+        true=1 - frac, seed=seed
+    ):
+        _ = skip(reason=f"{_get_name()} skipped (run {frac:.0%})")
+
+
+##
+
+
 def throttle[F: Callable[..., MaybeCoro[None]]](
     *, root: PathLike | None = None, delta: Delta = SECOND, on_try: bool = False
 ) -> Callable[[F], F]:
@@ -181,7 +243,6 @@ def _throttle_inner[F: Callable[..., MaybeCoro[None]]](
     delta: Delta = SECOND,
     on_try: bool = False,
 ) -> F:
-    """Throttle a test function/method."""
     if get_env_var("THROTTLE", nullable=True) is not None:
         return func
     match bool(iscoroutinefunction(func)), on_try:
@@ -276,6 +337,7 @@ __all__ = [
     "add_pytest_collection_modifyitems",
     "add_pytest_configure",
     "node_id_path",
+    "run_frac",
     "skipif_linux",
     "skipif_mac",
     "skipif_not_linux",