Class DWaveAPIClient

dwave/cloud/api/client.py:771–1061

Low-level client for D-Wave APIs. A thin wrapper around `requests.Session` that handles API specifics such as authentication, response and error parsing, retrying, etc. Note: To make sure the session is closed, call :meth:`.close`, or use the context manager form (as sho

class DWaveAPIClient:
    """Low-level client for D-Wave APIs. A thin wrapper around
    `requests.Session` that handles API specifics such as authentication,
    response and error parsing, retrying, etc.

    Note:
        To make sure the session is closed, call :meth:`.close`, or use the
        context manager form (as show in the example below).

    Note:
        Since :class:`requests.Session` is **not thread-safe**, neither is
        :class:`DWaveAPIClient`. It's best to create (and dispose) a new client
        on demand, in each thread.

    Example:
        >>> with DWaveAPIClient(endpoint='...', timeout=(5, 600)) as client:    # doctest: +SKIP
        ...     client.session.get('...')

    """

    class DefaultSession(VersionedAPISessionMixin,
                         DeprecationAwareSessionMixin,
                         PayloadCompressingSessionMixin,
                         BaseUrlSessionMixin,
                         CachingSessionMixin,
                         LoggingSessionMixin,
                         requests.Session):
        """Default session class is based on `requests.Session` extended with
        base url, logging, compressing, API versioning and caching mixins.
        """

    DEFAULTS = {
        'session_class': DefaultSession,

        'endpoint': None,
        'token': None,
        'cert': None,

        # (connect, read) timeout in sec
        'timeout': (60, 120),

        # urllib3.Retry options
        'retry': dict(total=10, backoff_factor=0.01, backoff_max=60),

        # optional additional headers
        'headers': None,

        # ssl verify
        'verify': True,

        # proxy urls, see :attr:`requests.Session.proxies`
        'proxies': None,

        # number of most recent request records to keep in :attr:`.session.history`
        'history_size': 0,

        # preemptive payload compression on upload requests, see :class:`PayloadCompressingSession`
        'compress': False,