locust 2.38.2.dev7__py3-none-any.whl → 2.38.2.dev21__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.38.2.dev7'
-__version_tuple__ = version_tuple = (2, 38, 2, 'dev7')
+__version__ = version = '2.38.2.dev21'
+__version_tuple__ = version_tuple = (2, 38, 2, 'dev21')
 
 __commit_id__ = commit_id = None

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/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.dist-info → locust-2.38.2.dev21.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: locust
-Version: 2.38.2.dev7
+Version: 2.38.2.dev21
 Summary: Developer-friendly load testing framework
 Project-URL: homepage, https://locust.io/
 Project-URL: repository, https://github.com/locustio/locust
@@ -33,6 +33,7 @@ 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-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.dist-info → locust-2.38.2.dev21.dist-info}/RECORD

@@ -1,6 +1,6 @@
 locust/__init__.py,sha256=HadpgGidiyCDPSKwkxrk1Qw6eB7dTmftNJVftuJzAiw,1876
 locust/__main__.py,sha256=vBQ82334kX06ImDbFlPFgiBRiLIinwNk3z8Khs6hd74,31
-locust/_version.py,sha256=s2j9gE6VWFZ3Bbw6sbjPzaEsKdu7tciZebcEag4lP4c,719
+locust/_version.py,sha256=p8zeYDV-RC8SI8ouqHrCtIHFcanHPr6XX8PXeHk5P4I,721
 locust/argument_parser.py,sha256=t6mAoK9u13DxC9UH-alVqS6fFABFTyNWSJG89yQ4QQQ,33056
 locust/clients.py,sha256=o-277lWQdpmPnoRTdf3IQVNPQT8LMFDtPtuxbLHQIIs,19286
 locust/debug.py,sha256=7CCm8bIg44uGH2wqBlo1rXBzV2VzwPicLxLewz8r5CQ,5099
@@ -17,12 +17,13 @@ locust/runners.py,sha256=niYmGsfOpxMfVmTXGod4MYTefpaZ2wirFlhqxRw5mq4,70617
 locust/shape.py,sha256=t-lwBS8LOjWcKXNL7j2U3zroIXJ1b0fazUwpRYQOKXw,1973
 locust/stats.py,sha256=qyoSKT0i7RunLDj5pMGqizK1Sp8bcqUsXwh2m4_DpR8,47203
 locust/web.py,sha256=HLFN9jUtKG3sMIKu_Xw9wtvTAFxXvzDHdtLtfb_JxUQ,31849
-locust/contrib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+locust/contrib/__init__.py,sha256=LtZN7MczpIAbZkN7PT2h8W2wgb9nBl6cDXbFCVsV4fo,290
 locust/contrib/fasthttp.py,sha256=QfVpcdo5oKOO1rKLXeCeTJ4t57XU1lhIIWeUeeSJtIE,29650
 locust/contrib/milvus.py,sha256=YabgLd0lImzWupJFCm0OZAW-Nxeibwn91ldWpZ2irDo,12811
 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/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
@@ -54,8 +55,8 @@ locust/webui/dist/assets/index-BjqxSg7R.js,sha256=3JyrKWfAg8LlTy2bxAJh73c6njNPhN
 locust/webui/dist/assets/terminal.gif,sha256=iw80LO2u0dnf4wpGfFJZauBeKTcSpw9iUfISXT2nEF4,75302
 locust/webui/dist/assets/testruns-dark.png,sha256=G4p2VZSBuuqF4neqUaPSshIp5OKQJ_Bvb69Luj6XuVs,125231
 locust/webui/dist/assets/testruns-light.png,sha256=JinGDiiBPOkhpfF-XCbmQqhRInqItrjrBTLKt5MlqVI,130301
-locust-2.38.2.dev7.dist-info/METADATA,sha256=Y85K_sULv2Nnz46NJgs-rAr3QeH01cT0OOlBsy9LyoA,9476
-locust-2.38.2.dev7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-locust-2.38.2.dev7.dist-info/entry_points.txt,sha256=RAdt8Ku-56m7bFjmdj-MBhbF6h4NX7tVODR9QNnOg0E,44
-locust-2.38.2.dev7.dist-info/licenses/LICENSE,sha256=5hnz-Vpj0Z3kSCQl0LzV2hT1TLc4LHcbpBp3Cy-EuyM,1110
-locust-2.38.2.dev7.dist-info/RECORD,,
+locust-2.38.2.dev21.dist-info/METADATA,sha256=XpyoRPuFbgJt-ljIUQtbZpIDS_0nq5VALqWQVIbWshU,9524
+locust-2.38.2.dev21.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+locust-2.38.2.dev21.dist-info/entry_points.txt,sha256=RAdt8Ku-56m7bFjmdj-MBhbF6h4NX7tVODR9QNnOg0E,44
+locust-2.38.2.dev21.dist-info/licenses/LICENSE,sha256=5hnz-Vpj0Z3kSCQl0LzV2hT1TLc4LHcbpBp3Cy-EuyM,1110
+locust-2.38.2.dev21.dist-info/RECORD,,