4389: Merge branch 'master' into 4389-breadcrumbs-infinite-loop
[arvados.git] / sdk / python / arvados / api.py
index 1db694f762374c1ec93f9da12df272fca43caa3a..c618fc3c6623ef18e8663609340b55bcce219f78 100644 (file)
@@ -4,11 +4,10 @@ import logging
 import os
 import re
 import types
-import hashlib
 
 import apiclient
-import apiclient.discovery
-import apiclient.errors
+from apiclient import discovery as apiclient_discovery
+from apiclient import errors as apiclient_errors
 import config
 import errors
 import util
@@ -48,7 +47,7 @@ class CredentialsFromToken(object):
 
 # Monkey patch discovery._cast() so objects and arrays get serialized
 # with json.dumps() instead of str().
-_cast_orig = apiclient.discovery._cast
+_cast_orig = apiclient_discovery._cast
 def _cast_objects_too(value, schema_type):
     global _cast_orig
     if (type(value) != type('') and
@@ -56,16 +55,16 @@ def _cast_objects_too(value, schema_type):
         return json.dumps(value)
     else:
         return _cast_orig(value, schema_type)
-apiclient.discovery._cast = _cast_objects_too
+apiclient_discovery._cast = _cast_objects_too
 
 # Convert apiclient's HttpErrors into our own API error subclass for better
 # error reporting.
-# Reassigning apiclient.errors.HttpError is not sufficient because most of the
+# Reassigning apiclient_errors.HttpError is not sufficient because most of the
 # apiclient submodules import the class into their own namespace.
 def _new_http_error(cls, *args, **kwargs):
-    return super(apiclient.errors.HttpError, cls).__new__(
+    return super(apiclient_errors.HttpError, cls).__new__(
         errors.ApiError, *args, **kwargs)
-apiclient.errors.HttpError.__new__ = staticmethod(_new_http_error)
+apiclient_errors.HttpError.__new__ = staticmethod(_new_http_error)
 
 def http_cache(data_type):
     path = os.environ['HOME'] + '/.cache/arvados/' + data_type
@@ -91,7 +90,7 @@ def api(version=None, cache=True, host=None, token=None, insecure=False, **kwarg
     * insecure: If True, ignore SSL certificate validation errors.
 
     Additional keyword arguments will be passed directly to
-    `apiclient.discovery.build` if a new Resource object is created.
+    `apiclient_discovery.build` if a new Resource object is created.
     If the `discoveryServiceUrl` or `http` keyword arguments are
     missing, this function will set default values for them, based on
     the current Arvados configuration settings.
@@ -100,31 +99,41 @@ def api(version=None, cache=True, host=None, token=None, insecure=False, **kwarg
 
     if not version:
         version = 'v1'
-        logging.info("Using default API version. " +
+        _logger.info("Using default API version. " +
                      "Call arvados.api('%s') instead." %
                      version)
-    if host and token:
-        apiinsecure = insecure
+    if 'discoveryServiceUrl' in kwargs:
+        if host:
+            raise ValueError("both discoveryServiceUrl and host provided")
+        # Here we can't use a token from environment, config file,
+        # etc. Those probably have nothing to do with the host
+        # provided by the caller.
+        if not token:
+            raise ValueError("discoveryServiceUrl provided, but token missing")
+    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 Exception("%s is not set. Aborting." % x)
+                raise ValueError("%s is not set. Aborting." % x)
         host = config.get('ARVADOS_API_HOST')
         token = config.get('ARVADOS_API_TOKEN')
-        apiinsecure = (config.get('ARVADOS_API_HOST_INSECURE', '').lower() in
-                       ('yes', 'true', '1'))
+        insecure = config.flag_is_true('ARVADOS_API_HOST_INSECURE')
     else:
         # Caller provided one but not the other
         if not host:
-            raise Exception("token argument provided, but host missing.")
+            raise ValueError("token argument provided, but host missing.")
         else:
-            raise Exception("host argument provided, but token missing.")
+            raise ValueError("host argument provided, but token missing.")
+
+    if host:
+        # Caller wants us to build the discoveryServiceUrl
+        kwargs['discoveryServiceUrl'] = (
+            'https://%s/discovery/v1/apis/{api}/{apiVersion}/rest' % (host,))
 
     if cache:
-        connprofile = hashlib.sha1(' '.join([
-            version, host, token, ('y' if apiinsecure else 'n')
-        ])).hexdigest()
+        connprofile = (version, host, token, insecure)
         svc = conncache.get(connprofile)
         if svc:
             return svc
@@ -137,23 +146,16 @@ def api(version=None, cache=True, host=None, token=None, insecure=False, **kwarg
             http_kwargs['ca_certs'] = certs_path
         if cache:
             http_kwargs['cache'] = http_cache('discovery')
-        if apiinsecure:
+        if insecure:
             http_kwargs['disable_ssl_certificate_validation'] = True
         kwargs['http'] = httplib2.Http(**http_kwargs)
 
     credentials = CredentialsFromToken(api_token=token)
     kwargs['http'] = credentials.authorize(kwargs['http'])
 
-    if 'discoveryServiceUrl' not in kwargs:
-        kwargs['discoveryServiceUrl'] = (
-            'https://%s/discovery/v1/apis/{api}/{apiVersion}/rest' % (host,))
-
-    svc = apiclient.discovery.build('arvados', version, **kwargs)
+    svc = apiclient_discovery.build('arvados', version, **kwargs)
+    svc.api_token = token
     kwargs['http'].cache = None
     if cache:
         conncache[connprofile] = svc
     return svc
-
-def unload_connection_cache():
-    for connprofile in conncache:
-        del conncache[connprofile]