locust 2.46.5.dev8__tar.gz → 2.46.6.dev2__tar.gz

{locust-2.46.5.dev8 → locust-2.46.6.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: locust
-Version: 2.46.5.dev8
+Version: 2.46.6.dev2
 Summary: Developer-friendly load testing framework
 Project-URL: Homepage, https://locust.cloud/
 Project-URL: Repository, https://github.com/locustio/locust

{locust-2.46.5.dev8 → locust-2.46.6.dev2}/locust/__init__.py

@@ -31,7 +31,7 @@ from .user.markov_taskset import MarkovTaskSet, transition, transitions
 from .user.sequential_taskset import SequentialTaskSet
 from .user.task import TaskSet, tag, task
 from .user.users import HttpUser, User
-from .user.wait_time import between, constant, constant_pacing, constant_throughput
+from .user.wait_time import between, constant, constant_pacing, constant_throughput, poisson
 
 events = Events()
 
@@ -51,6 +51,7 @@ __all__ = (
     "constant",
     "constant_pacing",
     "constant_throughput",
+    "poisson",
     "events",
     "LoadTestShape",
     "run_single_user",

{locust-2.46.5.dev8 → locust-2.46.6.dev2}/locust/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '2.46.5.dev8'
-__version_tuple__ = version_tuple = (2, 46, 5, 'dev8')
+__version__ = version = '2.46.6.dev2'
+__version_tuple__ = version_tuple = (2, 46, 6, 'dev2')
 
 __commit_id__ = commit_id = None

{locust-2.46.5.dev8 → locust-2.46.6.dev2}/locust/user/wait_time.py

@@ -84,3 +84,30 @@ def constant_throughput(task_runs_per_second: float) -> Callable[["User"], float
     the next task.
     """
     return constant_pacing(1 / task_runs_per_second)
+
+
+def poisson(rate: float) -> Callable[["User"], float]:
+    """
+    Returns a function that will return a random wait time sampled from an exponential
+    distribution with mean ``1/rate`` seconds. Tasks will therefore arrive according to a
+    Poisson process with mean rate ``rate`` tasks per second, which is a good approximation
+    of how real users arrive.
+
+    The average number of task runs per second will be ``rate``, but unlike
+    :py:func:`constant_throughput <locust.wait_time.constant_throughput>` the individual
+    intervals vary randomly, so bursts and quiet periods occur naturally.
+
+    Example::
+
+        class MyUser(User):
+            wait_time = poisson(2)  # on average, each user runs 2 tasks per second
+            @task
+            def my_task(self):
+                ...
+
+    If you have multiple requests in a task your RPS will of course be higher than the
+    specified throughput.
+    """
+    if rate <= 0:
+        raise ValueError(f"poisson() requires a positive rate, got: {rate}")
+    return lambda instance: random.expovariate(rate)