import apiclient
import apiclient.discovery
+import apiclient.errors
+import config
+import errors
import util
-config = None
+_logger = logging.getLogger('arvados.api')
services = {}
class CredentialsFromEnv(object):
@staticmethod
def http_request(self, uri, **kwargs):
- global config
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)
http.request = types.MethodType(self.http_request, http)
return http
-# Arvados configuration settings are taken from $HOME/.config/arvados.
-# Environment variables override settings in the config file.
-#
-class ArvadosConfig(dict):
- def __init__(self, config_file):
- dict.__init__(self)
- if os.path.exists(config_file):
- with open(config_file, "r") as f:
- for config_line in f:
- var, val = config_line.rstrip().split('=', 2)
- self[var] = val
- for var in os.environ:
- if var.startswith('ARVADOS_'):
- self[var] = os.environ[var]
-
# Monkey patch discovery._cast() so objects and arrays get serialized
# with json.dumps() instead of str().
_cast_orig = apiclient.discovery._cast
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:
path = None
return path
-def api(version=None):
- global services, config
+def api(version=None, cache=True, **kwargs):
+ """Return an apiclient Resources object for an Arvados instance.
- if not config:
- config = ArvadosConfig(os.environ['HOME'] + '/.config/arvados/settings.conf')
- if 'ARVADOS_DEBUG' in config:
- logging.basicConfig(level=logging.DEBUG)
+ 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 not services.get(version):
- apiVersion = version
+ 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 not cache or not services.get(version):
if not version:
- apiVersion = 'v1'
- logging.info("Using default API version. " +
- "Call arvados.api('%s') instead." %
- apiVersion)
- if 'ARVADOS_API_HOST' not in config:
- raise Exception("ARVADOS_API_HOST is not set. Aborting.")
- url = ('https://%s/discovery/v1/apis/{api}/{apiVersion}/rest' %
- config['ARVADOS_API_HOST'])
- credentials = CredentialsFromEnv()
+ version = 'v1'
+ _logger.info("Using default API version. " +
+ "Call arvados.api('%s') instead.",
+ 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,))
- # 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
+ 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)
- 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)
+ 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]
projects / arvados.git / blobdiff