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
|
from __future__ import annotations
import functools
import logging
import warnings
from types import TracebackType
from typing import Any, Callable, TypeVar, cast, overload
import cdsapi.api
import requests
from . import __version__ as cads_api_client_version
from . import api_client, processing
LEGACY_KWARGS = [
"full_stack",
"delete",
"retry_max",
"sleep_max",
"wait_until_complete",
"info_callback",
"warning_callback",
"error_callback",
"debug_callback",
"metadata",
"forget",
"session",
]
LOGGER = logging.getLogger(__name__)
F = TypeVar("F", bound=Callable[..., Any])
class LoggingContext:
def __init__(self, logger: logging.Logger, quiet: bool, debug: bool) -> None:
self.old_level = logger.level
if quiet:
logger.setLevel(logging.WARNING)
else:
logger.setLevel(logging.DEBUG if debug else logging.INFO)
self.new_handlers = []
if not logger.handlers:
formatter = logging.Formatter("%(asctime)s %(levelname)s %(message)s")
handler = logging.StreamHandler()
handler.setFormatter(formatter)
logger.addHandler(handler)
self.new_handlers.append(handler)
self.logger = logger
def __enter__(self) -> logging.Logger:
return self.logger
def __exit__(
self,
exc_type: type[BaseException] | None,
exc_val: BaseException | None,
exc_tb: TracebackType | None,
) -> None:
self.logger.setLevel(self.old_level)
for handler in self.new_handlers:
self.logger.removeHandler(handler)
class LegacyApiClient(cdsapi.api.Client): # type: ignore[misc]
def __init__(
self,
url: str | None = None,
key: str | None = None,
quiet: bool = False,
debug: bool = False,
verify: bool | None = None,
timeout: int = 60,
progress: bool = True,
*args: Any,
**kwargs: Any,
) -> None:
kwargs.update(zip(LEGACY_KWARGS, args))
if wrong_kwargs := set(kwargs) - set(LEGACY_KWARGS):
raise ValueError(f"Wrong parameters: {wrong_kwargs}.")
self.url, self.key, self.verify = cdsapi.api.get_url_key_verify(
url, key, verify
)
self.quiet = quiet
self._debug = debug
self.timeout = timeout
self.progress = progress
self.sleep_max = kwargs.pop("sleep_max", 120)
self.wait_until_complete = kwargs.pop("wait_until_complete", True)
self.delete = kwargs.pop("delete", False)
self.retry_max = kwargs.pop("retry_max", 500)
self.session = kwargs.pop("session", requests.Session())
if kwargs:
warnings.warn(
"This is a beta version."
f" The following parameters have not been implemented yet: {kwargs}.",
UserWarning,
)
self.client = api_client.ApiClient(
url=self.url,
key=self.key,
verify=self.verify,
sleep_max=self.sleep_max,
session=self.session,
cleanup=self.delete,
maximum_tries=self.retry_max,
retry_after=self.sleep_max,
timeout=self.timeout,
progress=self.progress,
)
self.debug(
"CDSAPI %s",
{
"url": self.url,
"key": self.key,
"quiet": self.quiet,
"verify": self.verify,
"timeout": self.timeout,
"progress": self.progress,
"sleep_max": self.sleep_max,
"retry_max": self.retry_max,
"delete": self.delete,
"cads_api_client_version": cads_api_client_version,
},
)
@classmethod
def raise_not_implemented_error(self) -> None:
raise NotImplementedError(
"This is a beta version. This functionality has not been implemented yet."
)
def logging_decorator(self, func: F) -> F:
@functools.wraps(func)
def wrapper(*args: Any, **kwargs: Any) -> Any:
with LoggingContext(
logger=processing.logger, quiet=self.quiet, debug=self._debug
):
return func(*args, **kwargs)
return cast(F, wrapper)
@overload
def retrieve(self, name: str, request: dict[str, Any], target: str) -> str: ...
@overload
def retrieve(
self, name: str, request: dict[str, Any], target: None = ...
) -> processing.Results: ...
def retrieve(
self, name: str, request: dict[str, Any], target: str | None = None
) -> str | processing.Remote | processing.Results:
submitted: processing.Remote | processing.Results
if self.wait_until_complete:
submitted = self.logging_decorator(self.client.submit_and_wait_on_result)(
collection_id=name,
**request,
)
else:
submitted = self.logging_decorator(self.client.submit)(
collection_id=name,
**request,
)
# Decorate legacy methods
submitted.download = self.logging_decorator(submitted.download) # type: ignore[method-assign]
submitted.info = self.logging_decorator(submitted.info) # type: ignore[method-assign]
submitted.warning = self.logging_decorator(submitted.warning) # type: ignore[method-assign]
submitted.error = self.logging_decorator(submitted.error) # type: ignore[method-assign]
submitted.debug = self.logging_decorator(submitted.debug) # type: ignore[method-assign]
return submitted if target is None else submitted.download(target)
def info(self, *args: Any, **kwargs: Any) -> None:
with LoggingContext(
logger=LOGGER, quiet=self.quiet, debug=self._debug
) as logger:
logger.info(*args, **kwargs)
def warning(self, *args: Any, **kwargs: Any) -> None:
with LoggingContext(
logger=LOGGER, quiet=self.quiet, debug=self._debug
) as logger:
logger.warning(*args, **kwargs)
def error(self, *args: Any, **kwargs: Any) -> None:
with LoggingContext(
logger=LOGGER, quiet=self.quiet, debug=self._debug
) as logger:
logger.error(*args, **kwargs)
def debug(self, *args: Any, **kwargs: Any) -> None:
with LoggingContext(
logger=LOGGER, quiet=self.quiet, debug=self._debug
) as logger:
logger.debug(*args, **kwargs)
def service(self, name, *args, **kwargs): # type: ignore
self.raise_not_implemented_error()
def workflow(self, code, *args, **kwargs): # type: ignore
self.raise_not_implemented_error()
def status(self, context=None): # type: ignore
self.raise_not_implemented_error()
def download(self, results, targets=None): # type: ignore
self.raise_not_implemented_error()
def remote(self, url): # type: ignore
self.raise_not_implemented_error()
def robust(self, call): # type: ignore
self.raise_not_implemented_error()
|
