X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b887df487c6cb465c3212e8ef99278350e58ff0a..e9c78ef7855e7ae263fe461e069c89ff7fc0b798:/sdk/python/arvados/api.py diff --git a/sdk/python/arvados/api.py b/sdk/python/arvados/api.py index a227e436a3..5ec5ac2e8a 100644 --- a/sdk/python/arvados/api.py +++ b/sdk/python/arvados/api.py @@ -1,8 +1,10 @@ +import collections import httplib2 import json import logging import os import re +import socket import types import apiclient @@ -14,35 +16,68 @@ import util _logger = logging.getLogger('arvados.api') -class CredentialsFromToken(object): - def __init__(self, api_token): - self.api_token = api_token - - @staticmethod - def http_request(self, uri, **kwargs): - 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' % self.arvados_api_token - try: - return self.orig_http_request(uri, **kwargs) - except BadStatusLine: - # This is how httplib tells us that it tried to reuse an - # existing connection but it was already closed by the - # server. In that case, yes, we would like to retry. - # Unfortunately, we are not absolutely certain that the - # previous call did not succeed, so this is slightly - # risky. - return self.orig_http_request(uri, **kwargs) - def authorize(self, http): - http.arvados_api_token = self.api_token - http.orig_http_request = http.request - http.request = types.MethodType(self.http_request, http) - return http +class OrderedJsonModel(apiclient.model.JsonModel): + """Model class for JSON that preserves the contents' order. + + API clients that care about preserving the order of fields in API + server responses can use this model to do so, like this:: + + from arvados.api import OrderedJsonModel + client = arvados.api('v1', ..., model=OrderedJsonModel()) + """ + + def deserialize(self, content): + # This is a very slightly modified version of the parent class' + # implementation. Copyright (c) 2010 Google. + content = content.decode('utf-8') + body = json.loads(content, object_pairs_hook=collections.OrderedDict) + if self._data_wrapper and isinstance(body, dict) and 'data' in body: + body = body['data'] + return body + + +def _intercept_http_request(self, uri, **kwargs): + from httplib import BadStatusLine + + if (self.max_request_size and + kwargs.get('body') and + self.max_request_size < len(kwargs['body'])): + raise apiclient_errors.MediaUploadSizeError("Request size %i bytes exceeds published limit of %i bytes" % (len(kwargs['body']), self.max_request_size)) + + 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' % self.arvados_api_token + try: + return self.orig_http_request(uri, **kwargs) + except BadStatusLine: + # This is how httplib tells us that it tried to reuse an + # existing connection but it was already closed by the + # server. In that case, yes, we would like to retry. + # Unfortunately, we are not absolutely certain that the + # previous call did not succeed, so this is slightly + # risky. + return self.orig_http_request(uri, **kwargs) + except socket.error: + # This is the one case where httplib2 doesn't close the + # underlying connection first. Close all open connections, + # expecting this object only has the one connection to the API + # server. This is safe because httplib2 reopens connections when + # needed. + _logger.debug("Retrying API request after socket error", exc_info=True) + for conn in self.connections.itervalues(): + conn.close() + return self.orig_http_request(uri, **kwargs) + +def _patch_http_request(http, api_token): + http.arvados_api_token = api_token + http.max_request_size = 0 + http.orig_http_request = http.request + http.request = types.MethodType(_intercept_http_request, http) + return http # Monkey patch discovery._cast() so objects and arrays get serialized # with json.dumps() instead of str(). @@ -66,7 +101,10 @@ def _new_http_error(cls, *args, **kwargs): apiclient_errors.HttpError.__new__ = staticmethod(_new_http_error) def http_cache(data_type): - path = os.environ['HOME'] + '/.cache/arvados/' + data_type + homedir = os.environ.get('HOME') + if not homedir or len(homedir) == 0: + return None + path = homedir + '/.cache/arvados/' + data_type try: util.mkdir_dash_p(path) except OSError: @@ -131,22 +169,18 @@ def api(version=None, cache=True, host=None, token=None, insecure=False, **kwarg 'https://%s/discovery/v1/apis/{api}/{apiVersion}/rest' % (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 + http_kwargs = {'ca_certs': util.ca_certs_path()} if cache: http_kwargs['cache'] = http_cache('discovery') 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']) + kwargs['http'] = _patch_http_request(kwargs['http'], token) svc = apiclient_discovery.build('arvados', version, **kwargs) svc.api_token = token + kwargs['http'].max_request_size = svc._rootDesc.get('maxRequestSize', 0) kwargs['http'].cache = None return svc