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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
|
from __future__ import annotations
import functools
import logging
import os
import time
import urllib.parse
import warnings
from typing import Any, Type, TypedDict, TypeVar
try:
from typing import Self
except ImportError:
from typing_extensions import Self
import attrs
import multiurl
import requests
from . import config
T_ApiResponse = TypeVar("T_ApiResponse", bound="ApiResponse")
logger = logging.getLogger(__name__)
class RequestKwargs(TypedDict):
headers: dict[str, str]
session: requests.Session
retry_options: dict[str, Any]
request_options: dict[str, Any]
download_options: dict[str, Any]
sleep_max: int
cleanup: bool
class ProcessingFailedError(RuntimeError):
pass
class DownloadError(RuntimeError):
pass
class LinkError(Exception):
pass
def error_json_to_message(error_json: dict[str, Any]) -> str:
error_messages = [
str(error_json[key])
for key in ("title", "traceback", "detail")
if key in error_json
]
return "\n".join(error_messages)
def cads_raise_for_status(response: requests.Response) -> None:
if 400 <= response.status_code < 500:
try:
error_json = response.json()
except Exception:
pass
else:
message = "\n".join(
[
f"{response.status_code} Client Error: {response.reason} for url: {response.url}",
error_json_to_message(error_json),
]
)
raise requests.exceptions.HTTPError(message, response=response)
response.raise_for_status()
def get_level_and_message(message: str) -> tuple[int, str]:
level = 20
for severity in ("DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"):
if message.startswith(severity):
level = logging.getLevelName(severity)
message = message.replace(severity, "", 1).lstrip(":").lstrip()
break
return level, message
@attrs.define(slots=False)
class ApiResponse:
response: requests.Response
headers: dict[str, str]
session: requests.Session
retry_options: dict[str, Any]
request_options: dict[str, Any]
download_options: dict[str, Any]
sleep_max: int
cleanup: bool
@property
def request_kwargs(self) -> RequestKwargs:
return RequestKwargs(
headers=self.headers,
session=self.session,
retry_options=self.retry_options,
request_options=self.request_options,
download_options=self.download_options,
sleep_max=self.sleep_max,
cleanup=self.cleanup,
)
@classmethod
def from_request(
cls: Type[T_ApiResponse],
method: str,
url: str,
headers: dict[str, str],
session: requests.Session | None,
retry_options: dict[str, Any],
request_options: dict[str, Any],
download_options: dict[str, Any],
sleep_max: int,
cleanup: bool,
**kwargs: Any,
) -> T_ApiResponse:
if session is None:
session = requests.Session()
robust_request = multiurl.robust(session.request, **retry_options)
inputs = kwargs.get("json", {}).get("inputs", {})
logger.debug(f"{method.upper()} {url} {inputs or ''}".strip())
response = robust_request(
method, url, headers=headers, **request_options, **kwargs
)
logger.debug(f"REPLY {response.text}")
cads_raise_for_status(response)
self = cls(
response,
headers=headers,
session=session,
retry_options=retry_options,
request_options=request_options,
download_options=download_options,
sleep_max=sleep_max,
cleanup=cleanup,
)
self.log_messages()
return self
@property
def json(self) -> dict[str, Any]:
json: dict[str, Any] = self.response.json()
return json
def log_messages(self) -> None:
if message := self.json.get("message"):
level, message = get_level_and_message(message)
logger.log(level, message)
dataset_messages = (
self.json.get("metadata", {}).get("datasetMetadata", {}).get("messages", [])
)
for dataset_message in dataset_messages:
if not (content := dataset_message.get("content")):
continue
if date := dataset_message.get("date"):
content = f"[{date}] {content}"
severity = dataset_message.get("severity", "notset").upper()
level = logging.getLevelName(severity)
logger.log(level if isinstance(level, int) else 20, content)
def get_links(self, rel: str | None = None) -> list[dict[str, str]]:
links = []
for link in self.json.get("links", []):
if rel is not None and link.get("rel") == rel:
links.append(link)
return links
def get_link_href(self, rel: str | None = None) -> str:
links = self.get_links(rel)
if len(links) != 1:
raise LinkError(f"link not found or not unique {rel=}")
return links[0]["href"]
def from_rel_href(self, rel: str) -> Self | None:
rels = self.get_links(rel=rel)
if len(rels) > 1:
raise LinkError(f"link not unique {rel=}")
if len(rels) == 1:
out = self.from_request("get", rels[0]["href"], **self.request_kwargs)
else:
out = None
return out
@attrs.define
class ProcessList(ApiResponse):
def process_ids(self) -> list[str]:
return [proc["id"] for proc in self.json["processes"]]
def next(self) -> ApiResponse | None:
return self.from_rel_href(rel="next")
def prev(self) -> ApiResponse | None:
return self.from_rel_href(rel="prev")
@attrs.define
class Process(ApiResponse):
@property
def id(self) -> str:
process_id: str = self.json["id"]
return process_id
def execute(self, inputs: dict[str, Any]) -> StatusInfo:
url = f"{self.response.request.url}/execution"
return StatusInfo.from_request(
"post", url, json={"inputs": inputs}, **self.request_kwargs
)
def valid_values(self, request: dict[str, Any] = {}) -> dict[str, Any]:
url = f"{self.response.request.url}/constraints"
response = ApiResponse.from_request(
"post", url, json={"inputs": request}, **self.request_kwargs
)
response.response.raise_for_status()
return response.json
@attrs.define(slots=False)
class Remote:
url: str
headers: dict[str, str]
session: requests.Session
retry_options: dict[str, Any]
request_options: dict[str, Any]
download_options: dict[str, Any]
sleep_max: int
cleanup: bool
def __attrs_post_init__(self) -> None:
self.log_start_time = None
self.info(f"Request ID is {self.request_uid}")
@property
def request_kwargs(self) -> RequestKwargs:
return RequestKwargs(
headers=self.headers,
session=self.session,
retry_options=self.retry_options,
request_options=self.request_options,
download_options=self.download_options,
sleep_max=self.sleep_max,
cleanup=self.cleanup,
)
def log_metadata(self, metadata: dict[str, Any]) -> None:
logs = metadata.get("log", [])
for self.log_start_time, message in sorted(logs):
level, message = get_level_and_message(message)
logger.log(level, message)
def get_api_response(self, method: str, **kwargs: Any) -> ApiResponse:
return ApiResponse.from_request(
method, self.url, **self.request_kwargs, **kwargs
)
@functools.cached_property
def request_uid(self) -> str:
return self.url.rpartition("/")[2]
@property
def _reply(self) -> dict[str, Any]:
params = {"log": True}
if self.log_start_time:
params["logStartTime"] = self.log_start_time
return self.get_api_response("get", params=params).json
@property
def status(self) -> str:
reply = self._reply
self.log_metadata(reply.get("metadata", {}))
status: str = reply["status"]
return status
def wait_on_result(self) -> None:
sleep = 1.0
status = None
while True:
if status != (status := self.status):
self.info(f"status has been updated to {status}")
if status == "successful":
break
elif status == "failed":
results = self.make_results()
raise ProcessingFailedError(error_json_to_message(results.json))
elif status in ("accepted", "running"):
sleep *= 1.5
if sleep > self.sleep_max:
sleep = self.sleep_max
elif status in ("dismissed", "deleted"):
raise ProcessingFailedError(f"API state {status!r}")
else:
raise ProcessingFailedError(f"Unknown API state {status!r}")
self.debug(f"result not ready, waiting for {sleep} seconds")
time.sleep(sleep)
def build_status_info(self) -> StatusInfo:
return StatusInfo.from_request("get", self.url, **self.request_kwargs)
def make_results(self) -> Results:
response = self.get_api_response("get")
try:
results_url = response.get_link_href(rel="results")
except LinkError:
results_url = f"{self.url}/results"
results = Results.from_request("get", results_url, **self.request_kwargs)
return results
def _download_result(
self,
target: str | None = None,
) -> str:
results = self.make_results()
return results.download(target)
def download(
self,
target: str | None = None,
) -> str:
self.wait_on_result()
return self._download_result(target)
def delete(self) -> dict[str, Any]:
response = self.get_api_response("delete")
self.cleanup = False
return response.json
def _warn(self) -> None:
message = (
".update and .reply are available for backward compatibility."
" You can now use .download directly without needing to check whether the request is completed."
)
warnings.warn(message, DeprecationWarning)
def update(self, request_id: str | None = None) -> None:
self._warn()
if request_id:
assert request_id == self.request_uid
try:
del self.reply
except AttributeError:
pass
self.reply
@functools.cached_property
def reply(self) -> dict[str, Any]:
self._warn()
reply = self._reply
reply.setdefault("state", reply["status"])
if reply["state"] == "successful":
reply["state"] = "completed"
elif reply["state"] == "queued":
reply["state"] = "accepted"
elif reply["state"] == "failed":
reply.setdefault("error", {})
try:
self.make_results()
except Exception as exc:
reply["error"].setdefault("message", str(exc))
reply.setdefault("request_id", self.request_uid)
return reply
def info(self, *args: Any, **kwargs: Any) -> None:
logger.info(*args, **kwargs)
def warning(self, *args: Any, **kwargs: Any) -> None:
logger.warning(*args, **kwargs)
def error(self, *args: Any, **kwargs: Any) -> None:
logger.error(*args, **kwargs)
def debug(self, *args: Any, **kwargs: Any) -> None:
logger.debug(*args, **kwargs)
def __del__(self) -> None:
if self.cleanup:
try:
self.delete()
except Exception as exc:
warnings.warn(str(exc), UserWarning)
@attrs.define
class StatusInfo(ApiResponse):
def make_remote(self) -> Remote:
if self.response.request.method == "POST":
url = self.get_link_href(rel="monitor")
else:
url = self.get_link_href(rel="self")
return Remote(url, **self.request_kwargs)
@attrs.define
class JobList(ApiResponse):
def job_ids(self) -> list[str]:
return [job["jobID"] for job in self.json["jobs"]]
def next(self) -> ApiResponse | None:
return self.from_rel_href(rel="next")
def prev(self) -> ApiResponse | None:
return self.from_rel_href(rel="prev")
@attrs.define
class Results(ApiResponse):
@property
def status_code(self) -> int:
return self.response.status_code
@property
def reason(self) -> str:
return self.response.reason
def get_result_href(self) -> str:
if self.status_code != 200:
raise KeyError("result_href not available for processing failed results")
href: str = self.json["asset"]["value"]["href"]
return href
@property
def asset(self) -> dict[str, Any]:
return dict(self.json["asset"]["value"])
@property
def location(self) -> str:
result_href = self.get_result_href()
return urllib.parse.urljoin(self.response.url, result_href)
@property
def content_length(self) -> int:
return int(self.asset["file:size"])
@property
def content_type(self) -> str:
return str(self.asset["type"])
def download(
self,
target: str | None = None,
) -> str:
url = self.location
if target is None:
parts = urllib.parse.urlparse(url)
target = parts.path.strip("/").split("/")[-1]
download_options = {"stream": True}
download_options.update(self.download_options)
multiurl.download(
url,
target=target,
**self.retry_options,
**self.request_options,
**download_options,
)
if (target_size := os.path.getsize(target)) != (size := self.content_length):
raise DownloadError(
"Download failed: downloaded %s byte(s) out of %s" % (target_size, size)
)
return target
def info(self, *args: Any, **kwargs: Any) -> None:
logger.info(*args, **kwargs)
def warning(self, *args: Any, **kwargs: Any) -> None:
logger.warning(*args, **kwargs)
def error(self, *args: Any, **kwargs: Any) -> None:
logger.error(*args, **kwargs)
def debug(self, *args: Any, **kwargs: Any) -> None:
logger.debug(*args, **kwargs)
@attrs.define(slots=False)
class Processing:
url: str
headers: dict[str, str]
session: requests.Session
retry_options: dict[str, Any]
request_options: dict[str, Any]
download_options: dict[str, Any]
sleep_max: int
cleanup: bool
force_exact_url: bool = False
def __attrs_post_init__(self) -> None:
if not self.force_exact_url:
self.url += f"/{config.SUPPORTED_API_VERSION}"
@property
def request_kwargs(self) -> RequestKwargs:
return RequestKwargs(
headers=self.headers,
session=self.session,
retry_options=self.retry_options,
request_options=self.request_options,
download_options=self.download_options,
sleep_max=self.sleep_max,
cleanup=self.cleanup,
)
def processes(self, params: dict[str, Any] = {}) -> ProcessList:
url = f"{self.url}/processes"
return ProcessList.from_request(
"get", url, params=params, **self.request_kwargs
)
def process(self, process_id: str) -> Process:
url = f"{self.url}/processes/{process_id}"
return Process.from_request("get", url, **self.request_kwargs)
def process_execute(
self,
process_id: str,
inputs: dict[str, Any],
) -> StatusInfo:
url = f"{self.url}/processes/{process_id}/execution"
return StatusInfo.from_request(
"post", url, json={"inputs": inputs}, **self.request_kwargs
)
def jobs(self, params: dict[str, Any] = {}) -> JobList:
url = f"{self.url}/jobs"
return JobList.from_request("get", url, params=params, **self.request_kwargs)
def job(self, job_id: str) -> StatusInfo:
url = f"{self.url}/jobs/{job_id}"
return StatusInfo.from_request("get", url, **self.request_kwargs)
def job_results(self, job_id: str) -> Results:
url = f"{self.url}/jobs/{job_id}/results"
return Results.from_request("get", url, **self.request_kwargs)
# convenience methods
def submit(self, collection_id: str, **request: Any) -> Remote:
status_info = self.process_execute(collection_id, request)
return status_info.make_remote()
def submit_and_wait_on_result(self, collection_id: str, **request: Any) -> Results:
remote = self.submit(collection_id, **request)
remote.wait_on_result()
return remote.make_results()
def make_remote(self, job_id: str) -> Remote:
url = f"{self.url}/jobs/{job_id}"
return Remote(url, **self.request_kwargs)
def download_result(self, job_id: str, target: str | None) -> str:
# NOTE: the remote waits for the result to be available
return self.make_remote(job_id).download(target)
|