locust 2.40.1.dev3__tar.gz → 2.40.2.dev5__tar.gz

{locust-2.40.1.dev3 → locust-2.40.2.dev5}/PKG-INFO

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

{locust-2.40.1.dev3 → locust-2.40.2.dev5}/locust/_version.py

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

{locust-2.40.1.dev3 → locust-2.40.2.dev5}/locust/clients.py

@@ -1,9 +1,11 @@
 from __future__ import annotations
 
+from locust.event import EventHook
+
 import re
 import time
 from contextlib import contextmanager
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, cast
 from urllib.parse import urlparse, urlunparse
 
 import requests
@@ -53,15 +55,6 @@ if TYPE_CHECKING:
 absolute_http_url_regexp = re.compile(r"^https?://", re.I)
 
 
-class LocustResponse(Response):
-    error: Exception | None = None
-
-    def raise_for_status(self) -> None:
-        if self.error:
-            raise self.error
-        Response.raise_for_status(self)
-
-
 class HttpSession(requests.Session):
     """
     Class for performing web requests and holding (session-) cookies between requests (in order
@@ -142,7 +135,7 @@ class HttpSession(requests.Session):
         data: Any = None,
         json: Any = None,
         **kwargs: Unpack[RequestKwargs],
-    ):
+    ) -> ResponseContextManager:
         """
         Constructs and sends a :py:class:`requests.Request`.
         Returns :py:class:`requests.Response` object.
@@ -222,14 +215,14 @@ class HttpSession(requests.Session):
         else:
             request_meta["response_length"] = len(response.content or b"")
 
-        if catch_response:
-            return ResponseContextManager(response, request_event=self.request_event, request_meta=request_meta)
-        else:
-            with ResponseContextManager(response, request_event=self.request_event, request_meta=request_meta):
-                pass
-            return response
+        rcm = ResponseContextManager.wrap_response(
+            response, request_event=self.request_event, request_meta=request_meta, catch_response=catch_response
+        )
+        if not catch_response:  # if not using with-block, report the request immediately
+            rcm.__exit__(None, None, None)
+        return rcm
 
-    def _send_request_safe_mode(self, method, url, **kwargs) -> Response | LocustResponse:
+    def _send_request_safe_mode(self, method, url, **kwargs) -> Response:
         """
         Send an HTTP request, and catch any exception that might occur due to connection problems.
 
@@ -240,15 +233,11 @@ class HttpSession(requests.Session):
         except (MissingSchema, InvalidSchema, InvalidURL):
             raise
         except RequestException as e:
-            r = LocustResponse()
-            r.error = e
-            r.status_code = 0
-            r.request = e.request  # type: ignore
-            return r
+            return ResponseContextManager(e)
 
     def get(
         self, url: str | bytes, *, data: Any = None, json: Any = None, **kwargs: Unpack[RESTKwargs]
-    ) -> ResponseContextManager | Response | LocustResponse:
+    ) -> ResponseContextManager:
         """Sends a GET request"""
         kwargs.setdefault("allow_redirects", True)
         return self.request("GET", url, data=data, json=json, **kwargs)
@@ -260,7 +249,7 @@ class HttpSession(requests.Session):
         data: Any = None,
         json: Any = None,
         **kwargs: Unpack[RESTKwargs],
-    ) -> ResponseContextManager | Response | LocustResponse:
+    ) -> ResponseContextManager:
         """Sends a OPTIONS request"""
         kwargs.setdefault("allow_redirects", True)
         return self.request("OPTIONS", url, data=data, json=json, **kwargs)
@@ -272,7 +261,7 @@ class HttpSession(requests.Session):
         data: Any = None,
         json: Any = None,
         **kwargs: Unpack[RESTKwargs],
-    ) -> ResponseContextManager | Response | LocustResponse:
+    ) -> ResponseContextManager:
         """Sends a HEAD request"""
         kwargs.setdefault("allow_redirects", False)
         return self.request("HEAD", url, data=data, json=json, **kwargs)
@@ -283,7 +272,7 @@ class HttpSession(requests.Session):
         data: Any = None,
         json: Any = None,
         **kwargs: Unpack[RESTKwargs],
-    ) -> ResponseContextManager | Response | LocustResponse:
+    ) -> ResponseContextManager:
         """Sends a POST request"""
         return self.request("POST", url, data=data, json=json, **kwargs)
 
@@ -294,7 +283,7 @@ class HttpSession(requests.Session):
         *,
         json: Any = None,
         **kwargs: Unpack[RESTKwargs],
-    ) -> ResponseContextManager | Response | LocustResponse:
+    ) -> ResponseContextManager:
         """Sends a PUT request"""
         return self.request("PUT", url, data=data, json=json, **kwargs)
 
@@ -305,7 +294,7 @@ class HttpSession(requests.Session):
         *,
         json: Any = None,
         **kwargs: Unpack[RESTKwargs],
-    ) -> ResponseContextManager | Response | LocustResponse:
+    ) -> ResponseContextManager:
         """Sends a PATCH request"""
         return self.request("PATCH", url, data=data, json=json, **kwargs)
 
@@ -316,12 +305,12 @@ class HttpSession(requests.Session):
         data: Any = None,
         json: Any = None,
         **kwargs: Unpack[RESTKwargs],
-    ) -> ResponseContextManager | Response | LocustResponse:
+    ) -> ResponseContextManager:
         """Sends a DELETE request"""
         return self.request("DELETE", url, data=data, json=json, **kwargs)
 
 
-class ResponseContextManager(LocustResponse):
+class ResponseContextManager(Response):
     """
     A Response class that also acts as a context manager that provides the ability to manually
     control if an HTTP request should be marked as successful or a failure in Locust's statistics
@@ -331,17 +320,46 @@ class ResponseContextManager(LocustResponse):
     :py:meth:`failure <locust.clients.ResponseContextManager.failure>`.
     """
 
-    _manual_result: bool | Exception | None = None
-    _entered = False
+    error: Exception | None = None
+    _manual_result: bool | Exception | None
+    _entered: bool
+    _request_event: EventHook
+    request_meta: Mapping[str, Any]
+    _catch_response: bool
 
-    def __init__(self, response, request_event, request_meta):
-        # copy data from response to this object
-        self.__dict__ = response.__dict__
-        self._request_event = request_event
-        self.request_meta = request_meta
+    def raise_for_status(self) -> None:
+        if self.error:
+            raise self.error
+        Response.raise_for_status(self)
+
+    def __init__(self, error: RequestException):
+        """
+        Direct instantiation is only used for errors caught when trying to send the request
+        Normally instances of this class are created from using wrap_response() on a Response object
+        """
+        super().__init__()
+        self.error = error
+        self.status_code = 0
+        self.request = error.request  # type: ignore
+
+    @classmethod
+    def wrap_response(
+        cls, response: Response, request_event: EventHook, request_meta: Mapping[str, Any], catch_response: bool
+    ) -> ResponseContextManager:
+        """Modify a Response object in-place, for efficiency reasons"""
+        response.__class__ = ResponseContextManager
+        response = cast(ResponseContextManager, response)
+        response._entered = False
+        response._manual_result = None
+        response._request_event = request_event
+        response._catch_response = catch_response
+        response.request_meta = request_meta
+        return response
 
     def __enter__(self):
         self._entered = True
+        if not self._catch_response:
+            raise LocustError("In order to use a with-block for requests, you must also pass catch_response=True")
         return self
 
     def __exit__(self, exc, value, traceback):  # type: ignore[override]

{locust-2.40.1.dev3 → locust-2.40.2.dev5}/pyproject.toml

@@ -120,12 +120,12 @@ source = "vcs"
 version-file = "locust/_version.py"
 
 [tool.hatch.build.targets.sdist]
-include = ["locust"]
+include = ["locust", "pytest_locust"]
 exclude = ["locust/webui/*", "locust/test", "locust/build"]
 artifacts = ["locust/webui/dist"]
 
 [tool.hatch.build.targets.wheel]
-include = ["locust"]
+include = ["locust", "pytest_locust"]
 artifacts = ["locust/webui/dist"]
 
 [tool.hatch.version.raw-options]
@@ -265,4 +265,4 @@ python = ["3.12"]
 build = ["sphinx-build -b html docs/ docs/_build/"]
 
 [project.entry-points.pytest11]
-locust = "locust.pytestplugin"
+locust = "pytest_locust.plugin"

locust-2.40.1.dev3/locust/pytestplugin.py → locust-2.40.2.dev5/pytest_locust/plugin.py

@@ -1,4 +1,4 @@
-# This is used in pytest-based, see examples/test_pytest.py
+# This is used in pytest style locustfiles, see examples/test_pytest.py
 from typing import TYPE_CHECKING
 
 import pytest