Method _sapi_request

dwave/cloud/client/base.py:1887–1952

Execute an HTTP request defined with the ``meth`` callable and parse the response and interpret errors in compliance with SAPI REST interface. Note: For internal use only. Args: meth (callable): Callable object to be called wi

(meth, *args, **kwargs)

    @staticmethod
    def _sapi_request(meth, *args, **kwargs):
        """Execute an HTTP request defined with the ``meth`` callable and
        parse the response and interpret errors in compliance with SAPI REST
        interface.

        Note:
            For internal use only.

        Args:
            meth (callable):
                Callable object to be called with args and kwargs supplied, with
                expected behavior consistent with one of ``requests.Session()``
                request methods.

            *args, **kwargs (list, dict):
                Arguments to the ``meth`` callable.

        Returns:
            dict: JSON decoded body.

        Raises:
            A :class:`~dwave.cloud.exceptions.SAPIError` subclass, or
            :class:`~dwave.cloud.exceptions.RequestTimeout`.
        """

        # execute request
        try:
            response = meth(*args, **kwargs)
            # note: LoggingSessionMixin will wrap timeout exceptions as RequestTimeout
        except api.exceptions.ResourceBadResponseError as e:
            # returned by VersionedAPISessionMixin; wrap for backwards-compatibility
            raise InvalidAPIResponseError(e) from e

        # workaround for charset_normalizer episode in requests>=2.26.0,
        # where decoding of an empty json object '{}' fails.
        # see: https://github.com/psf/requests/issues/5871,
        # https://github.com/dwavesystems/dwave-cloud-client/pull/471, and
        # https://github.com/dwavesystems/dwave-cloud-client/pull/476.
        response.encoding = 'utf-8'

        # NOTE: the expected behavior is for SAPI to return JSON error on
        # failure. However, that is currently not the case. We need to work
        # around this until it's fixed.

        # no error -> body is json
        # error -> body can be json or plain text error message
        if response.ok:
            try:
                return orjson.loads(response.content)
            except:
                raise InvalidAPIResponseError("JSON response expected")

        else:
            if response.status_code == 401:
                raise SolverAuthenticationError(error_code=401)

            try:
                msg = orjson.loads(response.content)