locust 2.38.2.dev7__tar.gz → 2.39.1.dev1__tar.gz

{locust-2.38.2.dev7 → locust-2.39.1.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: locust
-Version: 2.38.2.dev7
+Version: 2.39.1.dev1
 Summary: Developer-friendly load testing framework
 Project-URL: homepage, https://locust.io/
 Project-URL: repository, https://github.com/locustio/locust
@@ -33,6 +33,8 @@ Requires-Dist: geventhttpclient>=2.3.1
 Requires-Dist: locust-cloud>=1.26.3
 Requires-Dist: msgpack>=1.0.0
 Requires-Dist: psutil>=5.9.1
+Requires-Dist: python-engineio>=4.12.2
+Requires-Dist: python-socketio[client]>=5.13.0
 Requires-Dist: pywin32; sys_platform == 'win32'
 Requires-Dist: pyzmq>=25.0.0
 Requires-Dist: requests>=2.26.0; python_version <= '3.11'

{locust-2.38.2.dev7 → locust-2.39.1.dev1}/locust/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '2.38.2.dev7'
-__version_tuple__ = version_tuple = (2, 38, 2, 'dev7')
+__version__ = version = '2.39.1.dev1'
+__version_tuple__ = version_tuple = (2, 39, 1, 'dev1')
 
 __commit_id__ = commit_id = None

locust-2.39.1.dev1/locust/contrib/__init__.py

@@ -0,0 +1,5 @@
+# This directory contains modules that are experimental.
+
+# Generally they should not have any significant issues, but they may change without a major version bump for locust.
+
+# Some modules may require optional dependencies, typically installed with `pip install locust[name-of-module]`.

locust-2.39.1.dev1/locust/contrib/socketio.py

@@ -0,0 +1,95 @@
+from locust import User
+
+import gevent
+import socketio
+
+
+class SocketIOUser(User):
+    """
+    SocketIOUser wraps an instance of :class:`socketio.Client` to log requests.
+    See example in :gh:`examples/socketio/socketio_ex.py`.
+    """
+
+    abstract = True
+    options: dict = {}
+    """socketio.Client options, e.g. `{"reconnection_attempts": 1, "reconnection_delay": 2}`"""
+    client: socketio.Client
+    """The underlying :class:`socketio.Client` instance. Can be useful to call directly if you want to skip logging a requests."""
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.client = socketio.Client(**self.options)
+        self.ws_greenlet = gevent.spawn(self.client.wait)
+        self.client.on("*", self.on_message)
+
+    #
+    def on_message(self, event: str, data: str) -> None:
+        """
+        This is the default handler for events. You can override it for custom behavior,
+        or even register separate handlers using self.client.on(event, handler)
+
+        Measuring response_time isn't obvious for for WebSockets. Sometimes a response time
+        can be inferred from the event data (if it contains a timestamp) or related to
+        a message that you sent. Override this method in your User class to do that.
+        """
+        self.environment.events.request.fire(
+            request_type="WSR",
+            name=event,
+            response_time=0,
+            response_length=len(data or []),
+            exception=None,
+            context={},
+        )
+
+    def connect(self, *args, **kwargs):
+        """
+        Wraps :meth:`socketio.Client.connect`.
+        """
+        with self.environment.events.request.measure("WS", "connect") as _:
+            self.client.connect(*args, **kwargs)
+
+    def send(self, name, data=None, namespace=None) -> None:
+        """
+        Wraps :meth:`socketio.Client.send`.
+        """
+        exception = None
+        try:
+            self.client.send(data, namespace)
+        except Exception as e:
+            exception = e
+        self.environment.events.request.fire(
+            request_type="WSS",
+            name=name,
+            response_time=0,
+            response_length=len(data or []),
+            exception=exception,
+            context={},
+        )
+
+    def emit(self, name, data=None, namespace=None, callback=None) -> None:
+        """
+        Wraps :meth:`socketio.Client.emit`.
+        """
+        exception = None
+        try:
+            self.client.emit(name, data, namespace, callback)
+        except Exception as e:
+            exception = e
+        self.environment.events.request.fire(
+            request_type="WSE",
+            name=name,
+            response_time=0,
+            response_length=len(data or []),
+            exception=exception,
+            context={},
+        )
+
+    def call(self, event, data=None, *args, **kwargs):
+        """
+        Wraps :meth:`socketio.Client.call`.
+        """
+        with self.environment.events.request.measure("WSC", event) as _:
+            return self.client.call(event, data, *args, **kwargs)
+
+    def on_stop(self):
+        self.client.disconnect()

{locust-2.38.2.dev7 → locust-2.39.1.dev1}/pyproject.toml

@@ -50,6 +50,8 @@ dependencies = [
     "setuptools>=70.0.0",
     "locust-cloud>=1.26.3",
     "gevent>=24.10.1,<26.0.0",
+    "python-socketio[client]>=5.13.0",
+    "python-engineio>=4.12.2",
 ]
 
 [project.optional-dependencies]
@@ -100,6 +102,10 @@ docs = [
     "sphinxcontrib-qthelp==1.0.3",
     "sphinxcontrib-serializinghtml==1.1.10",
     "sphinxcontrib-googleanalytics>=0.4",
+    # these optional dependencies are needed to build the some contrib modules
+    "pymilvus>=2.5.0",
+    "psycopg[binary]>=3.2.1",
+    "pymongo>=4.8.0"
 ]
 milvus = [
     "pymilvus>=2.5.0",