From: Tom Christie Date: Fri, 17 May 2019 12:06:26 +0000 (+0100) Subject: query_params -> params X-Git-Tag: 0.3.1~18^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c6287ed78241927264a5a0f0eedbf53637f22ba7;p=thirdparty%2Fhttpx.git query_params -> params --- diff --git a/README.md b/README.md index 74c21bf0..9f50f45e 100644 --- a/README.md +++ b/README.md @@ -98,14 +98,14 @@ inspiration around the lower level networking details. ``` * `def __init__([ssl], [timeout], [pool_limits], [max_redirects], [dispatch])` -* `def .request(method, url, [content], [query_params], [headers], [stream], [allow_redirects], [ssl], [timeout])` -* `def .get(url, [query_params], [headers], [stream], [allow_redirects], [ssl], [timeout])` -* `def .options(url, [query_params], [headers], [stream], [allow_redirects], [ssl], [timeout])` -* `def .head(url, [query_params], [headers], [stream], [allow_redirects], [ssl], [timeout])` -* `def .post(url, [content], [query_params], [headers], [stream], [allow_redirects], [ssl], [timeout])` -* `def .put(url, [content], [query_params], [headers], [stream], [allow_redirects], [ssl], [timeout])` -* `def .patch(url, [content], [query_params], [headers], [stream], [allow_redirects], [ssl], [timeout])` -* `def .delete(url, [content], [query_params], [headers], [stream], [allow_redirects], [ssl], [timeout])` +* `def .request(method, url, [content], [params], [headers], [stream], [allow_redirects], [ssl], [timeout])` +* `def .get(url, [params], [headers], [stream], [allow_redirects], [ssl], [timeout])` +* `def .options(url, [params], [headers], [stream], [allow_redirects], [ssl], [timeout])` +* `def .head(url, [params], [headers], [stream], [allow_redirects], [ssl], [timeout])` +* `def .post(url, [content], [params], [headers], [stream], [allow_redirects], [ssl], [timeout])` +* `def .put(url, [content], [params], [headers], [stream], [allow_redirects], [ssl], [timeout])` +* `def .patch(url, [content], [params], [headers], [stream], [allow_redirects], [ssl], [timeout])` +* `def .delete(url, [content], [params], [headers], [stream], [allow_redirects], [ssl], [timeout])` * `def .prepare_request(request)` * `def .send(request, [stream], [allow_redirects], [ssl], [timeout])` * `def .close()` @@ -145,7 +145,7 @@ what gets sent over the wire.* >>> response = client.send(request) ``` -* `def __init__(method, url, query_params, content, headers)` +* `def __init__(method, url, params, content, headers)` * `.method` - **str** (Uppercased) * `.url` - **URL** * `.content` - **byte** or **byte async iterator** @@ -161,7 +161,7 @@ what gets sent over the wire.* 'example.org' ``` -* `def __init__(url, allow_relative=False, query_params=None)` +* `def __init__(url, allow_relative=False, params=None)` * `.scheme` - **str** * `.authority` - **str** * `.host` - **str** diff --git a/httpcore/client.py b/httpcore/client.py index 3da58e6f..e2a272e0 100644 --- a/httpcore/client.py +++ b/httpcore/client.py @@ -58,7 +58,7 @@ class AsyncClient: self, url: URLTypes, *, - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -70,7 +70,7 @@ class AsyncClient: return await self.request( "GET", url, - query_params=query_params, + params=params, headers=headers, cookies=cookies, stream=stream, @@ -84,7 +84,7 @@ class AsyncClient: self, url: URLTypes, *, - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -96,7 +96,7 @@ class AsyncClient: return await self.request( "OPTIONS", url, - query_params=query_params, + params=params, headers=headers, cookies=cookies, stream=stream, @@ -110,7 +110,7 @@ class AsyncClient: self, url: URLTypes, *, - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -122,7 +122,7 @@ class AsyncClient: return await self.request( "HEAD", url, - query_params=query_params, + params=params, headers=headers, cookies=cookies, stream=stream, @@ -137,7 +137,7 @@ class AsyncClient: url: URLTypes, *, data: RequestData = b"", - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -150,7 +150,7 @@ class AsyncClient: "POST", url, data=data, - query_params=query_params, + params=params, headers=headers, cookies=cookies, stream=stream, @@ -165,7 +165,7 @@ class AsyncClient: url: URLTypes, *, data: RequestData = b"", - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -178,7 +178,7 @@ class AsyncClient: "PUT", url, data=data, - query_params=query_params, + params=params, headers=headers, cookies=cookies, stream=stream, @@ -193,7 +193,7 @@ class AsyncClient: url: URLTypes, *, data: RequestData = b"", - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -206,7 +206,7 @@ class AsyncClient: "PATCH", url, data=data, - query_params=query_params, + params=params, headers=headers, cookies=cookies, stream=stream, @@ -221,7 +221,7 @@ class AsyncClient: url: URLTypes, *, data: RequestData = b"", - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -234,7 +234,7 @@ class AsyncClient: "DELETE", url, data=data, - query_params=query_params, + params=params, headers=headers, cookies=cookies, stream=stream, @@ -250,7 +250,7 @@ class AsyncClient: url: URLTypes, *, data: RequestData = b"", - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -263,7 +263,7 @@ class AsyncClient: method, url, data=data, - query_params=query_params, + params=params, headers=headers, cookies=self.merge_cookies(cookies), ) @@ -281,7 +281,9 @@ class AsyncClient: def prepare_request(self, request: Request) -> None: request.prepare() - def merge_cookies(self, cookies: CookieTypes = None) -> typing.Optional[CookieTypes]: + def merge_cookies( + self, cookies: CookieTypes = None + ) -> typing.Optional[CookieTypes]: if cookies or self.cookies: merged_cookies = Cookies(self.cookies) merged_cookies.update(cookies) @@ -377,7 +379,9 @@ class AsyncClient: headers = self.redirect_headers(request, url) content = self.redirect_content(request, method) cookies = self.merge_cookies(request.cookies) - return Request(method=method, url=url, headers=headers, data=content, cookies=cookies) + return Request( + method=method, url=url, headers=headers, data=content, cookies=cookies + ) def redirect_method(self, request: Request, response: Response) -> str: """ @@ -488,7 +492,7 @@ class Client: url: URLTypes, *, data: RequestData = b"", - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -501,7 +505,7 @@ class Client: method, url, data=data, - query_params=query_params, + params=params, headers=headers, cookies=self._client.merge_cookies(cookies), ) @@ -520,7 +524,7 @@ class Client: self, url: URLTypes, *, - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -545,7 +549,7 @@ class Client: self, url: URLTypes, *, - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -570,7 +574,7 @@ class Client: self, url: URLTypes, *, - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -596,7 +600,7 @@ class Client: url: URLTypes, *, data: RequestData = b"", - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -623,7 +627,7 @@ class Client: url: URLTypes, *, data: RequestData = b"", - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -650,7 +654,7 @@ class Client: url: URLTypes, *, data: RequestData = b"", - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, @@ -677,7 +681,7 @@ class Client: url: URLTypes, *, data: RequestData = b"", - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, stream: bool = False, diff --git a/httpcore/interfaces.py b/httpcore/interfaces.py index 6baf941f..20b17239 100644 --- a/httpcore/interfaces.py +++ b/httpcore/interfaces.py @@ -38,15 +38,13 @@ class Dispatcher: url: URLTypes, *, data: RequestData = b"", - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, stream: bool = False, ssl: SSLConfig = None, timeout: TimeoutConfig = None ) -> Response: - request = Request( - method, url, data=data, query_params=query_params, headers=headers - ) + request = Request(method, url, data=data, params=params, headers=headers) self.prepare_request(request) response = await self.send(request, stream=stream, ssl=ssl, timeout=timeout) return response diff --git a/httpcore/models.py b/httpcore/models.py index d5b8e7f2..c98eea87 100644 --- a/httpcore/models.py +++ b/httpcore/models.py @@ -65,7 +65,7 @@ class URL: self, url: URLTypes, allow_relative: bool = False, - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, ) -> None: if isinstance(url, rfc3986.uri.URIReference): self.components = url @@ -84,8 +84,8 @@ class URL: self.components = self.components.normalize() # Add any query parameters. - if query_params: - query_string = str(QueryParams(query_params)) + if params: + query_string = str(QueryParams(params)) self.components = self.components.copy_with(query=query_string) # Enforce absolute URLs by default. @@ -480,12 +480,12 @@ class Request: url: typing.Union[str, URL], *, data: RequestData = b"", - query_params: QueryParamTypes = None, + params: QueryParamTypes = None, headers: HeaderTypes = None, cookies: CookieTypes = None, ): self.method = method.upper() - self.url = URL(url, query_params=query_params) + self.url = URL(url, params=params) self.headers = Headers(headers) if cookies: self._cookies = Cookies(cookies) @@ -981,7 +981,7 @@ class Cookies(MutableMapping): args.append(path) self.jar.clear(*args) - def update(self, cookies: CookieTypes) -> None: # type: ignore + def update(self, cookies: CookieTypes = None) -> None: # type: ignore cookies = Cookies(cookies) for cookie in cookies.jar: self.jar.set_cookie(cookie) diff --git a/tests/models/test_url.py b/tests/models/test_url.py index 98e01d9d..d185d0dd 100644 --- a/tests/models/test_url.py +++ b/tests/models/test_url.py @@ -25,12 +25,12 @@ def test_url(): assert new.scheme == "http" -def test_url_query_params(): - url = URL("https://example.org:123/path/to/somewhere", query_params={"a": "123"}) +def test_url__params(): + url = URL("https://example.org:123/path/to/somewhere", params={"a": "123"}) assert str(url) == "https://example.org:123/path/to/somewhere?a=123" url = URL( - "https://example.org:123/path/to/somewhere?b=456", query_params={"a": "123"} + "https://example.org:123/path/to/somewhere?b=456", params={"a": "123"} ) assert str(url) == "https://example.org:123/path/to/somewhere?a=123"