corehttp 1.0.0b3__py3-none-any.whl → 1.0.0b5__py3-none-any.whl

corehttp/_version.py

@@ -9,4 +9,4 @@
 # regenerated.
 # --------------------------------------------------------------------------
 
-VERSION = "1.0.0b3"
+VERSION = "1.0.0b5"

corehttp/credentials.py

@@ -4,7 +4,6 @@
 # license information.
 # -------------------------------------------------------------------------
 from __future__ import annotations
-from collections import namedtuple
 from types import TracebackType
 from typing import Any, NamedTuple, Optional, AsyncContextManager, Type
 from typing_extensions import Protocol, runtime_checkable
@@ -40,7 +39,12 @@ class TokenCredential(Protocol):
         ...
 
 
-ServiceNamedKey = namedtuple("ServiceNamedKey", ["name", "key"])
+class ServiceNamedKey(NamedTuple):
+    """Represents a name and key pair."""
+
+    name: str
+    key: str
+
 
 __all__ = [
     "AccessToken",

corehttp/runtime/_base.py

@@ -23,11 +23,11 @@
 # IN THE SOFTWARE.
 #
 # --------------------------------------------------------------------------
-from typing import Any
+from typing import Any, Dict
 from urllib.parse import urlparse
 
 
-def _format_url_section(template, **kwargs):
+def _format_url_section(template, **kwargs: Dict[str, str]) -> str:
     """String format the template with the kwargs, auto-skip sections of the template that are NOT in the kwargs.
 
     By default in Python, "format" will raise a KeyError if a template element is not found. Here the section between
@@ -53,6 +53,7 @@ def _format_url_section(template, **kwargs):
                     f"The value provided for the url part '{template}' was incorrect, and resulted in an invalid url"
                 ) from key
             last_template = template
+    return last_template
 
 
 def _urljoin(base_url: str, stub_url: str) -> str:
@@ -71,7 +72,7 @@ def _urljoin(base_url: str, stub_url: str) -> str:
     stub_url_path = split_url.pop(0)
     stub_url_query = split_url.pop() if split_url else None
 
-    # Note that _replace is a public API named that way to avoid to avoid conflicts in namedtuple
+    # Note that _replace is a public API named that way to avoid conflicts in namedtuple
     # https://docs.python.org/3/library/collections.html?highlight=namedtuple#collections.namedtuple
     parsed_base_url = parsed_base_url._replace(
         path=parsed_base_url.path.rstrip("/") + "/" + stub_url_path,

corehttp/runtime/_pipeline_client.py

@@ -62,6 +62,15 @@ class PipelineClient(PipelineClientBase, Generic[HTTPRequestType, HTTPResponseTy
 
     :ivar pipeline: The Pipeline object associated with the client.
     :vartype pipeline: ~corehttp.runtime.pipeline.Pipeline or None
+
+    .. admonition:: Example:
+
+        .. literalinclude:: ../samples/sample_pipeline_client.py
+            :start-after: [START build_pipeline_client]
+            :end-before: [END build_pipeline_client]
+            :language: python
+            :dedent: 4
+            :caption: Builds the pipeline client.
     """
 
     def __init__(

corehttp/runtime/_pipeline_client_async.py

@@ -141,6 +141,15 @@ class AsyncPipelineClient(
 
     :ivar pipeline: The Pipeline object associated with the client.
     :vartype pipeline: ~corehttp.runtime.pipeline.Pipeline or None
+
+    .. admonition:: Example:
+
+        .. literalinclude:: ../samples/sample_async_pipeline_client.py
+            :start-after: [START build_async_pipeline_client]
+            :end-before: [END build_async_pipeline_client]
+            :language: python
+            :dedent: 4
+            :caption: Builds the async pipeline client.
     """
 
     def __init__(

corehttp/runtime/pipeline/_base.py

@@ -26,6 +26,7 @@
 from __future__ import annotations
 import logging
 from typing import Generic, TypeVar, Union, Any, List, Optional, Iterable, ContextManager
+from typing_extensions import TypeGuard
 
 from . import (
     PipelineRequest,
@@ -42,6 +43,18 @@ HTTPRequestType = TypeVar("HTTPRequestType")
 _LOGGER = logging.getLogger(__name__)
 
 
+def is_http_policy(policy: object) -> TypeGuard[HTTPPolicy]:
+    if hasattr(policy, "send"):
+        return True
+    return False
+
+
+def is_sansio_http_policy(policy: object) -> TypeGuard[SansIOHTTPPolicy]:
+    if hasattr(policy, "on_request") and hasattr(policy, "on_response"):
+        return True
+    return False
+
+
 class _SansIOHTTPPolicyRunner(HTTPPolicy[HTTPRequestType, HTTPResponseType]):
     """Sync implementation of the SansIO policy.
 
@@ -123,10 +136,14 @@ class Pipeline(ContextManager["Pipeline"], Generic[HTTPRequestType, HTTPResponse
         self._transport = transport
 
         for policy in policies or []:
-            if isinstance(policy, SansIOHTTPPolicy):
+            if is_http_policy(policy):
+                self._impl_policies.append(policy)
+            elif is_sansio_http_policy(policy):
                 self._impl_policies.append(_SansIOHTTPPolicyRunner(policy))
             elif policy:
-                self._impl_policies.append(policy)
+                raise AttributeError(
+                    f"'{type(policy)}' object has no attribute 'send' or both 'on_request' and 'on_response'."
+                )
         for index in range(len(self._impl_policies) - 1):
             self._impl_policies[index].next = self._impl_policies[index + 1]
         if self._impl_policies:

corehttp/runtime/pipeline/_base_async.py

@@ -24,12 +24,14 @@
 #
 # --------------------------------------------------------------------------
 from __future__ import annotations
+import inspect
 from types import TracebackType
 from typing import Any, Union, Generic, TypeVar, List, Optional, Iterable, Type
-from typing_extensions import AsyncContextManager
+from typing_extensions import AsyncContextManager, TypeGuard
 
 from . import PipelineRequest, PipelineResponse, PipelineContext
 from ..policies import AsyncHTTPPolicy, SansIOHTTPPolicy
+from ..pipeline._base import is_sansio_http_policy
 from ._tools_async import await_result as _await_result
 from ...transport import AsyncHttpTransport
 
@@ -37,6 +39,12 @@ AsyncHTTPResponseType = TypeVar("AsyncHTTPResponseType")
 HTTPRequestType = TypeVar("HTTPRequestType")
 
 
+def is_async_http_policy(policy: object) -> TypeGuard[AsyncHTTPPolicy]:
+    if hasattr(policy, "send") and inspect.iscoroutinefunction(policy.send):
+        return True
+    return False
+
+
 class _SansIOAsyncHTTPPolicyRunner(
     AsyncHTTPPolicy[HTTPRequestType, AsyncHTTPResponseType]
 ):  # pylint: disable=unsubscriptable-object
@@ -127,10 +135,14 @@ class AsyncPipeline(AsyncContextManager["AsyncPipeline"], Generic[HTTPRequestTyp
         self._transport = transport
 
         for policy in policies or []:
-            if isinstance(policy, SansIOHTTPPolicy):
+            if is_async_http_policy(policy):
+                self._impl_policies.append(policy)
+            elif is_sansio_http_policy(policy):
                 self._impl_policies.append(_SansIOAsyncHTTPPolicyRunner(policy))
             elif policy:
-                self._impl_policies.append(policy)
+                raise AttributeError(
+                    f"'{type(policy)}' object has no attribute 'send' or both 'on_request' and 'on_response'."
+                )
         for index in range(len(self._impl_policies) - 1):
             self._impl_policies[index].next = self._impl_policies[index + 1]
         if self._impl_policies:

corehttp/runtime/policies/_authentication_async.py

@@ -4,7 +4,6 @@
 # license information.
 # -------------------------------------------------------------------------
 from __future__ import annotations
-import asyncio
 import time
 from typing import TYPE_CHECKING, Any, Awaitable, Optional, cast, TypeVar
 
@@ -14,6 +13,7 @@ from ..pipeline._tools_async import await_result
 from ._base_async import AsyncHTTPPolicy
 from ._authentication import _BearerTokenCredentialPolicyBase
 from ...rest import AsyncHttpResponse, HttpRequest
+from ...utils._utils import get_running_async_lock
 
 if TYPE_CHECKING:
     from ...credentials import AsyncTokenCredential
@@ -36,10 +36,16 @@ class AsyncBearerTokenCredentialPolicy(AsyncHTTPPolicy[HTTPRequestType, AsyncHTT
     ) -> None:
         super().__init__()
         self._credential = credential
-        self._lock = asyncio.Lock()
+        self._lock_instance = None
         self._scopes = scopes
         self._token: Optional["AccessToken"] = None
 
+    @property
+    def _lock(self):
+        if self._lock_instance is None:
+            self._lock_instance = get_running_async_lock()
+        return self._lock_instance
+
     async def on_request(self, request: PipelineRequest[HTTPRequestType]) -> None:
         """Adds a bearer token Authorization header to request and sends request to next policy.
 

corehttp/runtime/policies/_universal.py

@@ -35,7 +35,7 @@ import platform
 import xml.etree.ElementTree as ET
 import types
 import re
-from typing import IO, cast, Union, Optional, AnyStr, Dict, Any, Mapping, TYPE_CHECKING
+from typing import IO, cast, Union, Optional, AnyStr, Dict, Any, MutableMapping, TYPE_CHECKING
 
 from ... import __version__ as core_version
 from ...exceptions import DecodeError
@@ -449,12 +449,12 @@ class ProxyPolicy(SansIOHTTPPolicy[HTTPRequestType, HTTPResponseType]):
     Dictionary mapping protocol or protocol and host to the URL of the proxy
     to be used on each Request.
 
-    :param dict proxies: Maps protocol or protocol and hostname to the URL
+    :param MutableMapping proxies: Maps protocol or protocol and hostname to the URL
      of the proxy.
     """
 
     def __init__(
-        self, proxies: Optional[Mapping[str, str]] = None, **kwargs: Any
+        self, proxies: Optional[MutableMapping[str, str]] = None, **kwargs: Any
     ):  # pylint: disable=unused-argument,super-init-not-called
         self.proxies = proxies
 

corehttp/runtime/policies/_utils.py

@@ -61,7 +61,7 @@ def parse_retry_after(retry_after: str) -> float:
     """
     delay: float  # Using the Mypy recommendation to use float for "int or float"
     try:
-        delay = int(retry_after)
+        delay = float(retry_after)
     except ValueError:
         # Not an integer? Try HTTP date
         retry_date = _parse_http_date(retry_after)

corehttp/transport/requests/_bigger_block_size_http_adapters.py

@@ -25,18 +25,21 @@
 # --------------------------------------------------------------------------
 
 import sys
+from typing import MutableMapping, Optional
+
 from requests.adapters import HTTPAdapter  # pylint: disable=all
+from urllib3.connectionpool import ConnectionPool
 
 
 class BiggerBlockSizeHTTPAdapter(HTTPAdapter):
-    def get_connection(self, url, proxies=None):
+    def get_connection(self, url: str, proxies: Optional[MutableMapping[str, str]] = None) -> ConnectionPool:
         """Returns a urllib3 connection for the given URL. This should not be
         called from user code, and is only exposed for use when subclassing the
         :class:`HTTPAdapter <requests.adapters.HTTPAdapter>`.
 
         :param str url: The URL to connect to.
         :param dict proxies: (optional) A Requests-style dictionary of proxies used on this request.
-        :rtype: urllib3.ConnectionPool
+        :rtype: urllib3.connectionpool.ConnectionPool
         :returns: The urllib3 ConnectionPool for the given URL.
         """
         conn = super(BiggerBlockSizeHTTPAdapter, self).get_connection(url, proxies)

corehttp/utils/_utils.py

@@ -7,6 +7,7 @@
 import datetime
 from typing import (
     Any,
+    AsyncContextManager,
     Iterable,
     Iterator,
     Mapping,
@@ -164,3 +165,21 @@ def get_file_items(files: "FilesType") -> Sequence[Tuple[str, "FileType"]]:
         # though realistically it is ordered python 3.7 and after
         return cast(Sequence[Tuple[str, "FileType"]], files.items())
     return files
+
+
+def get_running_async_lock() -> AsyncContextManager:
+    """Get a lock instance from the async library that the current context is running under.
+    :return: An instance of the running async library's Lock class.
+    :rtype: AsyncContextManager
+    :raises: RuntimeError if the current context is not running under an async library.
+    """
+
+    try:
+        import asyncio
+
+        # Check if we are running in an asyncio event loop.
+        asyncio.get_running_loop()
+        return asyncio.Lock()
+    except RuntimeError as err:
+        # Otherwise, assume we are running in a trio event loop, but this currently isn't supported.
+        raise RuntimeError("An asyncio event loop is required.") from err

{corehttp-1.0.0b3.dist-info → corehttp-1.0.0b5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: corehttp
-Version: 1.0.0b3
+Version: 1.0.0b5
 Summary: CoreHTTP Library for Python
 Home-page: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/corehttp
 Author: Microsoft Corporation
@@ -87,6 +87,18 @@ additional questions or comments.
 
 # Release History
 
+## 1.0.0b5 (2024-02-29)
+
+### Other Changes
+
+- Accept float for `retry_after` header.
+
+## 1.0.0b4 (2024-02-23)
+
+### Other Changes
+
+- Relax type checking in `Pipeline` constructors to only check that each user-supplied policy object has either a `send` method or both an `on_request` and `on_response` method. This allows for more flexible policy implementations. [#34296](https://github.com/Azure/azure-sdk-for-python/pull/34296)
+
 ## 1.0.0b3 (2024-02-01)
 
 ### Features Added

{corehttp-1.0.0b3.dist-info → corehttp-1.0.0b5.dist-info}/RECORD

@@ -1,7 +1,7 @@
 corehttp/__init__.py,sha256=Wdidh085sV_IhdV_wU79t7FpghhpyxCsRnZGOUoQ0xs,1443
 corehttp/_match_conditions.py,sha256=3TIhb4vBO1hBe7MaQwS_9i-d6p7o4jn5L6M-OiQahkg,1864
-corehttp/_version.py,sha256=WpPNbvTVMgZmXUT0N41Pz54YA5RyfhIlQ5_h53nKNF4,494
-corehttp/credentials.py,sha256=YqM4sfpG5Ca0uH0tmZxGpft6l37mf7Ok5ttGKNvrV-A,5231
+corehttp/_version.py,sha256=Adx1gY_uaehKHdReRn2zLYGyMjbGV43k9smdJngNeLo,494
+corehttp/credentials.py,sha256=xx94AN5Nekiz3SNHJNV6ncS2o4ObCc5U_Ya62QzTfaM,5237
 corehttp/exceptions.py,sha256=qSqzPJVD_ufGO5HEAbNY8BNmVUoXPCgBeVrw195QvF4,11554
 corehttp/paging.py,sha256=zI-fFLBUgMRZmFegD2T6Q52s_3PFDb6lLjtR7-XSZDc,9520
 corehttp/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -15,23 +15,23 @@ corehttp/rest/_httpx.py,sha256=7mmpEIQ0-GLf3G_Wg3-f2dQnk-mvw4xbqtL9eoPhhwY,8173
 corehttp/rest/_requests_basic.py,sha256=rw2GwxDMMrG5A4onTKLwQpsQe98MtUaowA_-BfTgsuc,7527
 corehttp/rest/_rest_py3.py,sha256=JLLGz6svFF-UwxS_GyGUq5c2KHcNL26TB-ARxfBIOY8,14096
 corehttp/runtime/__init__.py,sha256=OeG_5-Oq3Zp9rJcMfRNiYLv3V39wIZxDcQ-unerauDw,1469
-corehttp/runtime/_base.py,sha256=LoOjgukxlbXyb9itBUJLsfiZxMPmdED099tHSe9j_Ow,5011
-corehttp/runtime/_pipeline_client.py,sha256=zocWLWc3FXhPNJ2oZDYyIaPgEqqWk-8q0AEViCf27UM,6791
-corehttp/runtime/_pipeline_client_async.py,sha256=WK6oZonN_1S_cdCN9y3D8emzc-28iUY_XknYlZsLudI,10046
+corehttp/runtime/_base.py,sha256=gr2xJQJeWuOmtrudFhM07_6ASIhUX66jR1nxSRMh068,5056
+corehttp/runtime/_pipeline_client.py,sha256=A2R0JEcfFIOe6b38VzuQatAxfbiBhtu_RCpOlM968b0,7099
+corehttp/runtime/_pipeline_client_async.py,sha256=dBUqhntQzcS1kbQ6z7d6C4Y3HDghLr4jrobtlKvbVTw,10378
 corehttp/runtime/pipeline/__init__.py,sha256=gRGAsJ1ZDE20TMp6JDw8OpekZdfA7ZzZvOhVHclNpDI,7727
-corehttp/runtime/pipeline/_base.py,sha256=6np0sAUrok6KglirlWe252b8XnpFj2wg38DkoK1q-zA,6341
-corehttp/runtime/pipeline/_base_async.py,sha256=2f8ExvZxZZzKsl5ubTuKabEspiCda0eemIvbUv1BIws,6898
+corehttp/runtime/pipeline/_base.py,sha256=WVLDonxHv5knC-Ffq7YW2cRHr22rtZQjRtZ2N9FWzLw,6900
+corehttp/runtime/pipeline/_base_async.py,sha256=4hvZDFlJ9odUs6Z6etQUlXfm9b1Bt_avZxxEee_h3Sw,7370
 corehttp/runtime/pipeline/_tools.py,sha256=iol34Mo_R6-Rezal7WSFFSzFa1V3dXf90AQydnxRnSQ,2004
 corehttp/runtime/pipeline/_tools_async.py,sha256=OvEJjH8NuGnSOrcbJBCIlN_TsO8w87kgEJ0LJcwcYH0,2159
 corehttp/runtime/policies/__init__.py,sha256=_LPYWjRNkDq45FAHUvyMJ92BL0W6pf7-KrjxSZSkF5c,2196
 corehttp/runtime/policies/_authentication.py,sha256=mgacXdydBBKPQ-5NujqNNWNNCsbt9ETWJBBdqMqgfGc,8819
-corehttp/runtime/policies/_authentication_async.py,sha256=xo3w9NKV0JYJ0qosyCrypwC4jWOqEavLNn8x12xxsLc,6741
+corehttp/runtime/policies/_authentication_async.py,sha256=QUUYFlcsc6vJDox7vw1Ggg165c1KXEWiwM70BInoidM,6946
 corehttp/runtime/policies/_base.py,sha256=zLM4NIwGQwZ75k-KPo3PthmDCpDidHvZy91ok0wnFvQ,5063
 corehttp/runtime/policies/_base_async.py,sha256=nOZ-3lrKmfnFam3FbSY4wd9sOI7r5pI2HSdqgOC4Vz4,2531
 corehttp/runtime/policies/_retry.py,sha256=vM40m1JSD-l6yBclxmQV06_ZOK4WAcy1PTqQQpTr3ts,24367
 corehttp/runtime/policies/_retry_async.py,sha256=rsVFxlQMDyU1Z34FKd1trfxj2VkwGt-Ap7uqiErMeAc,9131
-corehttp/runtime/policies/_universal.py,sha256=0LQK27RI67JOerVWr5UW15ylbxxFPDbxyAGZaEjPeO8,19811
-corehttp/runtime/policies/_utils.py,sha256=ZODnUkPKLQOfVghqkijm8ifkrCl1oVakGafSGEJBGKA,3594
+corehttp/runtime/policies/_universal.py,sha256=6qfC2MAQbp1KQgWnbbcBKuwprzEZaftx7tfY6QuHmpo,19835
+corehttp/runtime/policies/_utils.py,sha256=kDnGRpC3MxsW7zHZRfkLyPMArlzY4n7vBhwQQVWKQuI,3596
 corehttp/transport/__init__.py,sha256=6A1i9gjM5isBPb-AL-2JTzxn7pssDj8ux9Ujn6rHjlY,1442
 corehttp/transport/_base.py,sha256=5gFTZ1u--3Ik9DyrAe10RtObasd-OXX1y9sRSkbvoyY,5107
 corehttp/transport/_base_async.py,sha256=9zl1Sa8Vm6QBdn8Nf-J3w2qZ-wsjcV9bv1EX5Jr28w4,3827
@@ -40,13 +40,13 @@ corehttp/transport/aiohttp/_aiohttp.py,sha256=EesPhF2tAIMxgM0qwFfUu4IUzwF8mHLHbn
 corehttp/transport/httpx/__init__.py,sha256=IbjUxTxtGljHK9nq6w0kAFeHd73zAl7qtd27qlqCrzg,1412
 corehttp/transport/httpx/_httpx.py,sha256=of8Mxyfzm1Rd4ltYNt8wGz1xuTnJVef0KaiJyl99KfE,8579
 corehttp/transport/requests/__init__.py,sha256=WPdzueqs0eLfvumuedxXPsOIpPCq3dDOvdzmIK4nyHs,1390
-corehttp/transport/requests/_bigger_block_size_http_adapters.py,sha256=yogrzcFJ3s9bA3Tsxgb7vjgsblnIUYqEYxk1cnTibrU,2273
+corehttp/transport/requests/_bigger_block_size_http_adapters.py,sha256=0SkJ3lQHdbh1iBlCCbc9NCshDRJsVLZUZdWL-frZ_4Q,2444
 corehttp/transport/requests/_requests_basic.py,sha256=ChsXobJeBdwLTnNnDzWLZi5JYVg6M95kcxXfcgPZ3r0,8179
 corehttp/utils/__init__.py,sha256=_h2vJje1Tb-w_9mXm0hO_s2S1b48HLzI4taIlvz3Eu4,1648
 corehttp/utils/_enum_meta.py,sha256=l2K1mZfpwljsruKxknabYckl0ZbsVftOxfbRhpzF_-s,2816
-corehttp/utils/_utils.py,sha256=JVlqFrmVlVKI88JdJ75pWaKXnWGhWV_uxGyG4Gpq0v0,5328
-corehttp-1.0.0b3.dist-info/LICENSE,sha256=_VMkgdgo4ToLE8y1mOAjOKNhd0BnWoYu5r3BVBto6T0,1073
-corehttp-1.0.0b3.dist-info/METADATA,sha256=YE97sgRjm7Ns9FhR7QUt-8io3FuMhSro6eA5G0dbiG8,4933
-corehttp-1.0.0b3.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-corehttp-1.0.0b3.dist-info/top_level.txt,sha256=NAGJ-rIA_vW2ZJghxC5NqIbnfrXDBMmE-TAd-9ud4i4,9
-corehttp-1.0.0b3.dist-info/RECORD,,
+corehttp/utils/_utils.py,sha256=TN2IplPve8b6xJPMvIVE-2oF3u_SK89XtYmCb70UDr4,6063
+corehttp-1.0.0b5.dist-info/LICENSE,sha256=_VMkgdgo4ToLE8y1mOAjOKNhd0BnWoYu5r3BVBto6T0,1073
+corehttp-1.0.0b5.dist-info/METADATA,sha256=aTKL6zrEYPPerCUAbEj_uhl07Ex2CsbndYBd3nwjShA,5363
+corehttp-1.0.0b5.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+corehttp-1.0.0b5.dist-info/top_level.txt,sha256=NAGJ-rIA_vW2ZJghxC5NqIbnfrXDBMmE-TAd-9ud4i4,9
+corehttp-1.0.0b5.dist-info/RECORD,,