locust 2.29.0__py3-none-any.whl → 2.29.1__py3-none-any.whl

locust/__init__.py

@@ -12,7 +12,8 @@ if os.getenv("LOCUST_PLAYWRIGHT", None):
 
 from gevent import monkey
 
-monkey.patch_all()
+if not os.getenv("LOCUST_SKIP_MONKEY_PATCH", None):
+    monkey.patch_all()
 
 from ._version import version as __version__
 from .contrib.fasthttp import FastHttpUser

locust/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.29.0'
-__version_tuple__ = version_tuple = (2, 29, 0)
+__version__ = version = '2.29.1'
+__version_tuple__ = version_tuple = (2, 29, 1)

locust/clients.py

@@ -2,12 +2,12 @@ from __future__ import annotations
 
 import re
 import time
-from collections.abc import Generator
 from contextlib import contextmanager
+from typing import TYPE_CHECKING
 from urllib.parse import urlparse, urlunparse
 
 import requests
-from requests import Request, Response
+from requests import Response
 from requests.adapters import HTTPAdapter
 from requests.auth import HTTPBasicAuth
 from requests.exceptions import InvalidSchema, InvalidURL, MissingSchema, RequestException
@@ -15,12 +15,49 @@ from urllib3 import PoolManager
 
 from .exception import CatchResponseError, LocustError, ResponseError
 
+if TYPE_CHECKING:
+    import sys
+    from collections.abc import Callable, Generator, Iterable, Mapping, MutableMapping
+    from typing import Any, TypedDict
+
+    from requests.cookies import RequestsCookieJar
+
+    if sys.version_info >= (3, 11):
+        from typing import Unpack
+    else:
+        from typing_extensions import Unpack
+
+    # Annotations below were generated using output from mypy.
+    # Mypy underneath uses information from the https://github.com/python/typeshed repo.
+
+    class RequestKwargs(TypedDict, total=False):
+        params: Any | None  # simplified signature
+        headers: Mapping[str, str | bytes | None] | None
+        cookies: RequestsCookieJar | MutableMapping[str, str] | None
+        files: Any | None  # simplified signature
+        auth: Any | None  # simplified signature
+        timeout: float | tuple[float, float] | tuple[float, None] | None
+        allow_redirects: bool
+        proxies: MutableMapping[str, str] | None
+        hooks: Mapping[str, Iterable[Callable[[Response], Any]] | Callable[[Response], Any]] | None
+        stream: bool | None
+        verify: bool | str | None
+        cert: str | tuple[str, str] | None
+
+    class RESTKwargs(RequestKwargs, total=False):
+        name: str | None
+        catch_response: bool
+        context: dict
+
+
 absolute_http_url_regexp = re.compile(r"^https?://", re.I)
 
 
 class LocustResponse(Response):
-    def raise_for_status(self):
-        if hasattr(self, "error") and self.error:
+    error: Exception | None = None
+
+    def raise_for_status(self) -> None:
+        if self.error:
             raise self.error
         Response.raise_for_status(self)
 
@@ -77,7 +114,7 @@ class HttpSession(requests.Session):
         self.mount("https://", LocustHttpAdapter(pool_manager=pool_manager))
         self.mount("http://", LocustHttpAdapter(pool_manager=pool_manager))
 
-    def _build_url(self, path):
+    def _build_url(self, path) -> str:
         """prepend url with hostname unless it's already an absolute URL"""
         if absolute_http_url_regexp.match(path):
             return path
@@ -94,7 +131,18 @@ class HttpSession(requests.Session):
         finally:
             self.request_name = None
 
-    def request(self, method, url, name=None, catch_response=False, context={}, **kwargs):
+    def request(  # type: ignore[override]
+        self,
+        method: str | bytes,
+        url: str | bytes,
+        name: str | None = None,
+        catch_response: bool = False,
+        context: dict = {},
+        *,
+        data: Any | None = None,
+        json: Any | None = None,
+        **kwargs: Unpack[RequestKwargs],
+    ):
         """
         Constructs and sends a :py:class:`requests.Request`.
         Returns :py:class:`requests.Response` object.
@@ -108,7 +156,8 @@ class HttpSession(requests.Session):
           response, even if the response code is ok (2xx). The opposite also works, one can use catch_response to catch a request
           and then mark it as successful even if the response code was not (i.e 500 or 404).
         :param params: (optional) Dictionary or bytes to be sent in the query string for the :class:`Request`.
-        :param data: (optional) Dictionary or bytes to send in the body of the :class:`Request`.
+        :param data: (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the :class:`Request`.
+        :param json: (optional) json to send in the body of the :class:`Request`.
         :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`.
         :param cookies: (optional) Dict or CookieJar object to send with the :class:`Request`.
         :param files: (optional) Dictionary of ``'filename': file-like-objects`` for multipart encoding upload.
@@ -117,9 +166,17 @@ class HttpSession(requests.Session):
         :type timeout: float or tuple
         :param allow_redirects: (optional) Set to True by default.
         :type allow_redirects: bool
-        :param proxies: (optional) Dictionary mapping protocol to the URL of the proxy.
+        :param proxies: (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy.
+        :param hooks: (optional) Dictionary mapping hook name to one event or list of events, event must be callable.
         :param stream: (optional) whether to immediately download the response content. Defaults to ``False``.
-        :param verify: (optional) if ``True``, the SSL cert will be verified. A CA_BUNDLE path can also be provided.
+        :param verify: (optional) Either a boolean, in which case it controls whether we verify
+          the server's TLS certificate, or a string, in which case it must be a path
+          to a CA bundle to use. Defaults to ``True``. When set to
+          ``False``, requests will accept any TLS certificate presented by
+          the server, and will ignore hostname mismatches and/or expired
+          certificates, which will make your application vulnerable to
+          man-in-the-middle (MitM) attacks. Setting verify to ``False``
+          may be useful during local development or testing.
         :param cert: (optional) if String, path to ssl client cert file (.pem). If Tuple, ('cert', 'key') pair.
         """
 
@@ -132,11 +189,11 @@ class HttpSession(requests.Session):
 
         start_time = time.time()
         start_perf_counter = time.perf_counter()
-        response = self._send_request_safe_mode(method, url, **kwargs)
+        response = self._send_request_safe_mode(method, url, data=data, json=json, **kwargs)
         response_time = (time.perf_counter() - start_perf_counter) * 1000
 
         request_before_redirect = (response.history and response.history[0] or response).request
-        url = request_before_redirect.url
+        url = request_before_redirect.url  # type: ignore
 
         if not name:
             name = request_before_redirect.path_url
@@ -170,7 +227,7 @@ class HttpSession(requests.Session):
                 pass
             return response
 
-    def _send_request_safe_mode(self, method, url, **kwargs):
+    def _send_request_safe_mode(self, method, url, **kwargs) -> Response | LocustResponse:
         """
         Send an HTTP request, and catch any exception that might occur due to connection problems.
 
@@ -183,10 +240,84 @@ class HttpSession(requests.Session):
         except RequestException as e:
             r = LocustResponse()
             r.error = e
-            r.status_code = 0  # with this status_code, content returns None
-            r.request = Request(method, url).prepare()
+            r.status_code = 0
+            r.request = e.request  # type: ignore
             return r
 
+    def get(
+        self, url: str | bytes, *, data: Any | None = None, json: Any | None = None, **kwargs: Unpack[RESTKwargs]
+    ) -> ResponseContextManager | Response | LocustResponse:
+        """Sends a GET request"""
+        kwargs.setdefault("allow_redirects", True)
+        return self.request("GET", url, data=data, json=json, **kwargs)
+
+    def options(
+        self,
+        url: str | bytes,
+        *,
+        data: Any | None = None,
+        json: Any | None = None,
+        **kwargs: Unpack[RESTKwargs],
+    ) -> ResponseContextManager | Response | LocustResponse:
+        """Sends a OPTIONS request"""
+        kwargs.setdefault("allow_redirects", True)
+        return self.request("OPTIONS", url, data=data, json=json, **kwargs)
+
+    def head(
+        self,
+        url: str | bytes,
+        *,
+        data: Any | None = None,
+        json: Any | None = None,
+        **kwargs: Unpack[RESTKwargs],
+    ) -> ResponseContextManager | Response | LocustResponse:
+        """Sends a HEAD request"""
+        kwargs.setdefault("allow_redirects", False)
+        return self.request("HEAD", url, data=data, json=json, **kwargs)
+
+    def post(
+        self,
+        url: str | bytes,
+        data: Any | None = None,
+        json: Any | None = None,
+        **kwargs: Unpack[RESTKwargs],
+    ) -> ResponseContextManager | Response | LocustResponse:
+        """Sends a POST request"""
+        return self.request("POST", url, data=data, json=json, **kwargs)
+
+    def put(
+        self,
+        url: str | bytes,
+        data: Any | None = None,
+        *,
+        json: Any | None = None,
+        **kwargs: Unpack[RESTKwargs],
+    ) -> ResponseContextManager | Response | LocustResponse:
+        """Sends a PUT request"""
+        return self.request("PUT", url, data=data, json=json, **kwargs)
+
+    def patch(
+        self,
+        url: str | bytes,
+        data: Any | None = None,
+        *,
+        json: Any | None = None,
+        **kwargs: Unpack[RESTKwargs],
+    ) -> ResponseContextManager | Response | LocustResponse:
+        """Sends a PATCH request"""
+        return self.request("PATCH", url, data=data, json=json, **kwargs)
+
+    def delete(
+        self,
+        url: str | bytes,
+        *,
+        data: Any | None = None,
+        json: Any | None = None,
+        **kwargs: Unpack[RESTKwargs],
+    ) -> ResponseContextManager | Response | LocustResponse:
+        """Sends a DELETE request"""
+        return self.request("DELETE", url, data=data, json=json, **kwargs)
+
 
 class ResponseContextManager(LocustResponse):
     """
@@ -211,7 +342,7 @@ class ResponseContextManager(LocustResponse):
         self._entered = True
         return self
 
-    def __exit__(self, exc, value, traceback):
+    def __exit__(self, exc, value, traceback):  # type: ignore[override]
         # if the user has already manually marked this response as failure or success
         # we can ignore the default behaviour of letting the response code determine the outcome
         if self._manual_result is not None:
@@ -311,17 +442,11 @@ class LocustHttpAdapter(HTTPAdapter):
 
 
 # Monkey patch Response class to give some guidance
-def _success(self):
-    raise LocustError(
-        "If you want to change the state of the request, you must pass catch_response=True. See http://docs.locust.io/en/stable/writing-a-locustfile.html#validating-responses"
-    )
-
-
-def _failure(self):
+def _missing_catch_response_True(self, *_args, **_kwargs):
     raise LocustError(
-        "If you want to change the state of the request, you must pass catch_response=True. See http://docs.locust.io/en/stable/writing-a-locustfile.html#validating-responses"
+        "If you want to change the state of the request using .success() or .failure(), you must pass catch_response=True. See http://docs.locust.io/en/stable/writing-a-locustfile.html#validating-responses"
     )
 
 
-Response.success = _success  # type: ignore[attr-defined]
-Response.failure = _failure  # type: ignore[attr-defined]
+Response.success = _missing_catch_response_True  # type: ignore[attr-defined]
+Response.failure = _missing_catch_response_True  # type: ignore[attr-defined]

locust/contrib/fasthttp.py

@@ -324,6 +324,12 @@ class FastHttpUser(User):
     Note that setting this value has no effect when custom client_pool was given, and you need to spawn a your own gevent pool
     to use it (as Users only have one greenlet). See test_fasthttp.py / test_client_pool_concurrency for an example."""
 
+    proxy_host: str | None = None
+    """Parameter passed to FastHttpSession"""
+
+    proxy_port: int | None = None
+    """Parameter passed to FastHttpSession"""
+
     client_pool: HTTPClientPool | None = None
     """HTTP client pool to use. If not given, a new pool is created per single user."""
 
@@ -355,6 +361,8 @@ class FastHttpUser(User):
             client_pool=self.client_pool,
             ssl_context_factory=self.ssl_context_factory,
             headers=self.default_headers,
+            proxy_host=self.proxy_host,
+            proxy_port=self.proxy_port,
         )
         """
         Instance of HttpSession that is created upon instantiation of User.

locust/event.py

@@ -61,7 +61,9 @@ class EventHook:
 
         Example usage (in a task):
 
-            with self.environment.events.request.measure("myrequestType", "myRequestName") as request_meta:
+        .. code-block:: python
+
+            with self.environment.events.request.measure("requestType", "requestName") 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.

locust/web.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import csv
 import json
 import logging
+import mimetypes
 import os.path
 from functools import wraps
 from html import escape
@@ -132,6 +133,8 @@ class WebUI:
         self.app.template_folder = BUILD_PATH
         self.app.static_folder = STATIC_PATH
         self.app.static_url_path = "/assets/"
+        # ensures static js files work on Windows
+        mimetypes.add_type("application/javascript", ".js")
 
         if self.web_login:
             self.login_manager = LoginManager()

{locust-2.29.0.dist-info → locust-2.29.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: locust
-Version: 2.29.0
+Version: 2.29.1
 Summary: Developer-friendly load testing framework
 License: MIT
 Project-URL: Homepage, https://github.com/locustio/locust
@@ -39,6 +39,7 @@ Requires-Dist: Flask-Login >=0.6.3
 Requires-Dist: Flask-Cors >=3.0.10
 Requires-Dist: pywin32 ; platform_system == "Windows"
 Requires-Dist: tomli >=1.1.0 ; python_version < "3.11"
+Requires-Dist: typing-extensions >=4.6.0 ; python_version < "3.11"
 Requires-Dist: requests >=2.32.2 ; python_version > "3.11"
 
 # Locust

{locust-2.29.0.dist-info → locust-2.29.1.dist-info}/RECORD

@@ -1,12 +1,12 @@
-locust/__init__.py,sha256=g6oA-Ba_hs3gLWVf5MKJ1mvfltI8MFnDWG8qslqm8yg,1402
+locust/__init__.py,sha256=Hmw2vNf75eLQ1mQIPXAwlQrJ_XFY65MOb92fGsNCukQ,1458
 locust/__main__.py,sha256=vBQ82334kX06ImDbFlPFgiBRiLIinwNk3z8Khs6hd74,31
-locust/_version.py,sha256=8ZmjIQNrNdWRKWrUxf63PB2QCkJdQ9_pn6E0P8ny8t4,413
+locust/_version.py,sha256=Htwgi4ogmtDOuhuq2HreknlH3a2T0FdWYBlGTUPcCwU,413
 locust/argument_parser.py,sha256=sjQoJ1NTac9LdNYT7zn8RajlWqBQs8YFNv6uRExb2gg,28941
-locust/clients.py,sha256=YKuAyMAbxs8_-w7XJw0hc67KFBNNLxibsw6FwiS01Q8,14781
+locust/clients.py,sha256=OHPv6hBAt4gt3HI67yqyT1qrSsF8uMdCwIRu0kIsRWI,19491
 locust/debug.py,sha256=We6Z9W0btkKSc7PxWmrZx-xMynvOOsKhG6jmDgQin0g,5134
 locust/dispatch.py,sha256=vYh0QEDFgJ3hY0HgSk-EiNO7IP9ffzXF_Et8wB9JvsI,16995
 locust/env.py,sha256=sP-fCnZs0e2xodRemLHgTgyyUt5eezwtdA9WsCoqJkQ,12767
-locust/event.py,sha256=m-egSPfOEd1Q6HEXx5lB0LlXOuEdzeS7B1XSFIDgRy0,7836
+locust/event.py,sha256=H2SuxyadPMsRY-LQ6MuK1okHls9lYsS9GgXIDSxpi50,7864
 locust/exception.py,sha256=jGgJ32ubuf4pWdlaVOkbh2Y0LlG0_DHi-lv3ib8ppOE,1791
 locust/html.py,sha256=_n3aB3fxiYzSeE_7RqHF3iiEPjPnbQ3e2Pw9P8AVtPU,3920
 locust/input_events.py,sha256=ZIyePyAMuA_YFYWg18g_pE4kwuQV3RbEB250MzXRwjY,3314
@@ -16,9 +16,9 @@ locust/py.typed,sha256=gkWLl8yD4mIZnNYYAIRM8g9VarLvWmTAFeUfEbxJLBw,65
 locust/runners.py,sha256=wqf9eIPUGrqz7m-EZtXKdMJ43cainHm0bS-3Cj4haBo,69471
 locust/shape.py,sha256=t-lwBS8LOjWcKXNL7j2U3zroIXJ1b0fazUwpRYQOKXw,1973
 locust/stats.py,sha256=5jx9aD9Sky-kCZ3E-MjRT3xbwvxo9xyDtfcfP56zclo,45875
-locust/web.py,sha256=Aqvcj0cHin6QtGn8jWZf_Spnpe9JUYxNr18ytofj1AU,27240
+locust/web.py,sha256=rN1NVeZ9LKSEeDwvpRbOJ0bcy8U1U4VjP-7vK7ejlwM,27367
 locust/contrib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-locust/contrib/fasthttp.py,sha256=vByPepw35DF84qZ2xK89yHgjOA_8btV0wig_rSR6p4g,26757
+locust/contrib/fasthttp.py,sha256=n6arQP1IH3CVP8PUaIhD-X5xWMAOj9F0JEJXPklun0Y,26999
 locust/rpc/__init__.py,sha256=nVGoHWFQxZjnhCDWjbgXIbmFbN9sizAjkhvSs9_642c,58
 locust/rpc/protocol.py,sha256=n-rb3GZQcAlldYDj4E4GuFGylYj_26GSS5U29meft5Y,1282
 locust/rpc/zmqrpc.py,sha256=AAY6w7wSFHsW34qqN28666boHFf6dTSAXPQJnAO6iUI,2707
@@ -71,9 +71,9 @@ locust/webui/dist/report.html,sha256=sOdZZVgZbqgu86BBCSQf3uQUYXgmgSnXF32JpnyAII8
 locust/webui/dist/assets/favicon.ico,sha256=IUl-rYqfpHdV38e-s0bkmFIeLS-n3Ug0DQxk-h202hI,8348
 locust/webui/dist/assets/index-84c63e70.js,sha256=cwyH4ju0OCRvFhg3O-0SYVBTFlN_XQeQ6YkymAO4Hco,1647185
 locust/webui/dist/assets/logo.png,sha256=EIVPqr6wE_yqguHaqFHIsH0ZACLSrvNWyYO7PbyIj4w,19299
-locust-2.29.0.dist-info/LICENSE,sha256=78XGpIn3fHVBfaxlPNUfjVufSN7QsdhpJMRJHv2AFpo,1095
-locust-2.29.0.dist-info/METADATA,sha256=CdhzgYoGdhtrQIKvda1oWmQHXrcNjYFsHPtv7XKvjBc,7317
-locust-2.29.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-locust-2.29.0.dist-info/entry_points.txt,sha256=RAdt8Ku-56m7bFjmdj-MBhbF6h4NX7tVODR9QNnOg0E,44
-locust-2.29.0.dist-info/top_level.txt,sha256=XSsjgPA8Ggf9TqKVbkwSqZFuPlZ085X13M9orDycE20,7
-locust-2.29.0.dist-info/RECORD,,
+locust-2.29.1.dist-info/LICENSE,sha256=78XGpIn3fHVBfaxlPNUfjVufSN7QsdhpJMRJHv2AFpo,1095
+locust-2.29.1.dist-info/METADATA,sha256=GfouDWwtoDhviRtO3pLKrdi2VYAcocS-ugctam4pmuY,7384
+locust-2.29.1.dist-info/WHEEL,sha256=mguMlWGMX-VHnMpKOjjQidIo1ssRlCFu4a4mBpz1s2M,91
+locust-2.29.1.dist-info/entry_points.txt,sha256=RAdt8Ku-56m7bFjmdj-MBhbF6h4NX7tVODR9QNnOg0E,44
+locust-2.29.1.dist-info/top_level.txt,sha256=XSsjgPA8Ggf9TqKVbkwSqZFuPlZ085X13M9orDycE20,7
+locust-2.29.1.dist-info/RECORD,,

{locust-2.29.0.dist-info → locust-2.29.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (70.1.1)
 Root-Is-Purelib: true
 Tag: py3-none-any