fix: typo in core/azure-core (#26124)

KdHyeon0661 · web-flow · commit 38046f50ba43 · 2022-09-09T10:22:36.000-07:00
diff --git a/.vscode/cspell.json b/.vscode/cspell.json
@@ -55,7 +55,6 @@
     "sdk/core/azure/**",
     "sdk/core/azure-common/**",
     "sdk/core/azure-core-tracing-opentelemetry/**",
-    "sdk/core/azure-core/**",
     "sdk/core/azure-servicemanagement-legacy/**",
     "sdk/deviceupdate/azure-iot-deviceupdate/**",
     "sdk/digitaltwins/azure-digitaltwins-core/**",
@@ -120,6 +119,8 @@
     "amqps",
     "apim",
     "Asal",
+    "astimezone",
+    "AsyncIterable",
     "asyncio",
     "avroencoder",
     "azcmagent",
@@ -133,6 +134,7 @@
     "cdll",
     "certprg",
     "certver",
+    "cchardet",
     "clientid",
     "cname",
     "conda",
@@ -778,6 +780,47 @@
         "Shenzen",
         "myusername"
       ]
+    },
+    {
+      "filename": "sdk/core/azure-core/**",
+      "words": [
+        "odatav",
+        "unpicklable",
+        "reinvesitgate",
+        "sansio",
+        "ctxt",
+        "azcore",
+        "cafile",
+        "wbits",
+        "ctype",
+        "hdrs",
+        "rdap",
+        "chardet",
+        "redef",
+        "cvar",
+        "ryohji",
+        "jiasli",
+        "vbarbaresi",
+        "undoc",
+        "myuseragent",
+        "azconfig",
+        "killpg",
+        "getpgid",
+        "Chocolat",
+        "myusergant",
+        "nocover",
+        "Patiño",
+        "oooooold",
+        "mytools",
+        "myattr",
+        "myvalue",
+        "Oopsy",
+        "datav",
+        "mybytes",
+        "myid",
+        "jsonify",
+        "ints"
+      ]
     }
   ],
   "allowCompoundWords": true
diff --git a/sdk/core/azure-core/CHANGELOG.md b/sdk/core/azure-core/CHANGELOG.md
@@ -470,7 +470,7 @@ set the http logging policy of the config  #12218
 - Tracing: `azure.core.tracing.context.tracing_context.with_current_context` renamed to `azure.core.tracing.common.with_current_context`  #7252
 - Tracing: `link` renamed `link_from_headers`  and `link` takes now a string
 - Tracing: opencensus implementation has been moved to the package `azure-core-tracing-opencensus`
-- Some modules and classes that were importables from several differente places have been removed:
+- Some modules and classes that were importables from several different places have been removed:
 
    - `azure.core.HttpResponseError` is now only `azure.core.exceptions.HttpResponseError`
    - `azure.core.Configuration` is now only `azure.core.configuration.Configuration`
diff --git a/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md b/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md
@@ -566,7 +566,7 @@ implementation should mention that this keyword argument will not be used when m
 potential consequences of this. For example, if a `TokenCredential` implementation doesn't use `tenant_id`, it should
 document that fetched tokens may not authorize requests made to the specified tenant.
 
-There is also an async protocol -- the `AsyncTokenCredential` protocol -- that specifies a class with an aysnc
+There is also an async protocol -- the `AsyncTokenCredential` protocol -- that specifies a class with an async
 `get_token` method with the same arguments. An `AsyncTokenCredential` implementation additionally needs to be a context
 manager, with `__aenter__`, `__aexit__`, and `close` methods.
 
diff --git a/sdk/core/azure-core/azure/core/async_paging.py b/sdk/core/azure-core/azure/core/async_paging.py
@@ -52,7 +52,7 @@ class AsyncList(AsyncIterator[ReturnType]):
     def __init__(self, iterable: Iterable[ReturnType]) -> None:
         """Change an iterable into a fake async iterator.
 
-        Coul be useful to fill the async iterator contract when you get a list.
+        Could be useful to fill the async iterator contract when you get a list.
 
         :param iterable: A sync iterable of T
         """
diff --git a/sdk/core/azure-core/azure/core/pipeline/policies/_retry.py b/sdk/core/azure-core/azure/core/pipeline/policies/_retry.py
@@ -358,7 +358,7 @@ class RetryPolicy(RetryPolicyBase, HTTPPolicy):
 
     :keyword float retry_backoff_factor: A backoff factor to apply between attempts after the second try
      (most errors are resolved immediately by a second try without a delay).
-     In fixed mode, retry policy will alwasy sleep for {backoff factor}.
+     In fixed mode, retry policy will always sleep for {backoff factor}.
      In 'exponential' mode, retry policy will sleep for: `{backoff factor} * (2 ** ({number of total retries} - 1))`
      seconds. If the backoff_factor is 0.1, then the retry will sleep
      for [0.0s, 0.2s, 0.4s, ...] between retries. The default value is 0.8.
diff --git a/sdk/core/azure-core/azure/core/pipeline/transport/_aiohttp.py b/sdk/core/azure-core/azure/core/pipeline/transport/_aiohttp.py
@@ -217,7 +217,7 @@ async def send(self, request, **config):
             verify=config.pop('connection_verify', self.connection_config.verify)
         )
         # If we know for sure there is not body, disable "auto content type"
-        # Otherwise, aiohttp will send "application/octect-stream" even for empty POST request
+        # Otherwise, aiohttp will send "application/octet-stream" even for empty POST request
         # and that break services like storage signature
         if not request.data and not request.files:
             config['skip_auto_headers'] = ['Content-Type']
diff --git a/sdk/core/azure-core/azure/core/pipeline/transport/_base.py b/sdk/core/azure-core/azure/core/pipeline/transport/_base.py
@@ -417,7 +417,7 @@ def _get_raw_parts(self, http_response_type=None):
         """Assuming this body is multipart, return the iterator or parts.
 
         If parts are application/http use http_response_type or HttpClientTransportResponse
-        as enveloppe.
+        as envelope.
         """
         return _get_raw_parts_helper(self, http_response_type or HttpClientTransportResponse)
 
diff --git a/sdk/core/azure-core/azure/core/rest/_http_response_impl.py b/sdk/core/azure-core/azure/core/rest/_http_response_impl.py
@@ -121,7 +121,7 @@ def _get_raw_parts(self, http_response_type=None):
         Assuming this body is multipart, return the iterator or parts.
 
         If parts are application/http use http_response_type or HttpClientTransportResponse
-        as enveloppe.
+        as envelope.
         """
         return _get_raw_parts_helper(
             self, http_response_type or RestHttpClientTransportResponse
diff --git a/sdk/core/azure-core/azure/core/settings.py b/sdk/core/azure-core/azure/core/settings.py
@@ -198,7 +198,7 @@ class PrioritizedSetting(object):
     The optional ``default`` argument specified an implicit default value for
     the setting that is returned if no other methods provide a value.
 
-    A ``convert`` agument may be provided to convert values before they are
+    A ``convert`` argument may be provided to convert values before they are
     returned. For instance to concert log levels in environment variables
     to ``logging`` module values.
 
@@ -332,7 +332,7 @@ class Settings(object):
     * settings.defaults returns the base defaultsvalues , ignoring any environment or system
       or user settings
 
-    * settings.current returns the current computation of settings including prioritizatiom
+    * settings.current returns the current computation of settings including prioritization
       of configuration sources, unless defaults_only is set to True (in which case the result
       is identical to settings.defaults)
 
@@ -422,7 +422,7 @@ def _config(self, props):  # pylint: disable=no-self-use
     )
 
     tracing_enabled = PrioritizedSetting(
-        "tracing_enbled", env_var="AZURE_TRACING_ENABLED", convert=convert_bool, default=False
+        "tracing_enabled", env_var="AZURE_TRACING_ENABLED", convert=convert_bool, default=False
     )
 
     tracing_implementation = PrioritizedSetting(
diff --git a/sdk/core/azure-core/azure/core/tracing/_abstract_span.py b/sdk/core/azure-core/azure/core/tracing/_abstract_span.py
@@ -49,7 +49,7 @@ def __init__(self, span=None, name=None, **kwargs):  # pylint: disable=super-ini
         # type: (Optional[Any], Optional[str], Any) -> None
         """
         If a span is given wraps the span. Else a new span is created.
-        The optional arguement name is given to the new span.
+        The optional argument name is given to the new span.
         """
 
     def span(self, name="child_span", **kwargs):
diff --git a/sdk/core/azure-core/azure/core/utils/_pipeline_transport_rest_shared.py b/sdk/core/azure-core/azure/core/utils/_pipeline_transport_rest_shared.py
@@ -232,20 +232,20 @@ def _decode_parts_helper(
     Rebuild an HTTP response from pure string.
     """
     responses = []
-    for index, raw_reponse in enumerate(message.get_payload()):
-        content_type = raw_reponse.get_content_type()
+    for index, raw_response in enumerate(message.get_payload()):
+        content_type = raw_response.get_content_type()
         if content_type == "application/http":
             responses.append(
                 deserialize_response(
-                    raw_reponse.get_payload(decode=True),
+                    raw_response.get_payload(decode=True),
                     requests[index],
                     http_response_type=http_response_type,
                 )
             )
         elif content_type == "multipart/mixed" and requests[index].multipart_mixed_info:
             # The message batch contains one or more change sets
             changeset_requests = requests[index].multipart_mixed_info[0]  # type: ignore
-            changeset_responses = response._decode_parts(raw_reponse, http_response_type, changeset_requests)  # pylint: disable=protected-access
+            changeset_responses = response._decode_parts(raw_response, http_response_type, changeset_requests)  # pylint: disable=protected-access
             responses.extend(changeset_responses)
         else:
             raise ValueError(
@@ -259,7 +259,7 @@ def _get_raw_parts_helper(response, http_response_type):
     Assuming this body is multipart, return the iterator or parts.
 
     If parts are application/http use http_response_type or HttpClientTransportResponse
-    as enveloppe.
+    as envelope.
     """
     body_as_bytes = response.body()
     # In order to use email.message parser, I need full HTTP bytes. Faking something to make the parser happy
@@ -338,7 +338,7 @@ def _aiohttp_body_helper(response):
     """Helper for body method of Aiohttp responses.
 
     Since aiohttp body methods need decompression work synchronously,
-    need to share thid code across old and new aiohttp transport responses
+    need to share this code across old and new aiohttp transport responses
     for backcompat.
 
     :rtype: bytes
diff --git a/sdk/core/azure-core/tests/async_tests/test_base_polling_async.py b/sdk/core/azure-core/tests/async_tests/test_base_polling_async.py
@@ -95,7 +95,7 @@ async def mock_run(client_self, request, **kwargs):
 
 @pytest.fixture
 def client():
-    # The poller itself don't use it, so we don't need something functionnal
+    # The poller itself don't use it, so we don't need something functional
     return AsyncPipelineClient("https://baseurl")
 
 
diff --git a/sdk/core/azure-core/tests/async_tests/test_polling_async.py b/sdk/core/azure-core/tests/async_tests/test_polling_async.py
@@ -40,7 +40,7 @@
 
 @pytest.fixture
 def client():
-    # The poller itself don't use it, so we don't need something functionnal
+    # The poller itself don't use it, so we don't need something functional
     return AsyncPipelineClient("https://baseurl")
 
 
diff --git a/sdk/core/azure-core/tests/async_tests/test_rest_http_request_async.py b/sdk/core/azure-core/tests/async_tests/test_rest_http_request_async.py
@@ -40,7 +40,7 @@ async def streaming_body(data):
     assert request.headers["Content-Length"] == "0"
 
 @pytest.mark.asyncio
-async def test_aiterbale_content(assert_aiterator_body):
+async def test_aiterable_content(assert_aiterator_body): # cspell:disable-line
     class Content:
         async def __aiter__(self):
             yield b"test 123"
diff --git a/sdk/core/azure-core/tests/async_tests/test_rest_http_response_async.py b/sdk/core/azure-core/tests/async_tests/test_rest_http_response_async.py
@@ -160,7 +160,7 @@ async def test_response_no_charset_with_ascii_content(send_request):
 async def test_response_no_charset_with_iso_8859_1_content(send_request):
     """
     We don't support iso-8859-1 by default following conversations
-    about endoding flow
+    about encoding flow
     """
     response = await send_request(
         request=HttpRequest("GET", "/encoding/iso-8859-1"),
diff --git a/sdk/core/azure-core/tests/async_tests/test_rest_response_backcompat_async.py b/sdk/core/azure-core/tests/async_tests/test_rest_response_backcompat_async.py
@@ -57,7 +57,7 @@ async def _callback(**kwargs):
 def _test_response_attr_parity(old_response, new_response):
     for attr in dir(old_response):
         if not attr[0] == "_":
-            # if not a private attr, we want partiy
+            # if not a private attr, we want parity
             assert hasattr(new_response, attr)
 
 @pytest.mark.asyncio
diff --git a/sdk/core/azure-core/tests/async_tests/test_universal_http_async.py b/sdk/core/azure-core/tests/async_tests/test_universal_http_async.py
@@ -132,6 +132,7 @@ async def test_aiohttp_response_text(http_response):
 @pytest.mark.asyncio
 @pytest.mark.parametrize("http_response", AIOHTTP_TRANSPORT_RESPONSES)
 async def test_aiohttp_response_decompression(http_response):
+    # cSpell:disable
     res = _create_aiohttp_response(
         http_response,
         b"\x1f\x8b\x08\x00\x00\x00\x00\x00\x04\x00\x8d\x8d\xb1n\xc30\x0cD"
@@ -145,6 +146,7 @@ async def test_aiohttp_response_decompression(http_response):
         b"\xf7+&$\xf6\xa9\x8a\xcb\x96\xdc\xef\xff\xaa\xa1\x1c\xf9$\x01\x00\x00",
         {'Content-Type': 'text/plain', 'Content-Encoding':"gzip"}
     )
+    # cSpell:enable
     body = res.body()
     expect = b'{"id":"e7877039-1376-4dcd-9b0a-192897cff780","createdDateTimeUtc":' \
              b'"2021-05-07T17:35:36.3121065Z","lastActionDateTimeUtc":' \
@@ -155,8 +157,9 @@ async def test_aiohttp_response_decompression(http_response):
 
 @pytest.mark.asyncio
 @pytest.mark.parametrize("http_response", AIOHTTP_TRANSPORT_RESPONSES)
-async def test_aiohttp_response_decompression_negtive(http_response):
+async def test_aiohttp_response_decompression_negative(http_response):
     import zlib
+    # cSpell:disable
     res = _create_aiohttp_response(
         http_response,
         b"\xff\x85s\x14HVlY\xda\x8av.\n4\x1d\x9a\x8d\xa1\xe5D\x80m\x01\x12="
@@ -169,6 +172,7 @@ async def test_aiohttp_response_decompression_negtive(http_response):
         b"\xf7+&$\xf6\xa9\x8a\xcb\x96\xdc\xef\xff\xaa\xa1\x1c\xf9$\x01\x00\x00",
         {'Content-Type': 'text/plain', 'Content-Encoding':"gzip"}
     )
+    # cSpell:enable
     with pytest.raises(zlib.error):
         body = res.body()
 
diff --git a/sdk/core/azure-core/tests/test_authentication.py b/sdk/core/azure-core/tests/test_authentication.py
@@ -274,7 +274,7 @@ def test_key_vault_regression(http_request):
     assert policy._credential is credential
 
     headers = {}
-    token = "alphanums"
+    token = "alphanums" # cspell:disable-line
     policy._update_headers(headers, token)
     assert headers["Authorization"] == "Bearer " + token
 
diff --git a/sdk/core/azure-core/tests/test_base_polling.py b/sdk/core/azure-core/tests/test_base_polling.py
@@ -93,7 +93,7 @@ def mock_run(client_self, request, **kwargs):
 
 @pytest.fixture
 def client():
-    # The poller itself don't use it, so we don't need something functionnal
+    # The poller itself don't use it, so we don't need something functional
     return PipelineClient("https://baseurl")
 
 
@@ -642,7 +642,7 @@ def test_long_running_delete(self, http_request, http_response):
 
     @pytest.mark.parametrize("http_request,http_response", request_and_responses_product(REQUESTS_TRANSPORT_RESPONSES))
     def test_long_running_post_legacy(self, http_request, http_response):
-        # Former oooooold tests to refactor one day to something more readble
+        # Former oooooold tests to refactor one day to something more readable
 
         # Test polling from operation-location header
         response = TestBasePolling.mock_send(
diff --git a/sdk/core/azure-core/tests/test_connection_string_parsing.py b/sdk/core/azure-core/tests/test_connection_string_parsing.py
@@ -4,7 +4,7 @@
 from devtools_testutils import AzureMgmtTestCase
 
 class CoreConnectionStringParserTests(AzureMgmtTestCase):
-
+    # cSpell:disable
     def test_parsing_with_case_sensitive_keys_for_sensitive_conn_str(self, **kwargs):
         conn_str = 'Endpoint=XXXXENDPOINTXXXX;SharedAccessKeyName=XXXXPOLICYXXXX;SharedAccessKey=THISISATESTKEYXXXXXXXXXXXXXXXXXXXXXXXXXXXX='
         parse_result = parse_connection_string(conn_str, True)
@@ -127,4 +127,5 @@ def test_case_insensitive_values_method(self):
         conn_str = 'enDpoiNT=XXXXENDPOINTXXXX;sharedaccesskeyname=XXXXPOLICYXXXX;SHAREDACCESSKEY=THISISATESTKEYXXXXXXXXXXXXXXXXXXXXXXXXXXXX='
         parse_result = parse_connection_string(conn_str, False)
         values = parse_result.values()
-        assert len(values) == 3
+        assert len(values) == 3
+    # cSpell:enable
diff --git a/sdk/core/azure-core/tests/test_messaging_cloud_event.py b/sdk/core/azure-core/tests/test_messaging_cloud_event.py
@@ -399,7 +399,7 @@ def test_cloud_custom_dict_base64():
     cloud_custom_dict_base64 = {
         "id":"de0fd76c-4ef4-4dfb-ab3a-8f24a307e033",
         "source":"https://egtest.dev/cloudcustomevent",
-        "data_base64":'Y2xvdWRldmVudA==',
+        "data_base64":'Y2xvdWRldmVudA==', # cspell:disable-line
         "type":"Azure.Sdk.Sample",
         "time":"2021-02-23T17:11:13.308772-08:00",
         "specversion":"1.0"
diff --git a/sdk/core/azure-core/tests/test_polling.py b/sdk/core/azure-core/tests/test_polling.py
@@ -42,7 +42,7 @@
 
 @pytest.fixture
 def client():
-    # The poller itself don't use it, so we don't need something functionnal
+    # The poller itself don't use it, so we don't need something functional
     return PipelineClient("https://baseurl")
 
 
diff --git a/sdk/core/azure-core/tests/test_rest_http_request.py b/sdk/core/azure-core/tests/test_rest_http_request.py
@@ -321,7 +321,7 @@ def test_use_custom_json_encoder():
     # since json can't serialize bytes by default but AzureJSONEncoder can,
     # we pass in bytes and check that they are serialized
     request = HttpRequest("GET", "/headers", json=bytearray("mybytes", "utf-8"))
-    assert request.content == '"bXlieXRlcw=="'
+    assert request.content == '"bXlieXRlcw=="' # cspell:disable-line
 
 def test_request_policies_raw_request_hook(port):
     # test that the request all the way through the pipeline is a new request
@@ -385,7 +385,7 @@ def on_request(self, request):
     with pytest.raises(ValueError) as ex:
         client.send_request(
             request,
-            content="I should be overriden",
+            content="I should be overridden",
         )
     assert "Passed through the policies!" in str(ex.value)
 
diff --git a/sdk/core/azure-core/tests/test_rest_http_response.py b/sdk/core/azure-core/tests/test_rest_http_response.py
@@ -147,7 +147,7 @@ def test_response_no_charset_with_ascii_content(send_request):
 def test_response_no_charset_with_iso_8859_1_content(send_request):
     """
     We don't support iso-8859-1 by default following conversations
-    about endoding flow
+    about encoding flow
     """
     response = send_request(
         request=HttpRequest("GET", "/encoding/iso-8859-1"),
diff --git a/sdk/core/azure-core/tests/test_rest_response_backcompat.py b/sdk/core/azure-core/tests/test_rest_response_backcompat.py
@@ -31,7 +31,7 @@ def new_response(new_request):
 def test_response_attr_parity(old_response, new_response):
     for attr in dir(old_response):
         if not attr[0] == "_":
-            # if not a private attr, we want partiy
+            # if not a private attr, we want parity
             assert hasattr(new_response, attr)
 
 def test_response_set_attrs(old_response, new_response):
diff --git a/sdk/core/azure-core/tests/test_serialization.py b/sdk/core/azure-core/tests/test_serialization.py
diff --git a/sdk/core/azure-core/tests/test_settings.py b/sdk/core/azure-core/tests/test_settings.py
diff --git a/sdk/core/azure-core/tests/test_streaming.py b/sdk/core/azure-core/tests/test_streaming.py
diff --git a/sdk/core/azure-core/tests/test_tracing_policy.py b/sdk/core/azure-core/tests/test_tracing_policy.py
diff --git a/sdk/core/azure-core/tests/test_universal_pipeline.py b/sdk/core/azure-core/tests/test_universal_pipeline.py
diff --git a/sdk/core/azure-core/tests/testserver_tests/coretestserver/coretestserver/test_routes/encoding.py b/sdk/core/azure-core/tests/testserver_tests/coretestserver/coretestserver/test_routes/encoding.py
diff --git a/sdk/core/azure-core/tests/testserver_tests/coretestserver/coretestserver/test_routes/helpers.py b/sdk/core/azure-core/tests/testserver_tests/coretestserver/coretestserver/test_routes/helpers.py

Original file line number	Diff line number	Diff line change
`@@ -217,7 +217,7 @@ async def send(self, request, **config):`
`217`	`217`	`verify=config.pop('connection_verify', self.connection_config.verify)`
`218`	`218`	`)`
`219`	`219`	`# If we know for sure there is not body, disable "auto content type"`
`220`		`- # Otherwise, aiohttp will send "application/octect-stream" even for empty POST request`
	`220`	`+ # Otherwise, aiohttp will send "application/octet-stream" even for empty POST request`
`221`	`221`	`# and that break services like storage signature`
`222`	`222`	`if not request.data and not request.files:`
`223`	`223`	`config['skip_auto_headers'] = ['Content-Type']`