locust 2.40.2.dev8__py3-none-any.whl → 2.40.2.dev15__py3-none-any.whl

locust/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '2.40.2.dev8'
-__version_tuple__ = version_tuple = (2, 40, 2, 'dev8')
+__version__ = version = '2.40.2.dev15'
+__version_tuple__ = version_tuple = (2, 40, 2, 'dev15')
 
 __commit_id__ = commit_id = None

locust/contrib/socketio.py

@@ -1,63 +1,34 @@
 from locust import User
+from locust.event import EventHook
+
+from typing import Any
 
 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):
+class SocketIOClient(socketio.Client):
+    def __init__(self, request_event: EventHook, *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={},
-        )
+        self.request_event = request_event
 
     def connect(self, *args, **kwargs):
         """
         Wraps :meth:`socketio.Client.connect`.
         """
-        with self.environment.events.request.measure("WS", "connect") as _:
-            self.client.connect(*args, **kwargs)
+        with self.request_event.measure("WS", "connect") as _:
+            super().connect(*args, **kwargs)
 
-    def send(self, name, data=None, namespace=None) -> None:
+    def send(self, data, namespace=None, callback=None, name="Unnamed") -> None:
         """
         Wraps :meth:`socketio.Client.send`.
         """
         exception = None
         try:
-            self.client.send(data, namespace)
+            super().send(data, namespace, callback)
         except Exception as e:
             exception = e
-        self.environment.events.request.fire(
+        self.request_event.fire(
             request_type="WSS",
             name=name,
             response_time=0,
@@ -66,18 +37,18 @@ class SocketIOUser(User):
             context={},
         )
 
-    def emit(self, name, data=None, namespace=None, callback=None) -> None:
+    def emit(self, event, data=None, namespace=None, callback=None) -> None:
         """
         Wraps :meth:`socketio.Client.emit`.
         """
         exception = None
         try:
-            self.client.emit(name, data, namespace, callback)
+            super().emit(event, data, namespace, callback)
         except Exception as e:
             exception = e
-        self.environment.events.request.fire(
+        self.request_event.fire(
             request_type="WSE",
-            name=name,
+            name=str(event),
             response_time=0,
             response_length=len(data or []),
             exception=exception,
@@ -88,8 +59,41 @@ class SocketIOUser(User):
         """
         Wraps :meth:`socketio.Client.call`.
         """
-        with self.environment.events.request.measure("WSC", event) as _:
-            return self.client.call(event, data, *args, **kwargs)
+        with self.request_event.measure("WSC", event) as _:
+            return super().call(event, data, *args, **kwargs)
 
-    def on_stop(self):
-        self.client.disconnect()
+    def on_message(self, event: str, data: str) -> None:
+        """
+        This is the default handler for events received.
+        You can register separate handlers using self.sio.on(event, handler)
+
+        Measuring response_time isn't obvious for for WebSockets/SocketIO so we set them to 0.
+        Sometimes 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.request_event.fire(
+            request_type="WSR",
+            name=event,
+            response_time=0,
+            response_length=len(data or []),
+            exception=None,
+            context={},
+        )
+
+
+class SocketIOUser(User):
+    """
+    SocketIOUser creates an instance of :class:`socketio.Client` to log requests.
+    See example in :gh:`examples/socketio/socketio_ex.py`.
+    """
+
+    abstract = True
+    options: dict[str, Any] = {}
+    """socketio.Client options, e.g. `{"reconnection_attempts": 1, "reconnection_delay": 2, "logger": True, "engineio_logger": True}`"""
+    sio: SocketIOClient
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.sio = SocketIOClient(self.environment.events.request, **self.options)
+        self.sio_greenlet = gevent.spawn(self.sio.wait)
+        self.sio.on("*", self.sio.on_message)

{locust-2.40.2.dev8.dist-info → locust-2.40.2.dev15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: locust
-Version: 2.40.2.dev8
+Version: 2.40.2.dev15
 Summary: Developer-friendly load testing framework
 Project-URL: homepage, https://locust.io/
 Project-URL: repository, https://github.com/locustio/locust

{locust-2.40.2.dev8.dist-info → locust-2.40.2.dev15.dist-info}/RECORD

@@ -1,6 +1,6 @@
 locust/__init__.py,sha256=HadpgGidiyCDPSKwkxrk1Qw6eB7dTmftNJVftuJzAiw,1876
 locust/__main__.py,sha256=vBQ82334kX06ImDbFlPFgiBRiLIinwNk3z8Khs6hd74,31
-locust/_version.py,sha256=Yo7p4WMjo4WEZdk6lh1L8lnl3jdqfttrS1sF70sbnj4,719
+locust/_version.py,sha256=1lUD_y3GdgwY5ZP5Qi49KZlF9bRAYb_27xyeCkXcsGk,721
 locust/argument_parser.py,sha256=t6mAoK9u13DxC9UH-alVqS6fFABFTyNWSJG89yQ4QQQ,33056
 locust/clients.py,sha256=Gj1rD73_G7G7f6bi0plDiN-GIDPTBng8pBY21cFozQc,20219
 locust/debug.py,sha256=7CCm8bIg44uGH2wqBlo1rXBzV2VzwPicLxLewz8r5CQ,5099
@@ -23,7 +23,7 @@ locust/contrib/milvus.py,sha256=YabgLd0lImzWupJFCm0OZAW-Nxeibwn91ldWpZ2irDo,1281
 locust/contrib/mongodb.py,sha256=1seUYgJOaNKwybYOP9PUEVhgl8hGy-G33f8lFj3R8W8,1246
 locust/contrib/oai.py,sha256=Ot3T8lp31ThckGbNps86oVvq6Vn845Eec0mxhDmONDE,2684
 locust/contrib/postgres.py,sha256=OuMWnGYN10K65Tq2axVESEW25Y0g5gJb0rK90jkcCJg,1230
-locust/contrib/socketio.py,sha256=PpXKHFTlQgFNNkdwU3N3AvJ18XERoQtxxTmOira0Lyo,3152
+locust/contrib/socketio.py,sha256=iznaDtXx7ytd60-_oJAb6tc9T26tJ-NcL6vLeTh-AtQ,3236
 locust/rpc/__init__.py,sha256=5YOu-58XSnt-oWWNATgXLTNdYoDkkngwHNXprxkWKSM,99
 locust/rpc/protocol.py,sha256=n-rb3GZQcAlldYDj4E4GuFGylYj_26GSS5U29meft5Y,1282
 locust/rpc/zmqrpc.py,sha256=tMeLQiLII8QP29lAHGZsj5Pf5FsTL-X4wM0DrtR3ALw,3214
@@ -56,8 +56,8 @@ locust/webui/dist/assets/terminal.gif,sha256=iw80LO2u0dnf4wpGfFJZauBeKTcSpw9iUfI
 locust/webui/dist/assets/testruns-dark.png,sha256=G4p2VZSBuuqF4neqUaPSshIp5OKQJ_Bvb69Luj6XuVs,125231
 locust/webui/dist/assets/testruns-light.png,sha256=JinGDiiBPOkhpfF-XCbmQqhRInqItrjrBTLKt5MlqVI,130301
 pytest_locust/plugin.py,sha256=WAyiRHLynXegbbX2DxIutPKO4PQRT6JdBFA7zbbaJgM,1469
-locust-2.40.2.dev8.dist-info/METADATA,sha256=XS_Z92MjgHNPw4zlZZlgrMQiovOmKU_m6fmWb0i7oqI,9598
-locust-2.40.2.dev8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-locust-2.40.2.dev8.dist-info/entry_points.txt,sha256=0uIHcQ71R1qaWhM_sd8uBUCCJgp7gJfGHUVMnJeZfcY,86
-locust-2.40.2.dev8.dist-info/licenses/LICENSE,sha256=5hnz-Vpj0Z3kSCQl0LzV2hT1TLc4LHcbpBp3Cy-EuyM,1110
-locust-2.40.2.dev8.dist-info/RECORD,,
+locust-2.40.2.dev15.dist-info/METADATA,sha256=Twi0mcXhfvVh7tKWHwHemQTdyVoDofdcAHnIYFD8JE0,9599
+locust-2.40.2.dev15.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+locust-2.40.2.dev15.dist-info/entry_points.txt,sha256=0uIHcQ71R1qaWhM_sd8uBUCCJgp7gJfGHUVMnJeZfcY,86
+locust-2.40.2.dev15.dist-info/licenses/LICENSE,sha256=5hnz-Vpj0Z3kSCQl0LzV2hT1TLc4LHcbpBp3Cy-EuyM,1110
+locust-2.40.2.dev15.dist-info/RECORD,,