Merge branch '3296-user-profile' of git.curoverse.com:arvados into 3296-user-profile

[arvados.git] / sdk / python / arvados / api.py

diff --git a/sdk/python/arvados/api.py b/sdk/python/arvados/api.py
index 4413167c31ee2774129e70d0d78f1c545394d76f..8a71b90c0dda661ea0ac8bfbcd17e47cb1ee36b9 100644 (file)
--- a/sdk/python/arvados/api.py
+++ b/sdk/python/arvados/api.py
@@ -7,6 +7,7 @@ import types
 
 import apiclient
 import apiclient.discovery
+import apiclient.errors
 import config
 import errors
 import util
@@ -19,6 +20,10 @@ class CredentialsFromEnv(object):
         from httplib import BadStatusLine
         if 'headers' not in kwargs:
             kwargs['headers'] = {}
+
+        if config.get("ARVADOS_EXTERNAL_CLIENT", "") == "true":
+            kwargs['headers']['X-External-Client'] = '1'
+
         kwargs['headers']['Authorization'] = 'OAuth2 %s' % config.get('ARVADOS_API_TOKEN', 'ARVADOS_API_TOKEN_not_set')
         try:
             return self.orig_http_request(uri, **kwargs)
@@ -47,6 +52,15 @@ def _cast_objects_too(value, schema_type):
         return _cast_orig(value, schema_type)
 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
+# apiclient submodules import the class into their own namespace.
+def _new_http_error(cls, *args, **kwargs):
+    return super(apiclient.errors.HttpError, cls).__new__(
+        errors.ApiError, *args, **kwargs)
+apiclient.errors.HttpError.__new__ = staticmethod(_new_http_error)
+
 def http_cache(data_type):
     path = os.environ['HOME'] + '/.cache/arvados/' + data_type
     try:
@@ -55,37 +69,57 @@ def http_cache(data_type):
         path = None
     return path
 
-def api(version=None):
-    global services
+def api(version=None, cache=True, **kwargs):
+    """Return an apiclient Resources object for an Arvados instance.
+
+    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, or use
+      a cached discovery document to build one.
 
-    if 'ARVADOS_DEBUG' in config.settings():
+    Additional keyword arguments will be passed directly to
+    `apiclient.discovery.build`.  If the `discoveryServiceUrl` or `http`
+    keyword arguments are missing, this function will set default values for
+    them, based on the current Arvados configuration settings."""
+    if config.get('ARVADOS_DEBUG'):
         logging.basicConfig(level=logging.DEBUG)
 
-    if not services.get(version):
-        apiVersion = version
+    if not cache or not services.get(version):
         if not version:
-            apiVersion = 'v1'
+            version = 'v1'
             logging.info("Using default API version. " +
                          "Call arvados.api('%s') instead." %
-                         apiVersion)
-        if 'ARVADOS_API_HOST' not in config.settings():
-            raise Exception("ARVADOS_API_HOST is not set. Aborting.")
-        url = ('https://%s/discovery/v1/apis/{api}/{apiVersion}/rest' %
-               config.get('ARVADOS_API_HOST'))
-        credentials = CredentialsFromEnv()
-
-        # Use system's CA certificates (if we find them) instead of httplib2's
-        ca_certs = '/etc/ssl/certs/ca-certificates.crt'
-        if not os.path.exists(ca_certs):
-            ca_certs = None             # use httplib2 default
-
-        http = httplib2.Http(ca_certs=ca_certs,
-                             cache=http_cache('discovery'))
-        http = credentials.authorize(http)
-        if re.match(r'(?i)^(true|1|yes)$',
-                    config.get('ARVADOS_API_HOST_INSECURE', 'no')):
-            http.disable_ssl_certificate_validation=True
-        services[version] = apiclient.discovery.build(
-            'arvados', apiVersion, http=http, discoveryServiceUrl=url)
+                         version)
+
+        if 'discoveryServiceUrl' not in kwargs:
+            api_host = config.get('ARVADOS_API_HOST')
+            if not api_host:
+                raise ValueError(
+                    "No discoveryServiceUrl or ARVADOS_API_HOST set.")
+            kwargs['discoveryServiceUrl'] = (
+                'https://%s/discovery/v1/apis/{api}/{apiVersion}/rest' %
+                (api_host,))
+
+        if 'http' not in kwargs:
+            http_kwargs = {}
+            # Prefer system's CA certificates (if available) over httplib2's.
+            certs_path = '/etc/ssl/certs/ca-certificates.crt'
+            if os.path.exists(certs_path):
+                http_kwargs['ca_certs'] = certs_path
+            if cache:
+                http_kwargs['cache'] = http_cache('discovery')
+            if (config.get('ARVADOS_API_HOST_INSECURE', '').lower() in
+                  ('yes', 'true', '1')):
+                http_kwargs['disable_ssl_certificate_validation'] = True
+            kwargs['http'] = httplib2.Http(**http_kwargs)
+
+        kwargs['http'] = CredentialsFromEnv().authorize(kwargs['http'])
+        services[version] = apiclient.discovery.build('arvados', version,
+                                                      **kwargs)
+        kwargs['http'].cache = None
     return services[version]
 
+def uncache_api(version):
+    if version in services:
+        del services[version]