summaryrefslogtreecommitdiff
path: root/cdsapi/api.py
blob: d9db791fbdbb2c1392a994622e410d9c593acf49 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
import requests
import json
import time
import os
import logging


def bytes_to_string(n):
    u = ['', 'K', 'M', 'G', 'T', 'P']
    i = 0
    while n >= 1024:
        n /= 1024.0
        i += 1
    return '%g%s' % (int(n * 10 + 0.5) / 10.0, u[i])


class Client(object):

    logger = logging.getLogger('cdsapi')

    def __init__(self,
                 end_point=os.environ.get('CDSAPI_URL'),
                 api_key=os.environ.get('CDSAPI_KEY'),
                 verbose=False,
                 verify=None,
                 timeout=None,
                 full_stack=False,
                 delete=False,
                 retry_max=500,
                 sleep_max=120
                 ):

        dotrc = os.environ.get('CDSAPI_RC', os.path.expanduser('~/.cdsapirc'))

        if end_point is None or api_key is None:
            if os.path.exists(dotrc):
                config = {}
                with open(dotrc) as f:
                    for l in f.readlines():
                        k, v = l.strip().split(':', 1)
                        config[k] = v.strip()
                url = config.get('url')
                key = config.get('key')

                if api_key is None:
                    api_key = key

                if end_point is None:
                    end_point = url

                if verify is None:
                    verify = int(config.get('verify', 1))

        if end_point is None or api_key is None or api_key is None:
            raise Exception('Missing/incomplete configuration file: %s' % (dotrc))

        self.end_point = end_point
        self.api_key = api_key

        self.verbose = verbose
        self.verify = True if verify else False
        self.timeout = timeout
        self.sleep_max = sleep_max
        self.retry_max = retry_max
        self.full_stack = full_stack
        self.delete = delete

        self.logger.debug("CDSAPI %s", dict(end_point=self.end_point,
                                            api_key=self.api_key,
                                            verbose=self.verbose,
                                            verify=self.verify,
                                            timeout=self.timeout,
                                            sleep_max=self.sleep_max,
                                            retry_max=self.retry_max,
                                            full_stack=self.full_stack,
                                            delete=self.delete
                                            ))

    def retrieve(self, name, request, target=None):
        self._api('%s/resources/%s' % (self.end_point, name), request, target)

    def _download(self, url, size, local_filename=None):

        if local_filename is None:
            local_filename = url.split('/')[-1]

        self.logger.debug("Downloading %s to %s (%s)", url, local_filename, bytes_to_string(size))
        start = time.time()
        r = self.robust(requests.get)(url, stream=True, verify=self.verify)
        total = 0
        with open(local_filename, 'wb') as f:
            for chunk in r.iter_content(chunk_size=1024):
                if chunk:
                    f.write(chunk)
                    total += len(chunk)

        assert total == size

        elapsed = time.time() - start
        if elapsed:
            self.logger.debug("Download rate %s/s", bytes_to_string(size / elapsed))
        return local_filename

    def _api(self, url, request, target):

        session = requests.Session()
        session.auth = tuple(self.api_key.split(':', 2))

        self.logger.debug("POST %s, %s", url, json.dumps(request))
        result = self.robust(session.post)(url, json=request, verify=self.verify)
        reply = None

        try:
            result.raise_for_status()
            reply = result.json()
        except Exception:

            if reply is None:
                try:
                    reply = result.json()
                except Exception:
                    reply = dict(message=result.text)

            self.logger.debug(json.dumps(reply))

            if 'message' in reply:
                error = reply['message']

                if 'context' in reply and 'required_terms' in reply['context']:
                    e = [error]
                    for t in reply['context']['required_terms']:
                        e.append("To access this resource, you first need to accept the terms"
                                 "of '%s' at %s" % (t['title'], t['url']))
                    error = '. '.join(e)
                raise Exception(error)
            else:
                raise

        sleep = 1
        start = time.time()

        while True:

            self.logger.debug("REPLY %s", reply)

            if reply['state'] == 'completed':

                if target:
                    self._download(reply['location'], int(reply['content_length']), target)
                else:
                    self.logger.debug("HEAD %s", reply['location'])
                    metadata = self.robust(session.head)(reply['location'], verify=self.verify)
                    metadata.raise_for_status()
                    self.logger.debug(metadata.headers)

                if 'request_id' in reply:
                    rid = reply['request_id']

                    if self.delete:
                        task_url = '%s/tasks/%s' % (self.end_point, rid)
                        self.logger.debug("DELETE %s", task_url)
                        delete = session.delete(task_url, verify=self.verify)
                        self.logger.debug("DELETE returns %s %s", delete.status_code, delete.reason)
                        try:
                            delete.raise_for_status()
                        except Exception:
                            self.logger.warning("DELETE %s returns %s %s",
                                                task_url, delete.status_code, delete.reason)

                self.logger.debug("Done")
                return

            if reply['state'] in ('queued', 'running'):
                rid = reply['request_id']

                if self.timeout and (time.time() - start > self.timeout):
                    raise Exception('TIMEOUT')

                self.logger.debug("Request ID is %s, sleep %s", rid, sleep)
                time.sleep(sleep)
                sleep *= 1.5
                if sleep > self.sleep_max:
                    sleep = self.sleep_max

                task_url = '%s/tasks/%s' % (self.end_point, rid)
                self.logger.debug("GET %s", task_url)

                result = self.robust(session.get)(task_url, verify=self.verify)
                result.raise_for_status()
                reply = result.json()
                continue

            if reply['state'] in ('failed',):
                self.logger.error("Message: %s", reply['error'].get('message'))
                self.logger.error("Reason:  %s", reply['error'].get('reason'))
                for n in reply.get('error', {}).get('context', {}).get('traceback', '').split('\n'):
                    if n.strip() == '' and not self.full_stack:
                        break
                    self.logger.error("  %s", n)
                raise Exception(reply['error'].get('reason'))

            raise Exception('Unknown API state [%s]' % (reply['state'],))

    def robust(self, call):

        def retriable(code, reason):

            if code in [requests.codes.internal_server_error,
                        requests.codes.bad_gateway,
                        requests.codes.service_unavailable,
                        requests.codes.gateway_timeout,
                        requests.codes.too_many_requests,
                        requests.codes.request_timeout]:
                return True

            return False

        def wrapped(*args, **kwargs):
            tries = 0
            while tries < self.retry_max:
                r = call(*args, **kwargs)
                if not retriable(r.status_code, r.reason):
                    return r

                tries += 1

                self.logger.warning("Recovering from HTTP error [%s %s], attemps %s of %s",
                                    r.status_code, r.reason, tries, self.retry_max)
                self.logger.warning("Retrying in %s second (", self.sleep_max)
                time.sleep(self.sleep_max)

        return wrapped