From: Kian Meng, Ang Date: Tue, 14 Dec 2021 14:04:01 +0000 (+0800) Subject: Fix typos (#1968) X-Git-Tag: 0.21.2~8 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=82ba15b52189eacec74f2ec7dbd81f3c70a69261;p=thirdparty%2Fhttpx.git Fix typos (#1968) --- diff --git a/CHANGELOG.md b/CHANGELOG.md index 045da01c..614f0992 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -92,7 +92,7 @@ finally: ### Fixed * `response.iter_bytes()` no longer raises a ValueError when called on a response with no content. (Pull #1827) -* The `'wsgi.error'` configuration now defaults to `sys.stderr`, and is corrected to be a `TextIO` interface, not a `BytesIO` interface. Additionally, the WSGITransport now accepts a `wsgi_error` confguration. (Pull #1828) +* The `'wsgi.error'` configuration now defaults to `sys.stderr`, and is corrected to be a `TextIO` interface, not a `BytesIO` interface. Additionally, the WSGITransport now accepts a `wsgi_error` configuration. (Pull #1828) * Follow the WSGI spec by properly closing the iterable returned by the application. (Pull #1830) ## 0.19.0 (19th August, 2021) @@ -347,7 +347,7 @@ The following API changes have been issuing deprecation warnings since 0.17.0 on The 0.14 release includes a range of improvements to the public API, intended on preparing for our upcoming 1.0 release. -* Our HTTP/2 support is now fully optional. **You now need to use `pip install httpx[http2]` if you want to include the HTTP/2 dependancies.** +* Our HTTP/2 support is now fully optional. **You now need to use `pip install httpx[http2]` if you want to include the HTTP/2 dependencies.** * Our HSTS support has now been removed. Rewriting URLs from `http` to `https` if the host is on the HSTS list can be beneficial in avoiding roundtrips to incorrectly formed URLs, but on balance we've decided to remove this feature, on the principle of least surprise. Most programmatic clients do not include HSTS support, and for now we're opting to remove our support for it. * Our exception hierarchy has been overhauled. Most users will want to stick with their existing `httpx.HTTPError` usage, but we've got a clearer overall structure now. See https://www.python-httpx.org/exceptions/ for more details. @@ -720,7 +720,7 @@ importing modules within the package. - The SSL configuration settings of `verify`, `cert`, and `trust_env` now raise warnings if used per-request when using a Client instance. They should always be set on the Client instance itself. (Pull #597) - Use plain strings "TUNNEL_ONLY" or "FORWARD_ONLY" on the HTTPProxy `proxy_mode` argument. The `HTTPProxyMode` enum still exists, but its usage will raise warnings. (#610) - Pool timeouts are now on the timeout configuration, not the pool limits configuration. (Pull #563) -- The timeout configuration is now named `httpx.Timeout(...)`, not `httpx.TimeoutConfig(...)`. The old version currently remains as a synonym for backwards compatability. (Pull #591) +- The timeout configuration is now named `httpx.Timeout(...)`, not `httpx.TimeoutConfig(...)`. The old version currently remains as a synonym for backwards compatibility. (Pull #591) --- @@ -849,7 +849,7 @@ importing modules within the package. - Switch IDNA encoding from IDNA 2003 to IDNA 2008. (Pull #161) - Expose base classes for alternate concurrency backends. (Pull #178) - Improve Multipart parameter encoding. (Pull #167) -- Add the `headers` proeprty to `BaseClient`. (Pull #159) +- Add the `headers` property to `BaseClient`. (Pull #159) - Add support for Google's `brotli` library. (Pull #156) - Remove deprecated TLS versions (TLSv1 and TLSv1.1) from default `SSLConfig`. (Pull #155) - Fix `URL.join(...)` to work similarly to RFC 3986 URL joining. (Pull #144) diff --git a/docs/advanced.md b/docs/advanced.md index 54be4ae0..ad4b6f17 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -26,7 +26,7 @@ This can bring **significant performance improvements** compared to using the to `Client` instances also support features that aren't available at the top-level API, such as: -- Cookie persistance across requests. +- Cookie persistence across requests. - Applying configuration across all outgoing requests. - Sending requests through HTTP proxies. - Using [HTTP/2](http2.md). diff --git a/docs/compatibility.md b/docs/compatibility.md index 5ffa3257..2a9cbd85 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -16,7 +16,7 @@ You can still enable behaviour to automatically follow redirects, but you need t do so explicitly... ```python -respose = client.get(url, follow_redirects=True) +response = client.get(url, follow_redirects=True) ``` Or else instantiate a client, with redirect following enabled by default... @@ -97,7 +97,7 @@ opened in text mode. ## Content encoding -HTTPX uses `utf-8` for encoding `str` request bodies. For example, when using `content=` the request body will be encoded to `utf-8` before being sent over the wire. This differs from Requests which uses `latin1`. If you need an explicit encoding, pass encoded bytes explictly, e.g. `content=.encode("latin1")`. +HTTPX uses `utf-8` for encoding `str` request bodies. For example, when using `content=` the request body will be encoded to `utf-8` before being sent over the wire. This differs from Requests which uses `latin1`. If you need an explicit encoding, pass encoded bytes explicitly, e.g. `content=.encode("latin1")`. For response bodies, assuming the server didn't send an explicit encoding then HTTPX will do its best to figure out an appropriate encoding. HTTPX makes a guess at the encoding to use for decoding the response using `charset_normalizer`. Fallback to that or any content with less than 32 octets will be decoded using `utf-8` with the `error="replace"` decoder strategy. ## Cookies diff --git a/httpx/_client.py b/httpx/_client.py index 5bfa4c6c..56215203 100644 --- a/httpx/_client.py +++ b/httpx/_client.py @@ -1275,7 +1275,7 @@ class Client(BaseClient): def __del__(self) -> None: # We use 'getattr' here, to manage the case where '__del__()' is called - # on a partically initiallized instance that raised an exception during + # on a partially initiallized instance that raised an exception during # the call to '__init__()'. if getattr(self, "_state", None) == ClientState.OPENED: # noqa: B009 self.close() @@ -1986,7 +1986,7 @@ class AsyncClient(BaseClient): def __del__(self) -> None: # We use 'getattr' here, to manage the case where '__del__()' is called - # on a partically initiallized instance that raised an exception during + # on a partially initiallized instance that raised an exception during # the call to '__init__()'. if getattr(self, "_state", None) == ClientState.OPENED: # noqa: B009 # Unlike the sync case, we cannot silently close the client when diff --git a/httpx/_content.py b/httpx/_content.py index 9032c1c0..f210c4a8 100644 --- a/httpx/_content.py +++ b/httpx/_content.py @@ -188,7 +188,7 @@ def encode_request( returning a two-tuple of (, ). """ if data is not None and not isinstance(data, dict): - # We prefer to seperate `content=` + # We prefer to separate `content=` # for raw request content, and `data=
` for url encoded or # multipart form content. # diff --git a/httpx/_models.py b/httpx/_models.py index f84bb7d8..f6cd6db9 100644 --- a/httpx/_models.py +++ b/httpx/_models.py @@ -327,7 +327,7 @@ class URL: """ The URL query string, as raw bytes, excluding the leading b"?". - This is neccessarily a bytewise interface, because we cannot + This is necessarily a bytewise interface, because we cannot perform URL decoding of this representation until we've parsed the keys and values into a QueryParams instance. @@ -465,7 +465,7 @@ class URL: port = kwargs.pop("port", self.port) if host and ":" in host and host[0] != "[": - # IPv6 addresses need to be escaped within sqaure brackets. + # IPv6 addresses need to be escaped within square brackets. host = f"[{host}]" kwargs["netloc"] = ( @@ -907,7 +907,7 @@ class Headers(typing.MutableMapping[str, str]): def items(self) -> typing.ItemsView[str, str]: """ Return `(key, value)` items of headers. Concatenate headers - into a single comma seperated value when a key occurs multiple times. + into a single comma separated value when a key occurs multiple times. """ values_dict: typing.Dict[str, str] = {} for _, key, value in self._list: @@ -922,8 +922,8 @@ class Headers(typing.MutableMapping[str, str]): def multi_items(self) -> typing.List[typing.Tuple[str, str]]: """ Return a list of `(key, value)` pairs of headers. Allow multiple - occurences of the same key without concatenating into a single - comma seperated value. + occurrences of the same key without concatenating into a single + comma separated value. """ return [ (key.decode(self.encoding), value.decode(self.encoding)) @@ -932,7 +932,7 @@ class Headers(typing.MutableMapping[str, str]): def get(self, key: str, default: typing.Any = None) -> typing.Any: """ - Return a header value. If multiple occurences of the header occur + Return a header value. If multiple occurrences of the header occur then concatenate them together with commas. """ try: @@ -943,7 +943,7 @@ class Headers(typing.MutableMapping[str, str]): def get_list(self, key: str, split_commas: bool = False) -> typing.List[str]: """ Return a list of all header values for a given key. - If `split_commas=True` is passed, then any comma seperated header + If `split_commas=True` is passed, then any comma separated header values are split into multiple return strings. """ get_header_key = key.lower().encode(self.encoding) @@ -1365,7 +1365,7 @@ class Response: @property def apparent_encoding(self) -> typing.Optional[str]: """ - Return the encoding, as detemined by `charset_normalizer`. + Return the encoding, as determined by `charset_normalizer`. """ content = getattr(self, "_content", b"") if len(content) < 32: diff --git a/httpx/_transports/base.py b/httpx/_transports/base.py index 8c324ab4..ed3502e9 100644 --- a/httpx/_transports/base.py +++ b/httpx/_transports/base.py @@ -25,7 +25,7 @@ class BaseTransport: At this layer of API we're simply using plain primitives. No `Request` or `Response` models, no fancy `URL` or `Header` handling. This strict point - of cut-off provides a clear design seperation between the HTTPX API, + of cut-off provides a clear design separation between the HTTPX API, and the low-level network handling. Developers shouldn't typically ever need to call into this API directly, diff --git a/httpx/_transports/default.py b/httpx/_transports/default.py index 4b400d8d..c8525adc 100644 --- a/httpx/_transports/default.py +++ b/httpx/_transports/default.py @@ -9,7 +9,7 @@ The following additional keyword arguments are currently supported by httpcore.. Example usages... -# Disable HTTP/2 on a single specfic domain. +# Disable HTTP/2 on a single specific domain. mounts = { "all://": httpx.HTTPTransport(http2=True), "all://*example.org": httpx.HTTPTransport() diff --git a/httpx/_types.py b/httpx/_types.py index 2b08df75..8cd85cd9 100644 --- a/httpx/_types.py +++ b/httpx/_types.py @@ -119,7 +119,7 @@ class SyncByteStream: def read(self) -> bytes: """ - Simple cases can use `.read()` as a convience method for consuming + Simple cases can use `.read()` as a convenience method for consuming the entire stream and then closing it. Example: diff --git a/httpx/_utils.py b/httpx/_utils.py index c47389f9..c92be8c8 100644 --- a/httpx/_utils.py +++ b/httpx/_utils.py @@ -305,7 +305,7 @@ def get_environment_proxies() -> typing.Dict[str, typing.Optional[str]]: # on how names in `NO_PROXY` are handled. if hostname == "*": # If NO_PROXY=* is used or if "*" occurs as any one of the comma - # seperated hostnames, then we should just bypass any information + # separated hostnames, then we should just bypass any information # from HTTP_PROXY, HTTPS_PROXY, ALL_PROXY, and always ignore # proxies. return {} diff --git a/tests/client/test_proxies.py b/tests/client/test_proxies.py index 893e35cf..2d9c1588 100644 --- a/tests/client/test_proxies.py +++ b/tests/client/test_proxies.py @@ -225,7 +225,7 @@ def test_unsupported_proxy_scheme(): {"ALL_PROXY": "http://localhost:123", "NO_PROXY": ".example1.com"}, None, ), - # Proxied, because NO_PROXY subdomains only match if "." seperated. + # Proxied, because NO_PROXY subdomains only match if "." separated. ( "https://www.example2.com", {"ALL_PROXY": "http://localhost:123", "NO_PROXY": "ample2.com"}, diff --git a/tests/test_utils.py b/tests/test_utils.py index cf69f957..88ef5877 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -71,7 +71,7 @@ def test_get_netrc_login(): def test_get_netrc_unknown(): netrc_info = NetRCInfo([str(FIXTURES_DIR / ".netrc")]) - assert netrc_info.get_credentials("nonexistant.org") is None + assert netrc_info.get_credentials("nonexistent.org") is None @pytest.mark.parametrize(