py2docfx 0.1.16.dev2052678__py3-none-any.whl → 0.1.16.dev2064350__py3-none-any.whl

py2docfx/venv/venv1/Lib/site-packages/azure/core/tracing/_abstract_span.py

@@ -4,12 +4,10 @@
 # ------------------------------------
 """Protocol that defines what functions wrappers of tracing libraries should implement."""
 from __future__ import annotations
-from enum import Enum
 from urllib.parse import urlparse
 
 from typing import (
     Any,
-    Sequence,
     Optional,
     Union,
     Callable,
@@ -26,33 +24,16 @@ from azure.core.rest import (
     AsyncHttpResponse as AsyncRestHttpResponse,
     HttpRequest as RestHttpRequest,
 )
+from ._models import AttributeValue, SpanKind
+
 
 HttpResponseType = Union[HttpResponse, AsyncHttpResponse, RestHttpResponse, AsyncRestHttpResponse]
 HttpRequestType = Union[HttpRequest, RestHttpRequest]
 
-AttributeValue = Union[
-    str,
-    bool,
-    int,
-    float,
-    Sequence[str],
-    Sequence[bool],
-    Sequence[int],
-    Sequence[float],
-]
 Attributes = Dict[str, AttributeValue]
 SpanType = TypeVar("SpanType")
 
 
-class SpanKind(Enum):
-    UNSPECIFIED = 1
-    SERVER = 2
-    CLIENT = 3
-    PRODUCER = 4
-    CONSUMER = 5
-    INTERNAL = 6
-
-
 @runtime_checkable
 class AbstractSpan(Protocol, Generic[SpanType]):
     """Wraps a span from a distributed tracing implementation.
@@ -305,17 +286,3 @@ class HttpSpanMixin:
         else:
             self.add_attribute(HttpSpanMixin._HTTP_STATUS_CODE, 504)
             self.add_attribute(HttpSpanMixin._ERROR_TYPE, "504")
-
-
-class Link:
-    """
-    This is a wrapper class to link the context to the current tracer.
-    :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

py2docfx/venv/venv1/Lib/site-packages/azure/core/tracing/_models.py

@@ -0,0 +1,71 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+from enum import Enum
+from typing import Dict, Mapping, Optional, Union, Sequence, TypedDict
+
+from .._enum_meta 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."""

py2docfx/venv/venv1/Lib/site-packages/azure/core/tracing/common.py

@@ -29,6 +29,7 @@ from typing import Any, Optional, Callable, Type, Generator
 import warnings
 
 from ._abstract_span import AbstractSpan
+from ..instrumentation import get_tracer
 from ..settings import settings
 
 
@@ -72,10 +73,11 @@ def change_context(span: Optional[AbstractSpan]) -> Generator:
     :rtype: contextmanager
     :return: A context manager that will run the given span in the new context
     """
-    span_impl_type: Optional[Type[AbstractSpan]] = settings.tracing_implementation()
+    span_impl_type = settings.tracing_implementation()
     if span_impl_type is None or span is None:
         yield
     else:
+
         try:
             with span_impl_type.change_context(span):
                 yield
@@ -101,8 +103,14 @@ def with_current_context(func: Callable) -> Any:
     :return: The func wrapped with correct context
     :rtype: callable
     """
-    span_impl_type: Optional[Type[AbstractSpan]] = settings.tracing_implementation()
-    if span_impl_type is None:
+    if not settings.tracing_enabled():
         return func
 
-    return span_impl_type.with_current_context(func)
+    span_impl_type: Optional[Type[AbstractSpan]] = settings.tracing_implementation()
+    if span_impl_type:
+        return span_impl_type.with_current_context(func)
+
+    tracer = get_tracer()
+    if not tracer:
+        return func
+    return tracer.with_current_context(func)

py2docfx/venv/venv1/Lib/site-packages/azure/core/tracing/decorator.py

@@ -24,22 +24,28 @@
 #
 # --------------------------------------------------------------------------
 """The decorator to apply if you want the given function traced."""
-
+from contextvars import ContextVar
 import functools
 
 from typing import Callable, Any, TypeVar, overload, Optional, Mapping, TYPE_CHECKING
 from typing_extensions import ParamSpec
-from .common import change_context, get_function_and_class_name
-from . import SpanKind as _SpanKind
+from .common import change_context
 from ..settings import settings
+from ..instrumentation import get_tracer as _get_tracer
+from ._models import SpanKind as _SpanKind
 
 if TYPE_CHECKING:
-    from azure.core.tracing import SpanKind
+    from azure.core.tracing import TracingOptions, SpanKind
+
 
 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
@@ -97,24 +103,71 @@ def distributed_trace(
             merge_span = kwargs.pop("merge_span", False)
             passed_in_parent = kwargs.pop("parent_span", None)
 
-            # Assume this will be popped in DistributedTracingPolicy.
-            func_tracing_attributes = kwargs.pop("tracing_attributes", tracing_attributes)
+            # If we are already in the span context of a decorated function, don't trace.
+            if _in_span_context.get():
+                return func(*args, **kwargs)
 
-            span_impl_type = settings.tracing_implementation()
-            if span_impl_type is None:
+            # This will be popped in the pipeline or transport runner.
+            tracing_options: TracingOptions = kwargs.get("tracing_options", {})
+            tracing_enabled = settings.tracing_enabled()
+
+            # User can explicitly disable tracing for this request.
+            user_enabled = tracing_options.get("enabled")
+
+            # If tracing is disabled globally and user didn't explicitly enable it, don't trace.
+            if user_enabled is False or (not tracing_enabled and user_enabled is None):
                 return func(*args, **kwargs)
 
             # Merge span is parameter is set, but only if no explicit parent are passed
             if merge_span and not passed_in_parent:
                 return func(*args, **kwargs)
 
-            with change_context(passed_in_parent):
-                name = name_of_span or get_function_and_class_name(func, *args)
-                with span_impl_type(name=name, kind=kind) as span:
-                    for key, value in func_tracing_attributes.items():
-                        span.add_attribute(key, value)
+            # Assume this will be popped in DistributedTracingPolicy.
+            func_tracing_attributes = kwargs.get("tracing_attributes", tracing_attributes)
+            span_attributes = {**func_tracing_attributes, **tracing_options.get("attributes", {})}
+
+            span_impl_type = settings.tracing_implementation()
+
+            name = name_of_span or func.__qualname__
+            if span_impl_type:
+                # Plugin path
+                with change_context(passed_in_parent):
+                    with span_impl_type(name=name, kind=kind) as span:
+                        for key, value in span_attributes.items():
+                            span.add_attribute(key, value)  # type: ignore
+                        return func(*args, **kwargs)
+            else:
+                # Native path
+                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)
 
+                span_suppression_token = _in_span_context.set(True)
+                try:
+                    with method_tracer.start_as_current_span(
+                        name=name,
+                        kind=kind,
+                        attributes=span_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)

py2docfx/venv/venv1/Lib/site-packages/azure/core/tracing/decorator_async.py

@@ -24,31 +24,28 @@
 #
 # --------------------------------------------------------------------------
 """The decorator to apply if you want the given function traced."""
-
+from contextvars import ContextVar
 import functools
 
-from typing import (
-    Awaitable,
-    Callable,
-    Any,
-    TypeVar,
-    overload,
-    Optional,
-    Mapping,
-    TYPE_CHECKING,
-)
+from typing import Awaitable, Callable, Any, TypeVar, overload, Optional, Mapping, TYPE_CHECKING
 from typing_extensions import ParamSpec
-from .common import change_context, get_function_and_class_name
-from . import SpanKind as _SpanKind
+from .common import change_context
+from ._models import SpanKind as _SpanKind
+from ..instrumentation import get_tracer as _get_tracer
 from ..settings import settings
 
 if TYPE_CHECKING:
-    from azure.core.tracing import SpanKind
+    from azure.core.tracing import TracingOptions, SpanKind
+
 
 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_async(__func: Callable[P, Awaitable[T]]) -> Callable[P, Awaitable[T]]:
     pass
@@ -106,24 +103,66 @@ def distributed_trace_async(  # pylint: disable=unused-argument
             merge_span = kwargs.pop("merge_span", False)
             passed_in_parent = kwargs.pop("parent_span", None)
 
-            # Assume this will be popped in DistributedTracingPolicy.
-            func_tracing_attributes = kwargs.get("tracing_attributes", tracing_attributes)
+            # 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)
 
-            span_impl_type = settings.tracing_implementation()
-            if span_impl_type is None:
+            # This will be popped in the pipeline or transport runner.
+            tracing_options: TracingOptions = kwargs.get("tracing_options", {})
+            tracing_enabled = settings.tracing_enabled()
+
+            # User can explicitly disable tracing for this request.
+            user_enabled = tracing_options.get("enabled")
+
+            # If tracing is disabled globally and user didn't explicitly enable it, don't trace.
+            if user_enabled is False or (not tracing_enabled and user_enabled is None):
                 return await func(*args, **kwargs)
 
             # Merge span is parameter is set, but only if no explicit parent are passed
             if merge_span and not passed_in_parent:
                 return await func(*args, **kwargs)
 
-            with change_context(passed_in_parent):
-                name = name_of_span or get_function_and_class_name(func, *args)
-                with span_impl_type(name=name, kind=kind) as span:
-                    for key, value in func_tracing_attributes.items():
-                        span.add_attribute(key, value)
+            # Assume this will be popped in DistributedTracingPolicy.
+            func_tracing_attributes = kwargs.get("tracing_attributes", tracing_attributes)
+            span_attributes = {**func_tracing_attributes, **tracing_options.get("attributes", {})}
+
+            span_impl_type = settings.tracing_implementation()
+
+            name = name_of_span or func.__qualname__
+            if span_impl_type:
+                # Plugin path
+                with change_context(passed_in_parent):
+                    with span_impl_type(name=name, kind=kind) as span:
+                        for key, value in span_attributes.items():
+                            span.add_attribute(key, value)  # type: ignore
+                        return await func(*args, **kwargs)
+            else:
+                # Native path
+                config = {}
+                if args and hasattr(args[0], "_instrumentation_config"):
+                    config = args[0]._instrumentation_config  # pylint: disable=protected-access
+                method_tracer = _get_tracer(**config)
+                if not method_tracer:
                     return await func(*args, **kwargs)
 
+                span_suppression_token = _in_span_context.set(True)
+                try:
+                    with method_tracer.start_as_current_span(
+                        name=name,
+                        kind=kind,
+                        attributes=span_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)

py2docfx/venv/venv1/Lib/site-packages/azure/core/tracing/opentelemetry.py

@@ -0,0 +1,244 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+from __future__ import annotations
+from contextlib import contextmanager
+from contextvars import Token
+from typing import Optional, Dict, Sequence, cast, Callable, Iterator, TYPE_CHECKING
+
+from opentelemetry import context as otel_context_module, trace
+from opentelemetry.trace import (
+    Span,
+    SpanKind as OpenTelemetrySpanKind,
+    Link as OpenTelemetryLink,
+)
+from opentelemetry.trace.propagation import get_current_span as get_current_span_otel
+from opentelemetry.propagate import extract, inject
+
+try:
+    from opentelemetry.context import _SUPPRESS_HTTP_INSTRUMENTATION_KEY  # type: ignore[attr-defined]
+except ImportError:
+    _SUPPRESS_HTTP_INSTRUMENTATION_KEY = "suppress_http_instrumentation"
+
+from .._version import VERSION
+from ._models import (
+    Attributes,
+    SpanKind as _SpanKind,
+)
+
+if TYPE_CHECKING:
+    from azure.core.tracing import Link, SpanKind
+
+
+_DEFAULT_SCHEMA_URL = "https://opentelemetry.io/schemas/1.23.1"
+_DEFAULT_MODULE_NAME = "azure-core"
+
+_KIND_MAPPINGS = {
+    _SpanKind.CLIENT: OpenTelemetrySpanKind.CLIENT,
+    _SpanKind.CONSUMER: OpenTelemetrySpanKind.CONSUMER,
+    _SpanKind.PRODUCER: OpenTelemetrySpanKind.PRODUCER,
+    _SpanKind.SERVER: OpenTelemetrySpanKind.SERVER,
+    _SpanKind.INTERNAL: OpenTelemetrySpanKind.INTERNAL,
+    _SpanKind.UNSPECIFIED: OpenTelemetrySpanKind.INTERNAL,
+}
+
+
+class OpenTelemetryTracer:
+    """A tracer that uses OpenTelemetry to trace operations.
+
+    :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. Defaults to
+        "https://opentelemetry.io/schemas/1.23.1".
+    :paramtype schema_url: str
+    :keyword attributes: Attributes to add to the emitted spans.
+    :paramtype attributes: Mapping[str, AttributeValue]
+    """
+
+    def __init__(
+        self,
+        *,
+        library_name: Optional[str] = None,
+        library_version: Optional[str] = None,
+        schema_url: Optional[str] = None,
+        attributes: Optional[Attributes] = None,
+    ) -> None:
+        self._tracer = trace.get_tracer(
+            instrumenting_module_name=library_name or _DEFAULT_MODULE_NAME,
+            instrumenting_library_version=library_version or VERSION,
+            schema_url=schema_url or _DEFAULT_SCHEMA_URL,
+            attributes=attributes,
+        )
+
+    def start_span(
+        self,
+        name: str,
+        *,
+        kind: SpanKind = _SpanKind.INTERNAL,
+        attributes: Optional[Attributes] = None,
+        links: Optional[Sequence[Link]] = None,
+    ) -> Span:
+        """Starts a span without setting it as the current span in the context.
+
+        :param name: The name of the span
+        :type name: str
+        :keyword kind: The kind of the span. INTERNAL by default.
+        :paramtype kind: ~azure.core.tracing.SpanKind
+        :keyword attributes: Attributes to add to the span.
+        :paramtype attributes: Mapping[str, AttributeValue]
+        :keyword links: Links to add to the span.
+        :paramtype links: list[~azure.core.tracing.Link]
+        :return: The span that was started
+        :rtype: ~azure.core.tracing.Span
+        """
+        otel_kind = _KIND_MAPPINGS.get(kind, OpenTelemetrySpanKind.INTERNAL)
+        otel_links = self._parse_links(links)
+
+        otel_span = self._tracer.start_span(
+            name,
+            kind=otel_kind,
+            attributes=attributes,
+            links=otel_links,
+            record_exception=False,
+        )
+
+        return otel_span
+
+    @contextmanager
+    def start_as_current_span(
+        self,
+        name: str,
+        *,
+        kind: SpanKind = _SpanKind.INTERNAL,
+        attributes: Optional[Attributes] = None,
+        links: Optional[Sequence[Link]] = None,
+        end_on_exit: bool = True,
+    ) -> Iterator[Span]:
+        """Context manager that starts a span and sets it as the current span in the context.
+
+        .. code:: python
+
+            with tracer.start_as_current_span("span_name") as span:
+                # Do something with the span
+                span.set_attribute("key", "value")
+
+        :param name: The name of the span
+        :type name: str
+        :keyword kind: The kind of the span. INTERNAL by default.
+        :paramtype kind: ~azure.core.tracing.SpanKind
+        :keyword attributes: Attributes to add to the span.
+        :paramtype attributes: Optional[Attributes]
+        :keyword links: Links to add to the span.
+        :paramtype links: Optional[Sequence[Link]]
+        :keyword end_on_exit: Whether to end the span when exiting the context manager. Defaults to True.
+        :paramtype end_on_exit: bool
+        :return: The span that was started
+        :rtype: Iterator[~opentelemetry.trace.Span]
+        """
+        span = self.start_span(name, kind=kind, attributes=attributes, links=links)
+        with trace.use_span(  # pylint: disable=not-context-manager
+            span, record_exception=False, end_on_exit=end_on_exit
+        ) as span:
+            yield span
+
+    @classmethod
+    @contextmanager
+    def use_span(cls, span: Span, *, end_on_exit: bool = True) -> Iterator[Span]:
+        """Context manager that takes a non-active span and activates it in the current context.
+
+        :param span: The span to set as the current span
+        :type span: ~opentelemetry.trace.Span
+        :keyword end_on_exit: Whether to end the span when exiting the context manager. Defaults to True.
+        :paramtype end_on_exit: bool
+        :return: The span that was activated.
+        :rtype: Iterator[~opentelemetry.trace.Span]
+        """
+        with trace.use_span(  # pylint: disable=not-context-manager
+            span, record_exception=False, end_on_exit=end_on_exit
+        ) as active_span:
+            yield active_span
+
+    def _parse_links(self, links: Optional[Sequence[Link]]) -> Optional[Sequence[OpenTelemetryLink]]:
+        if not links:
+            return None
+
+        try:
+            otel_links = []
+            for link in links:
+                ctx = extract(link.headers)
+                span_ctx = get_current_span_otel(ctx).get_span_context()
+                otel_links.append(OpenTelemetryLink(span_ctx, link.attributes))
+            return otel_links
+        except AttributeError:
+            # We will just send the links as is if it's not ~azure.core.tracing.Link without
+            # any validation assuming the user knows what they are doing.
+            return cast(Sequence[OpenTelemetryLink], links)
+
+    @classmethod
+    def get_current_span(cls) -> Span:
+        """Returns the current span in the context.
+
+        :return: The current span
+        :rtype: ~opentelemetry.trace.Span
+        """
+        return get_current_span_otel()
+
+    @classmethod
+    def with_current_context(cls, func: Callable) -> Callable:
+        """Passes the current spans to the new context the function will be run in.
+
+        :param func: The function that will be run in the new context
+        :type func: callable
+        :return: The wrapped function
+        :rtype: callable
+        """
+        current_context = otel_context_module.get_current()
+
+        def call_with_current_context(*args, **kwargs):
+            token = None
+            try:
+                token = otel_context_module.attach(current_context)
+                return func(*args, **kwargs)
+            finally:
+                if token is not None:
+                    otel_context_module.detach(token)
+
+        return call_with_current_context
+
+    @classmethod
+    def get_trace_context(cls) -> Dict[str, str]:
+        """Returns the Trace Context header values associated with the current span.
+
+        These are generally the W3C Trace Context headers (i.e. "traceparent" and "tracestate").
+
+        :return: A key value pair dictionary
+        :rtype: dict[str, str]
+        """
+        trace_context: Dict[str, str] = {}
+        inject(trace_context)
+        return trace_context
+
+    @classmethod
+    def _suppress_auto_http_instrumentation(cls) -> Token:
+        """Enabled automatic HTTP instrumentation suppression.
+
+        Since azure-core already instruments HTTP calls, we need to suppress any automatic HTTP
+        instrumentation provided by other libraries to prevent duplicate spans. This has no effect if no
+        automatic HTTP instrumentation libraries are being used.
+
+        :return: A token that can be used to detach the suppression key from the context
+        :rtype: ~contextvars.Token
+        """
+        return otel_context_module.attach(otel_context_module.set_value(_SUPPRESS_HTTP_INSTRUMENTATION_KEY, True))
+
+    @classmethod
+    def _detach_from_context(cls, token: Token) -> None:
+        """Detach a token from the context.
+
+        :param token: The token to detach
+        :type token: ~contextvars.Token
+        """
+        otel_context_module.detach(token)

py2docfx/venv/venv1/Lib/site-packages/azure/core/utils/_connection_string_parser.py

@@ -17,8 +17,7 @@ def parse_connection_string(conn_str: str, case_sensitive_keys: bool = False) ->
         default), all keys will be lower-cased. If set to `True`, the original casing of the keys will be preserved.
     :rtype: Mapping
     :returns: Dict of connection string key/value pairs.
-    :raises:
-        ValueError: if each key in conn_str does not have a corresponding value and
+    :raises ValueError: if each key in conn_str does not have a corresponding value and
             for other bad formatting of connection strings - including duplicate
             args, bad syntax, etc.
     """

py2docfx/venv/venv1/Lib/site-packages/azure/core/utils/_messaging_shared.py

@@ -22,7 +22,7 @@ def _get_json_content(obj):
     :type obj: any
     :return: The JSON content of the object.
     :rtype: dict
-    :raises ValueError if JSON content cannot be loaded from the object
+    :raises ValueError: if JSON content cannot be loaded from the object.
     """
     msg = "Failed to load JSON content from the object."
     try: