X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/ef56ac56a0bac0710a486c0e5e9cdd3199eddc61..62e3f155b14b30fde1323a367351c70b23f312b8:/sdk/python/arvados/api.py diff --git a/sdk/python/arvados/api.py b/sdk/python/arvados/api.py index c618fc3c66..cf1c29be2d 100644 --- a/sdk/python/arvados/api.py +++ b/sdk/python/arvados/api.py @@ -13,7 +13,6 @@ import errors import util _logger = logging.getLogger('arvados.api') -conncache = {} class CredentialsFromToken(object): def __init__(self, api_token): @@ -80,11 +79,8 @@ def api(version=None, cache=True, host=None, token=None, insecure=False, **kwarg Arguments: * version: A string naming the version of the Arvados API to use (for example, 'v1'). - * cache: If True (default), return an existing Resources object if - one already exists with the same endpoint and credentials. If - False, create a new one, and do not keep it in the cache (i.e., - do not return it from subsequent api(cache=True) calls with - matching endpoint and credentials). + * cache: Use a cache (~/.cache/arvados/discovery) for the discovery + document. * host: The Arvados API server host (and optional :port) to connect to. * token: The authentication token to send with each API call. * insecure: If True, ignore SSL certificate validation errors. @@ -113,13 +109,7 @@ def api(version=None, cache=True, host=None, token=None, insecure=False, **kwarg elif host and token: pass elif not host and not token: - # Load from user configuration or environment - for x in ['ARVADOS_API_HOST', 'ARVADOS_API_TOKEN']: - if x not in config.settings(): - raise ValueError("%s is not set. Aborting." % x) - host = config.get('ARVADOS_API_HOST') - token = config.get('ARVADOS_API_TOKEN') - insecure = config.flag_is_true('ARVADOS_API_HOST_INSECURE') + return api_from_config(version=version, cache=cache, **kwargs) else: # Caller provided one but not the other if not host: @@ -132,12 +122,6 @@ def api(version=None, cache=True, host=None, token=None, insecure=False, **kwarg kwargs['discoveryServiceUrl'] = ( 'https://%s/discovery/v1/apis/{api}/{apiVersion}/rest' % (host,)) - if cache: - connprofile = (version, host, token, insecure) - svc = conncache.get(connprofile) - if svc: - return svc - if 'http' not in kwargs: http_kwargs = {} # Prefer system's CA certificates (if available) over httplib2's. @@ -156,6 +140,37 @@ def api(version=None, cache=True, host=None, token=None, insecure=False, **kwarg svc = apiclient_discovery.build('arvados', version, **kwargs) svc.api_token = token kwargs['http'].cache = None - if cache: - conncache[connprofile] = svc return svc + +def api_from_config(version=None, apiconfig=None, **kwargs): + """Return an apiclient Resources object enabling access to an Arvados server + instance. + + :version: + A string naming the version of the Arvados REST API to use (for + example, 'v1'). + + :cache: + Use a cache (~/.cache/arvados/discovery) for the discovery + document. + + :apiconfig: + If provided, this should be a dict-like object (must support the get() + method) with entries for ARVADOS_API_HOST, ARVADOS_API_TOKEN, and + optionally ARVADOS_API_HOST_INSECURE. If not provided, use + arvados.config (which gets these parameters from the environment by + default.) + + """ + # Load from user configuration or environment + if apiconfig is None: + apiconfig = config.settings() + + for x in ['ARVADOS_API_HOST', 'ARVADOS_API_TOKEN']: + if x not in apiconfig: + raise ValueError("%s is not set. Aborting." % x) + host = apiconfig.get('ARVADOS_API_HOST') + token = apiconfig.get('ARVADOS_API_TOKEN') + insecure = config.flag_is_true('ARVADOS_API_HOST_INSECURE', apiconfig) + + return api(version=version, host=host, token=token, insecure=insecure, **kwargs)