locust 2.20.0__py3-none-any.whl → 2.20.1__py3-none-any.whl

locust/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.20.0'
-__version_tuple__ = version_tuple = (2, 20, 0)
+__version__ = version = '2.20.1'
+__version_tuple__ = version_tuple = (2, 20, 1)

locust/argument_parser.py

@@ -355,7 +355,7 @@ def setup_parser_arguments(parser):
         dest="web_auth",
         metavar="<username:password>",
         default=None,
-        help="DEPRECATED Turn on Basic Auth for the web interface. Should be supplied in the following format: username:password",
+        help="DEPRECATED. See https://github.com/locustio/locust/issues/2517 Turn on Basic Auth for the web interface. Should be supplied in the following format: username:password ",
         env_var="LOCUST_WEB_AUTH",
     )
     web_ui_group.add_argument(

locust/debug.py

@@ -2,6 +2,7 @@ from datetime import datetime, timezone
 import os
 import inspect
 import locust
+import locust.log
 from locust import User, argument_parser
 from typing import Type, Optional
 from locust.env import Environment
@@ -102,7 +103,7 @@ def run_single_user(
     include_time=False,
     include_context=False,
     include_payload=False,
-    loglevel=None,
+    loglevel: Optional[str] = "WARNING",
 ):
     """
     Runs a single User. Useful when you want to run a debugger.
@@ -113,8 +114,8 @@ def run_single_user(
 
     It prints some info about every request to stdout, and you can get additional info using the `include_*` flags
 
-    By default, it does not set up locusts logging system (because it could interfere with the printing of requests),
-    but you can change that by passing a log level (e.g. *loglevel="INFO"*)
+    It also initiates logging on WARNING level (not INFO, because it could interfere with the printing of requests),
+    but you can change that by passing a log level (or disabling logging entirely by passing None)
     """
     global _env
 
@@ -141,6 +142,9 @@ def run_single_user(
         )
         # fire various events (quit and test_stop will never get called, sorry about that)
         _env.events.init.fire(environment=_env, runner=None, web_ui=None)
+        # uncaught events will be suppressed, so check if that happened
+        if locust.log.unhandled_greenlet_exception:
+            raise Exception("Unhandled exception in init")
 
     # do the things that the Runner usually does
     _env.user_classes = [user_class]

locust/event.py

@@ -55,7 +55,12 @@ class EventHook:
     ) -> Generator[Dict[str, Any], None, None]:
         """Convenience method for firing the event with automatically calculated response time and automatically marking the request as failed if an exception is raised (this is really only useful for the *request* event)
 
-        Other attributes in the event can be added/updated inside your with block if you use the "with ... as request_meta:" syntax.
+        Example usage (in a task):
+
+            with self.environment.events.request.measure("myrequestType", "myRequestName") as request_meta:
+                # do the stuff you want to measure
+
+        You can optionally add/overwrite entries in the request_meta dict and they will be passed to the request event.
 
         Experimental.
         """
@@ -91,7 +96,7 @@ class DeprecatedEventHook(EventHook):
 class Events:
     request: EventHook
     """
-    Fired when a request in completed, successful or unsuccessful. This event is typically used to report requests when writing custom clients for locust.
+    Fired when a request in completed.
 
     Event arguments:
 
@@ -102,6 +107,8 @@ class Events:
     :param response: Response object (e.g. a :py:class:`requests.Response`)
     :param context: :ref:`User/request context <request_context>`
     :param exception: Exception instance that was thrown. None if request was successful.
+
+    If you want to simplify a custom client, you can have Locust measure the time for you by using :meth:`measure() <locust.event.EventHook.measure>`
     """
 
     user_error: EventHook

locust/main.py

@@ -428,7 +428,9 @@ See https://github.com/locustio/locust/wiki/Installation#increasing-maximum-numb
                 else:
                     logger.info(f"Starting web interface at {protocol}://0.0.0.0:{options.web_port}")
             if options.web_auth:
-                logging.info("BasicAuth support is deprecated, it will be removed in a future release.")
+                logging.warning(
+                    "BasicAuth support is deprecated, it will be removed in a future release, unless someone reimplements it in a more modern way! See https://github.com/locustio/locust/issues/2517"
+                )
             web_ui = environment.create_web_ui(
                 host=web_host,
                 port=options.web_port,

locust/rpc/zmqrpc.py

@@ -13,6 +13,7 @@ class BaseSocket:
 
         self.socket.setsockopt(zmq.TCP_KEEPALIVE, 1)
         self.socket.setsockopt(zmq.TCP_KEEPALIVE_IDLE, 30)
+        self.socket.setsockopt(zmq.IPV6, 1)
 
     @retry()
     def send(self, msg):

locust/test/test_debugging.py

@@ -23,7 +23,7 @@ class TestDebugging(DebugTestCase):
 
         class MyUser1(HttpUser):
             @task
-            def my_task():
+            def my_task(self):
                 pass
 
         def _stop_user():
@@ -34,4 +34,7 @@ class TestDebugging(DebugTestCase):
         t = Timer(1, _stop_user)
         t.start()
 
-        debug.run_single_user(MyUser1)
+        debug.run_single_user(
+            MyUser1,
+            loglevel=None,  # another log setup might mess with other tests...
+        )

locust/test/test_zmqrpc.py

@@ -8,7 +8,7 @@ from locust.exception import RPCError, RPCSendError, RPCReceiveError
 class ZMQRPC_tests(LocustTestCase):
     def setUp(self):
         super().setUp()
-        self.server = zmqrpc.Server("127.0.0.1", 0)
+        self.server = zmqrpc.Server("*", 0)
         self.client = zmqrpc.Client("localhost", self.server.port, "identity")
 
     def tearDown(self):
@@ -19,8 +19,10 @@ class ZMQRPC_tests(LocustTestCase):
     def test_constructor(self):
         self.assertEqual(self.server.socket.getsockopt(zmq.TCP_KEEPALIVE), 1)
         self.assertEqual(self.server.socket.getsockopt(zmq.TCP_KEEPALIVE_IDLE), 30)
+        self.assertEqual(self.server.socket.getsockopt(zmq.IPV6), 1)
         self.assertEqual(self.client.socket.getsockopt(zmq.TCP_KEEPALIVE), 1)
         self.assertEqual(self.client.socket.getsockopt(zmq.TCP_KEEPALIVE_IDLE), 30)
+        self.assertEqual(self.client.socket.getsockopt(zmq.IPV6), 1)
 
     def test_client_send(self):
         self.client.send(Message("test", "message", "identity"))
@@ -40,15 +42,15 @@ class ZMQRPC_tests(LocustTestCase):
         self.assertEqual(msg.node_id, "identity")
 
     def test_client_retry(self):
-        server = zmqrpc.Server("127.0.0.1", 0)
+        server = zmqrpc.Server("*", 0)
         server.socket.close()
         with self.assertRaises(RPCError):
             server.recv_from_client()
 
     def test_rpc_error(self):
-        server = zmqrpc.Server("127.0.0.1", 0)
+        server = zmqrpc.Server("*", 0)
         with self.assertRaises(RPCError):
-            server = zmqrpc.Server("127.0.0.1", server.port)
+            server = zmqrpc.Server("*", server.port)
         server.close()
         with self.assertRaises(RPCSendError):
             server.send_to_client(Message("test", "message", "identity"))

locust/user/task.py

@@ -88,7 +88,7 @@ def task(weight: TaskT | int = 1) -> TaskT | Callable[[TaskT], TaskT]:
     Check if task was used without parentheses (not called), like this::
 
         @task
-        def my_task()
+        def my_task(self)
             pass
     """
     if callable(weight):

{locust-2.20.0.dist-info → locust-2.20.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: locust
-Version: 2.20.0
+Version: 2.20.1
 Summary: Developer friendly load testing framework
 License: MIT
 Project-URL: Homepage, https://locust.io/
@@ -30,7 +30,7 @@ License-File: LICENSE
 Requires-Dist: gevent >=22.10.2
 Requires-Dist: flask >=2.0.0
 Requires-Dist: Werkzeug >=2.0.0
-Requires-Dist: requests >=2.23.0
+Requires-Dist: requests >=2.26.0
 Requires-Dist: msgpack >=1.0.0
 Requires-Dist: pyzmq >=25.0.0
 Requires-Dist: geventhttpclient >=2.0.11
@@ -45,12 +45,16 @@ Requires-Dist: pywin32 ; platform_system == "Windows"
 
 [![PyPI](https://img.shields.io/pypi/v/locust.svg)](https://pypi.org/project/locust/)
 [![PyPI](https://img.shields.io/pypi/pyversions/locust.svg)](https://pypi.org/project/locust/)
+[![Downloads](https://pepy.tech/badge/locust/week)](https://pepy.tech/project/locust)
 [![Build Status](https://github.com/locustio/locust/workflows/Tests/badge.svg)](https://github.com/locustio/locust/actions?query=workflow%3ATests)
-[![license](https://img.shields.io/github/license/locustio/locust.svg)](https://github.com/locustio/locust/blob/master/LICENSE)
 [![GitHub contributors](https://img.shields.io/github/contributors/locustio/locust.svg)](https://github.com/locustio/locust/graphs/contributors)
 [![Support Ukraine Badge](https://bit.ly/support-ukraine-now)](https://github.com/support-ukraine/support-ukraine)
 
-Locust is an easy to use, scriptable and scalable performance testing tool. You define your load test in regular Python code, instead of being constrained by a UI or domain specific language that only pretends to be real code. This makes Locust infinitely expandable and very developer friendly.
+Locust is an open source performance/load testing tool for HTTP and other protocols. Its developer friendly approach lets you to define your tests in regular Python code.
+
+Locust tests can be run from command line or using its web-based UI. Throughput, response times and errors can be viewed in real time and/or exported for later analysis.
+
+You can import regular Python libraries into your tests, and with Locust's pluggable architecture it is infinitely expandable. Unlike when using most other tools, your test design will never be limited by a GUI or domain-specific language.
 
 To get started right away, head over to the [documentation](http://docs.locust.io/en/stable/installation.html).
 

{locust-2.20.0.dist-info → locust-2.20.1.dist-info}/RECORD

@@ -1,17 +1,17 @@
 locust/__init__.py,sha256=Q6sqz7YDUaMKPEqcDjWcXEFG2ilVRQR7kl0fG0yK_5A,1402
 locust/__main__.py,sha256=vBQ82334kX06ImDbFlPFgiBRiLIinwNk3z8Khs6hd74,31
-locust/_version.py,sha256=06rDmnBueRSgi5xMbJeJJv4Inf7i7qfZ2JToAUH8pTU,413
-locust/argument_parser.py,sha256=H2tzJLu1F3oxxYkXLRUT6GtpV5UG5aGTcPWI3XwE4-c,26365
+locust/_version.py,sha256=O_9E_1sV6go84VUte56oNsLchT6VjfhXsbplO2mVbJY,413
+locust/argument_parser.py,sha256=eCJM29OX7NcMROfNSxQm0uyNcEtml6Rj202t51TlovE,26418
 locust/clients.py,sha256=GJXTWcyBAepE6O-o-V92WboV8XKOXxWR-AixlcL74_w,14768
-locust/debug.py,sha256=pEnZ74679vCdDODEMTNvjYcVdWCe4sWolHDJvdXh9dU,4818
+locust/debug.py,sha256=Rq0Wjs0esvjevAiUb04QhkLeClldwFvm5cj0aDl40dE,5063
 locust/dispatch.py,sha256=nVWXBkUzpqsVeVp5sw3sYSjR1dD5AAUiFLqutqsrlm4,18634
 locust/env.py,sha256=RntbYEcxP95Lrv80silTHI9qBthjdgz7OYH_HiM6s7U,11429
-locust/event.py,sha256=On9fb-FL9GxTDsgd8yApUoPoe2fShyPm2a3_9JrrobA,7453
+locust/event.py,sha256=5NmOGPuYP89Wz8UjF9QRVx4N8GPuAlOrbtQWOLBmTH8,7671
 locust/exception.py,sha256=aGCx5TQmkYZn8P_uDD3Z4ZwxxRoA7R3ml0WJO-nHgFQ,1942
 locust/html.py,sha256=2mp33VdzqYHaugas3nGtW-ypWRLzGyhPYwin6HFkA98,5717
 locust/input_events.py,sha256=ARmzf5K_t4OnsNilkx0adDnNqvU9-NxtQvKOOjwgA_A,3048
 locust/log.py,sha256=2IVp9YL4ZPfWdj3sBFuOHfgneg3g7m7tUGR-sy2s3E8,3155
-locust/main.py,sha256=Kf9zoml_ZpRdTSgSA9-wtzJtcSzTZw-T0YIwV_Lgf50,27009
+locust/main.py,sha256=1W_omId9MMARONGmo08BfIIKvutdDuDWL5VfV9SijgM,27154
 locust/py.typed,sha256=gkWLl8yD4mIZnNYYAIRM8g9VarLvWmTAFeUfEbxJLBw,65
 locust/runners.py,sha256=C1Lxdc3mZbomJcwt7OPCRdHXECvinJJ8I4wsfh7o_6g,65805
 locust/shape.py,sha256=SrKDabGtZ5bqMopJDdivvLbPencaYfAPUv1qzQiAgiA,1969
@@ -21,7 +21,7 @@ locust/contrib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 locust/contrib/fasthttp.py,sha256=qAEW7EwLot605rm1irLSuGA3TixvfioNYnKsq2PolWY,26534
 locust/rpc/__init__.py,sha256=nVGoHWFQxZjnhCDWjbgXIbmFbN9sizAjkhvSs9_642c,58
 locust/rpc/protocol.py,sha256=AGFtveF7-_i5ipsRYhT-ily4blxnjZ3FXeIL6ZabO4c,1285
-locust/rpc/zmqrpc.py,sha256=zG6hli3RouftrI28XqAlHtZ-UUSM9Wn41HkY9cKgAU4,2591
+locust/rpc/zmqrpc.py,sha256=r4k7ALZwBUHcPuFbfa3nYf-zsi8Gfaj8jHnrk4zfmgc,2635
 locust/static/chart.js,sha256=Aue4SxJZhv9I3k0Nr2uXTrdrLxsrX7x_a0d4u3a1e_Q,4796
 locust/static/echarts.common.min.js,sha256=2h6zIZeHk-eGAiC-qYvxv7uW5S1HcyM72K5FbcVhky4,620458
 locust/static/jquery-1.11.3.min.js,sha256=7LkWEzqTdpEfELxcZZlS6wAx5Ff13zZ83lYO2_ujj7g,95957
@@ -52,7 +52,7 @@ locust/test/fake_module1_for_env_test.py,sha256=dzGYWCr1SSkd8Yyo68paUNrCNW7YY_Qg
 locust/test/fake_module2_for_env_test.py,sha256=dzGYWCr1SSkd8Yyo68paUNrCNW7YY_QgjRb7sM37gG0,164
 locust/test/mock_locustfile.py,sha256=N9sGjW-BmJ-J_x-5bEOR82VQ0DhR1hki313BHPOWq4g,1273
 locust/test/mock_logging.py,sha256=9KC_YXa0DvF44lvpDnWhjV0GLrtwtt2SxZIzM6sJGzU,783
-locust/test/test_debugging.py,sha256=_2by3ejG4Ujx8tz3-OOXiRBJzjwouS-jznKg5MZuGvk,963
+locust/test/test_debugging.py,sha256=b-ekJpcwVWYlmIizdZYpbk1RMzrWPilM_iyzhb9tMvc,1069
 locust/test/test_dispatch.py,sha256=z94qj0exsIqtPl_TAx3vvBGxVBQoLovWcUPQfNulVO8,166172
 locust/test/test_env.py,sha256=Mp3EKVAjC84j57_yp7Gq67Q5TFyEOSQJ-mZyis_vt1c,6126
 locust/test/test_fasthttp.py,sha256=IIwyIIQIk8o_Hkyhg55Ff6NHF3hwXRBQJdhxNM8oEns,29886
@@ -73,13 +73,13 @@ locust/test/test_users.py,sha256=MErMCsEsHNALBj-GHcWjhZW5oMIoE4mbQW9dWqDHDQc,213
 locust/test/test_util.py,sha256=-wwdxyf1sqKVV_R2wDFZlp56ghBDkbS-leBEfjhxbMQ,1228
 locust/test/test_wait_time.py,sha256=9Qw48gGuJYpeb_0lr-bwuH3TjA4v2UQ1yDPZfUAjXX0,2353
 locust/test/test_web.py,sha256=I5Knomt9JQ1YSdiO2dyfVUDFkhOCuVey_R9_J0Qoy-s,48092
-locust/test/test_zmqrpc.py,sha256=JQ0iYWJoQb2JeS6EMvh_sOaG_sNjjXfT4V5RfsRnxlQ,2065
+locust/test/test_zmqrpc.py,sha256=ETSahaxHG5snJAeTqQevPc9tuqpmOMBaKpZxPfwxh_I,2171
 locust/test/testcases.py,sha256=DkrP1mV5DX42kruPxAVj-dGLXq-XAy3WtEslDE69vlA,6979
 locust/test/util.py,sha256=LmxhmhLeXlsHnj1fPyesunHz5yqC9o0-UqOug5VBw14,2667
 locust/user/__init__.py,sha256=u5wggKl1tLRFlO66xbyVoQAHrbRRfEE7bFuY1AmUZOY,71
 locust/user/inspectuser.py,sha256=oKJEVWrFtNaPsZJRaNm3gbR0LyjVYPHtnrHjgtdJU1w,2641
 locust/user/sequential_taskset.py,sha256=6oaUz64xS13cpAgO--HxeMgn2N98DPpylUHqJ8H1v80,2542
-locust/user/task.py,sha256=cGlBXak2pqwHs_DDy-ehjTcwHaAFxP7uR8v05NQGNQ0,16780
+locust/user/task.py,sha256=ER73Ai2IJ50eQZxb0u8ziLAFiQ3QqYwFIaIjDJpGc58,16784
 locust/user/users.py,sha256=lZtUojQoimuIh2hqEnf9clj58U22n7OnpiCYzDu_dtw,9737
 locust/user/wait_time.py,sha256=bGRKMVx4lom75sX3POYJUa1CPeME2bEAXG6CEgxSO5U,2675
 locust/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -94,9 +94,9 @@ locust/webui/dist/report.html,sha256=Vyi9LIAjBNiAsvn6LVFkdAZ9R4Fa8UjHnqscjAeOFp8
 locust/webui/dist/assets/favicon.ico,sha256=IUl-rYqfpHdV38e-s0bkmFIeLS-n3Ug0DQxk-h202hI,8348
 locust/webui/dist/assets/index-01afe4fa.js,sha256=uXPULlueC1FWZnTAMk7oA0wCSeY7xtNbxxycrIVvEGQ,1627703
 locust/webui/dist/assets/logo.png,sha256=lPCYhpDsPXYY3gUMlq3bzABI5WBtdBOvtay8R9hRFv4,2943
-locust-2.20.0.dist-info/LICENSE,sha256=78XGpIn3fHVBfaxlPNUfjVufSN7QsdhpJMRJHv2AFpo,1095
-locust-2.20.0.dist-info/METADATA,sha256=AoFzNr5VqIAiqzOwkW0SdsOBCNFvG6Cwxi1ZRWn6nNE,7144
-locust-2.20.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-locust-2.20.0.dist-info/entry_points.txt,sha256=RAdt8Ku-56m7bFjmdj-MBhbF6h4NX7tVODR9QNnOg0E,44
-locust-2.20.0.dist-info/top_level.txt,sha256=XSsjgPA8Ggf9TqKVbkwSqZFuPlZ085X13M9orDycE20,7
-locust-2.20.0.dist-info/RECORD,,
+locust-2.20.1.dist-info/LICENSE,sha256=78XGpIn3fHVBfaxlPNUfjVufSN7QsdhpJMRJHv2AFpo,1095
+locust-2.20.1.dist-info/METADATA,sha256=JNOQAAmR_mugbDsx4rBpOOPk2UveTUAz1fwJzVBcJyo,7389
+locust-2.20.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+locust-2.20.1.dist-info/entry_points.txt,sha256=RAdt8Ku-56m7bFjmdj-MBhbF6h4NX7tVODR9QNnOg0E,44
+locust-2.20.1.dist-info/top_level.txt,sha256=XSsjgPA8Ggf9TqKVbkwSqZFuPlZ085X13M9orDycE20,7
+locust-2.20.1.dist-info/RECORD,,