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

corehttp/_version.py

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

corehttp/credentials.py

@@ -5,38 +5,74 @@
 # -------------------------------------------------------------------------
 from __future__ import annotations
 from types import TracebackType
-from typing import Any, NamedTuple, Optional, AsyncContextManager, Type
+from typing import NamedTuple, Optional, AsyncContextManager, Type, TypedDict, ContextManager
 from typing_extensions import Protocol, runtime_checkable
 
 
-class AccessToken(NamedTuple):
-    """Represents an OAuth access token."""
+class AccessTokenInfo:
+    """Information about an OAuth access token.
+
+    :param str token: The token string.
+    :param int expires_on: The token's expiration time in Unix time.
+    :keyword str token_type: The type of access token. Defaults to 'Bearer'.
+    :keyword int refresh_on: Specifies the time, in Unix time, when the cached token should be proactively
+        refreshed. Optional.
+    """
 
     token: str
+    """The token string."""
     expires_on: int
+    """The token's expiration time in Unix time."""
+    token_type: str
+    """The type of access token."""
+    refresh_on: Optional[int]
+    """Specifies the time, in Unix time, when the cached token should be proactively refreshed. Optional."""
+
+    def __init__(
+        self, token: str, expires_on: int, *, token_type: str = "Bearer", refresh_on: Optional[int] = None
+    ) -> None:
+        self.token = token
+        self.expires_on = expires_on
+        self.token_type = token_type
+        self.refresh_on = refresh_on
 
+    def __repr__(self) -> str:
+        return "AccessTokenInfo(token='{}', expires_on={}, token_type='{}', refresh_on={})".format(
+            self.token, self.expires_on, self.token_type, self.refresh_on
+        )
 
-AccessToken.token.__doc__ = """The token string."""
-AccessToken.expires_on.__doc__ = """The token's expiration time in Unix time."""
 
+class TokenRequestOptions(TypedDict, total=False):
+    """Options to use for access token requests. All parameters are optional."""
 
-@runtime_checkable
-class TokenCredential(Protocol):
-    """Protocol for classes able to provide OAuth tokens."""
+    claims: str
+    """Additional claims required in the token, such as those returned in a resource provider's claims
+    challenge following an authorization failure."""
+    tenant_id: str
+    """The tenant ID to include in the token request."""
+
+
+class TokenCredential(Protocol, ContextManager["TokenCredential"]):
+    """Protocol for classes able to provide OAuth access tokens."""
 
-    def get_token(self, *scopes: str, claims: Optional[str] = None, **kwargs: Any) -> AccessToken:
+    def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] = None) -> AccessTokenInfo:
         """Request an access token for `scopes`.
 
         :param str scopes: The type of access needed.
+        :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
+        :paramtype options: TokenRequestOptions
 
-        :keyword str claims: Additional claims required in the token, such as those returned in a resource
-            provider's claims challenge following an authorization failure.
+        :rtype: AccessTokenInfo
+        :return: An AccessTokenInfo instance containing information about the token.
+        """
+        ...
 
+    def close(self) -> None:
+        """Close the credential, releasing any resources it holds.
 
-        :rtype: AccessToken
-        :return: An AccessToken instance containing the token string and its expiration time in Unix time.
+        :return: None
+        :rtype: None
         """
-        ...
 
 
 class ServiceNamedKey(NamedTuple):
@@ -47,10 +83,11 @@ class ServiceNamedKey(NamedTuple):
 
 
 __all__ = [
-    "AccessToken",
+    "AccessTokenInfo",
     "ServiceKeyCredential",
     "ServiceNamedKeyCredential",
     "TokenCredential",
+    "TokenRequestOptions",
     "AsyncTokenCredential",
 ]
 
@@ -60,7 +97,7 @@ class ServiceKeyCredential:
     It provides the ability to update the key without creating a new client.
 
     :param str key: The key used to authenticate to a service
-    :raises: TypeError
+    :raises TypeError: If the key is not a string.
     """
 
     def __init__(self, key: str) -> None:
@@ -84,7 +121,8 @@ class ServiceKeyCredential:
         to update long-lived clients.
 
         :param str key: The key used to authenticate to a service
-        :raises: ValueError or TypeError
+        :raises ValueError: If the key is None or empty.
+        :raises TypeError: If the key is not a string.
         """
         if not key:
             raise ValueError("The key used for updating can not be None or empty")
@@ -99,7 +137,7 @@ class ServiceNamedKeyCredential:
 
     :param str name: The name of the credential used to authenticate to a service.
     :param str key: The key used to authenticate to a service.
-    :raises: TypeError
+    :raises TypeError: If the name or key is not a string.
     """
 
     def __init__(self, name: str, key: str) -> None:
@@ -134,21 +172,24 @@ class ServiceNamedKeyCredential:
 class AsyncTokenCredential(Protocol, AsyncContextManager["AsyncTokenCredential"]):
     """Protocol for classes able to provide OAuth tokens."""
 
-    async def get_token(self, *scopes: str, claims: Optional[str] = None, **kwargs: Any) -> AccessToken:
+    async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] = None) -> AccessTokenInfo:
         """Request an access token for `scopes`.
 
         :param str scopes: The type of access needed.
+        :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
+        :paramtype options: TokenRequestOptions
 
-        :keyword str claims: Additional claims required in the token, such as those returned in a resource
-            provider's claims challenge following an authorization failure.
-
-        :rtype: AccessToken
-        :return: An AccessToken instance containing the token string and its expiration time in Unix time.
+        :rtype: AccessTokenInfo
+        :return: An AccessTokenInfo instance containing the token string and its expiration time in Unix time.
         """
         ...
 
     async def close(self) -> None:
-        pass
+        """Close the credential, releasing any resources.
+
+        :return: None
+        :rtype: None
+        """
 
     async def __aexit__(
         self,

corehttp/exceptions.py

@@ -72,15 +72,12 @@ class _HttpResponseCommonAPI(Protocol):
     """
 
     @property
-    def reason(self) -> Optional[str]:
-        ...
+    def reason(self) -> Optional[str]: ...
 
     @property
-    def status_code(self) -> Optional[int]:
-        ...
+    def status_code(self) -> Optional[int]: ...
 
-    def text(self) -> str:
-        ...
+    def text(self) -> str: ...
 
     @property
     def request(self) -> object:  # object as type, since all we need is str() on it
@@ -190,6 +187,8 @@ class HttpResponseError(BaseError):
     :vartype status_code: int
     :ivar response: The response that triggered the exception.
     :vartype response: ~corehttp.rest.HttpResponse or ~corehttp.rest.AsyncHttpResponse
+    :ivar model: The response body model
+    :vartype model: Any
     """
 
     def __init__(
@@ -203,6 +202,8 @@ class HttpResponseError(BaseError):
             self.reason = response.reason
             self.status_code = response.status_code
 
+        self.model: Optional[Any] = kwargs.pop("model", None)
+
         # By priority, message is:
         # - parameter "message", OR
         # - generic message using "reason"

corehttp/instrumentation/__init__.py

@@ -0,0 +1,9 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+from .tracing._tracer import get_tracer
+
+__all__ = [
+    "get_tracer",
+]

corehttp/instrumentation/tracing/__init__.py

@@ -0,0 +1,14 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+from ._models import SpanKind, Link, TracingOptions
+from ._decorator import distributed_trace, distributed_trace_async
+
+__all__ = [
+    "Link",
+    "SpanKind",
+    "TracingOptions",
+    "distributed_trace",
+    "distributed_trace_async",
+]

corehttp/instrumentation/tracing/_decorator.py

@@ -0,0 +1,189 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+"""The decorator to apply if you want the given method traced."""
+from contextvars import ContextVar
+import functools
+from typing import Awaitable, Any, TypeVar, overload, Optional, Callable, TYPE_CHECKING
+from typing_extensions import ParamSpec
+
+from ._models import SpanKind
+from ._tracer import get_tracer
+from ...settings import settings
+
+if TYPE_CHECKING:
+    from ._models import TracingOptions
+
+
+P = ParamSpec("P")
+T = TypeVar("T")
+
+
+# This context variable is used to determine if we are already in the span context of a decorated function.
+_in_span_context = ContextVar("in_span_context", default=False)
+
+
+@overload
+def distributed_trace(__func: Callable[P, T]) -> Callable[P, T]:
+    pass
+
+
+@overload
+def distributed_trace(**kwargs: Any) -> Callable[[Callable[P, T]], Callable[P, T]]:
+    pass
+
+
+def distributed_trace(__func: Optional[Callable[P, T]] = None, **kwargs: Any) -> Any:  # pylint: disable=unused-argument
+    """Decorator to apply to an SDK method to have it traced automatically.
+
+    Span will use the method's qualified name.
+
+    Note: This decorator SHOULD NOT be used by application developers. It's intended to be called by client
+    libraries only. Application developers should use OpenTelemetry directly to instrument their applications.
+
+    :param callable __func: A function to decorate
+
+    :return: The decorated function
+    :rtype: Any
+    """
+
+    def decorator(func: Callable[P, T]) -> Callable[P, T]:
+
+        @functools.wraps(func)
+        def wrapper_use_tracer(*args: Any, **kwargs: Any) -> T:
+            # If we are already in the span context of a decorated function, don't trace.
+            if _in_span_context.get():
+                return func(*args, **kwargs)
+
+            # This will be popped in the pipeline or transport runner.
+            tracing_options: TracingOptions = kwargs.get("tracing_options", {})
+
+            # User can explicitly disable tracing for this call
+            user_enabled = tracing_options.get("enabled")
+            if user_enabled is False:
+                return func(*args, **kwargs)
+
+            # If tracing is disabled globally and user didn't explicitly enable it, don't trace.
+            if not settings.tracing_enabled and user_enabled is None:
+                return func(*args, **kwargs)
+
+            config = {}
+            if args and hasattr(args[0], "_instrumentation_config"):
+                config = args[0]._instrumentation_config  # pylint: disable=protected-access
+
+            method_tracer = get_tracer(
+                library_name=config.get("library_name"),
+                library_version=config.get("library_version"),
+                schema_url=config.get("schema_url"),
+                attributes=config.get("attributes"),
+            )
+            if not method_tracer:
+                return func(*args, **kwargs)
+
+            name = func.__qualname__
+            span_suppression_token = _in_span_context.set(True)
+            try:
+                with method_tracer.start_as_current_span(
+                    name=name,
+                    kind=SpanKind.INTERNAL,
+                    attributes=tracing_options.get("attributes"),
+                ) as span:
+                    try:
+                        return func(*args, **kwargs)
+                    except Exception as err:  # pylint: disable=broad-except
+                        ex_type = type(err)
+                        module = ex_type.__module__ if ex_type.__module__ != "builtins" else ""
+                        error_type = f"{module}.{ex_type.__qualname__}" if module else ex_type.__qualname__
+                        span.set_attribute("error.type", error_type)
+                        raise
+            finally:
+                _in_span_context.reset(span_suppression_token)
+
+        return wrapper_use_tracer
+
+    return decorator if __func is None else decorator(__func)
+
+
+@overload
+def distributed_trace_async(__func: Callable[P, Awaitable[T]]) -> Callable[P, Awaitable[T]]:
+    pass
+
+
+@overload
+def distributed_trace_async(**kwargs: Any) -> Callable[[Callable[P, Awaitable[T]]], Callable[P, Awaitable[T]]]:
+    pass
+
+
+def distributed_trace_async(  # pylint: disable=unused-argument
+    __func: Optional[Callable[P, Awaitable[T]]] = None,
+    **kwargs: Any,
+) -> Any:
+    """Decorator to apply to an SDK method to have it traced automatically.
+
+    Span will use the method's qualified name.
+
+    Note: This decorator SHOULD NOT be used by application developers. It's intended to be called by client
+    libraries only. Application developers should use OpenTelemetry directly to instrument their applications.
+
+    :param callable __func: A function to decorate
+
+    :return: The decorated function
+    :rtype: Any
+    """
+
+    def decorator(func: Callable[P, Awaitable[T]]) -> Callable[P, Awaitable[T]]:
+
+        @functools.wraps(func)
+        async def wrapper_use_tracer(*args: Any, **kwargs: Any) -> T:
+            # If we are already in the span context of a decorated function, don't trace.
+            if _in_span_context.get():
+                return await func(*args, **kwargs)
+
+            # This will be popped in the pipeline or transport runner.
+            tracing_options: TracingOptions = kwargs.get("tracing_options", {})
+
+            # User can explicitly disable tracing for this call
+            user_enabled = tracing_options.get("enabled")
+            if user_enabled is False:
+                return await func(*args, **kwargs)
+
+            # If tracing is disabled globally and user didn't explicitly enable it, don't trace.
+            if not settings.tracing_enabled and user_enabled is None:
+                return await func(*args, **kwargs)
+
+            config = {}
+            if args and hasattr(args[0], "_instrumentation_config"):
+                config = args[0]._instrumentation_config  # pylint: disable=protected-access
+
+            method_tracer = get_tracer(
+                library_name=config.get("library_name"),
+                library_version=config.get("library_version"),
+                schema_url=config.get("schema_url"),
+                attributes=config.get("attributes"),
+            )
+            if not method_tracer:
+                return await func(*args, **kwargs)
+
+            name = func.__qualname__
+            span_suppression_token = _in_span_context.set(True)
+            try:
+                with method_tracer.start_as_current_span(
+                    name=name,
+                    kind=SpanKind.INTERNAL,
+                    attributes=tracing_options.get("attributes"),
+                ) as span:
+                    try:
+                        return await func(*args, **kwargs)
+                    except Exception as err:  # pylint: disable=broad-except
+                        ex_type = type(err)
+                        module = ex_type.__module__ if ex_type.__module__ != "builtins" else ""
+                        error_type = f"{module}.{ex_type.__qualname__}" if module else ex_type.__qualname__
+                        span.set_attribute("error.type", error_type)
+                        raise
+            finally:
+                _in_span_context.reset(span_suppression_token)
+
+        return wrapper_use_tracer
+
+    return decorator if __func is None else decorator(__func)

corehttp/instrumentation/tracing/_models.py

@@ -0,0 +1,72 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+from __future__ import annotations
+from enum import Enum
+from typing import Dict, Mapping, Optional, Union, Sequence, TypedDict
+
+from ...utils import CaseInsensitiveEnumMeta
+
+
+AttributeValue = Union[
+    str,
+    bool,
+    int,
+    float,
+    Sequence[str],
+    Sequence[bool],
+    Sequence[int],
+    Sequence[float],
+]
+Attributes = Mapping[str, AttributeValue]
+
+
+class SpanKind(Enum, metaclass=CaseInsensitiveEnumMeta):
+    """Describes the role or kind of a span within a distributed trace.
+
+    This helps to categorize spans based on their relationship to other spans and the type
+    of operation they represent.
+    """
+
+    UNSPECIFIED = 1
+    """Unspecified span kind."""
+
+    SERVER = 2
+    """Indicates that the span describes an operation that handles a remote request."""
+
+    CLIENT = 3
+    """Indicates that the span describes a request to some remote service."""
+
+    PRODUCER = 4
+    """Indicates that the span describes the initiation or scheduling of a local or remote operation."""
+
+    CONSUMER = 5
+    """Indicates that the span represents the processing of an operation initiated by a producer."""
+
+    INTERNAL = 6
+    """Indicates that the span is used internally in the application."""
+
+
+class Link:
+    """Represents a reference from one span to another span.
+
+    :param headers: A dictionary of the request header as key value pairs.
+    :type headers: dict
+    :param attributes: Any additional attributes that should be added to link
+    :type attributes: dict
+    """
+
+    def __init__(self, headers: Dict[str, str], attributes: Optional[Attributes] = None) -> None:
+        self.headers = headers
+        self.attributes = attributes
+
+
+class TracingOptions(TypedDict, total=False):
+    """Options to configure tracing behavior for operations."""
+
+    enabled: bool
+    """Whether tracing is enabled for the operation. By default, if the global setting is enabled, tracing is
+    enabled for all operations. This option can be used to override the global setting for a specific operation."""
+    attributes: Attributes
+    """Attributes to include in the spans emitted for the operation."""

corehttp/instrumentation/tracing/_tracer.py

@@ -0,0 +1,69 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+from typing import Optional, Union, Mapping, TYPE_CHECKING
+from functools import lru_cache
+
+if TYPE_CHECKING:
+    try:
+        from .opentelemetry import OpenTelemetryTracer
+    except ImportError:
+        pass
+
+
+def _get_tracer_impl():
+    # Check if OpenTelemetry is available/installed.
+    try:
+        from .opentelemetry import OpenTelemetryTracer
+
+        return OpenTelemetryTracer
+    except ImportError:
+        return None
+
+
+@lru_cache
+def _get_tracer_cached(
+    library_name: Optional[str],
+    library_version: Optional[str],
+    schema_url: Optional[str],
+    attributes_key: Optional[frozenset],
+) -> Optional["OpenTelemetryTracer"]:
+    tracer_impl = _get_tracer_impl()
+    if tracer_impl:
+        # Convert attributes_key back to dict if needed
+        attributes = dict(attributes_key) if attributes_key else None
+        return tracer_impl(
+            library_name=library_name,
+            library_version=library_version,
+            schema_url=schema_url,
+            attributes=attributes,
+        )
+    return None
+
+
+def get_tracer(
+    *,
+    library_name: Optional[str] = None,
+    library_version: Optional[str] = None,
+    schema_url: Optional[str] = None,
+    attributes: Optional[Mapping[str, Union[str, bool, int, float]]] = None,
+) -> Optional["OpenTelemetryTracer"]:
+    """Get the OpenTelemetry tracer instance if available.
+
+    If OpenTelemetry is not available, this method will return None. This method caches
+    the tracer instance for each unique set of parameters.
+
+    :keyword library_name: The name of the library to use in the tracer.
+    :paramtype library_name: str
+    :keyword library_version: The version of the library to use in the tracer.
+    :paramtype library_version: str
+    :keyword schema_url: Specifies the Schema URL of the emitted spans.
+    :paramtype schema_url: str
+    :keyword attributes: Attributes to add to the emitted spans.
+    :paramtype attributes: Mapping[str, Union[str, bool, int, float]]
+    :return: The OpenTelemetry tracer instance if available.
+    :rtype: Optional[~corehttp.instrumentation.tracing.opentelemetry.OpenTelemetryTracer]
+    """
+    attributes_key = frozenset(attributes.items()) if attributes else None
+    return _get_tracer_cached(library_name, library_version, schema_url, attributes_key)