Scrapy, a fast high-level web crawling & scraping framework for Python.
Add Request.to_curl() (#7743) (#7802)
Youssef Mohamedbc5b5fb1f6d8
diff --git a/docs/topics/request-response.rst b/docs/topics/request-response.rstindex b83a04032..8e565907f 100644--- a/docs/topics/request-response.rst+++ b/docs/topics/request-response.rst@@ -260,6 +260,8 @@ Request objects.. automethod:: from_curl+ .. automethod:: to_curl+.. automethod:: to_dictdiff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.pyindex 57517a65b..68847283a 100644--- a/scrapy/http/request/__init__.py+++ b/scrapy/http/request/__init__.py@@ -387,6 +387,20 @@ class Request(object_ref):request_kwargs.update(kwargs)return cls(**request_kwargs)+ def to_curl(self) -> str:+ """Return a string with a `cURL <https://curl.se/>`_ command equivalent+ to this request.++ Inverse of :meth:`from_curl`. See also+ :func:`scrapy.utils.request.request_to_curl`.++ .. versionadded:: VERSION+ """+ # Imported here to avoid a circular import.+ from scrapy.utils.request import request_to_curl # noqa: PLC0415++ return request_to_curl(self)+def to_dict(self, *, spider: scrapy.Spider | None = None) -> dict[str, Any]:"""Return a dictionary containing the Request's data.diff --git a/tests/test_utils_request.py b/tests/test_utils_request.pyindex eb95be06c..935447bc4 100644--- a/tests/test_utils_request.py+++ b/tests/test_utils_request.py@@ -475,3 +475,14 @@ class TestRequestToCurl:" --data-raw '{\"foo\": \"bar\"}' --cookie 'foo=1'")self._test_request(request_object, expected_curl_command)++ def test_request_to_curl_method(self) -> None:+ request_object = Request(+ "https://www.httpbin.org/post",+ method="POST",+ body=json.dumps({"foo": "bar"}),+ )+ expected_curl_command = (+ 'curl -X POST https://www.httpbin.org/post --data-raw \'{"foo": "bar"}\''+ )+ assert request_object.to_curl() == expected_curl_commanddiff --git a/tests/utils/bases/http_request.py b/tests/utils/bases/http_request.pyindex c255b5e4c..3a1e588ef 100644--- a/tests/utils/bases/http_request.py+++ b/tests/utils/bases/http_request.py@@ -6,6 +6,7 @@ import pytestfrom scrapy.http import Headers, Requestfrom scrapy.http.request import NO_CALLBACK+from scrapy.utils.request import request_to_curlclass TestRequestBase(ABC):@@ -488,3 +489,11 @@ class TestRequestBase(ABC):'curl -X PATCH "http://example.org" --foo -z',ignore_unknown_options=False,)++ def test_to_curl(self):+ # Note: more curated tests regarding curl conversion are in+ # `test_utils_request.py`+ r = self.request_class(+ "http://www.example.com/", method="POST", body=b"foo=bar"+ )+ assert r.to_curl() == request_to_curl(r)