File size: 12,651 Bytes
b30f068 | 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 | """
CDMS (Common Data Model Schema) API client for label access.
"""
from typing import Dict, List, Any, Optional
import json
from datetime import datetime
from .base_client import BaseAPIClient, HTTPMethod, APIResponse
from config.settings import settings
from src.utils.logging_config import logger
class CDMSClient(BaseAPIClient):
"""Client for CDMS label access API."""
def __init__(
self,
api_url: Optional[str] = None,
api_key: Optional[str] = None,
timeout: int = None
):
"""
Initialize CDMS client.
Args:
api_url: CDMS API base URL
api_key: API key for authentication
timeout: Request timeout
"""
self.api_url = api_url or settings.cdms_api_url
self.api_key = api_key or settings.cdms_api_key
if not self.api_url:
raise ValueError("CDMS API URL is required")
if not self.api_key:
logger.warning("CDMS API key not provided. Some operations may fail.")
# Set up authentication headers
auth_headers = {}
if self.api_key:
auth_headers['Authorization'] = f'Bearer {self.api_key}'
auth_headers['X-API-Key'] = self.api_key
super().__init__(
base_url=self.api_url,
timeout=timeout or settings.cdms_timeout,
auth_headers=auth_headers
)
self._authenticated = False
def authenticate(self) -> bool:
"""
Authenticate with CDMS API.
Returns:
True if authentication successful
"""
if not self.api_key:
logger.error("Cannot authenticate without API key")
return False
try:
# Test authentication with a simple API call
response = self.get('/health')
if response.success:
self._authenticated = True
logger.info("CDMS authentication successful")
return True
else:
logger.error(f"CDMS authentication failed: {response.error_message}")
return False
except Exception as e:
logger.error(f"CDMS authentication error: {e}")
return False
def get_api_info(self) -> Dict[str, Any]:
"""Get CDMS API information."""
try:
response = self.get('/info')
if response.success:
return response.data
else:
logger.warning(f"Failed to get API info: {response.error_message}")
return {
'name': 'CDMS API',
'version': 'unknown',
'status': 'error',
'error': response.error_message
}
except Exception as e:
logger.error(f"Error getting API info: {e}")
return {
'name': 'CDMS API',
'version': 'unknown',
'status': 'error',
'error': str(e)
}
def get_labels(
self,
dataset_id: Optional[str] = None,
label_type: Optional[str] = None,
limit: int = 100,
offset: int = 0
) -> APIResponse:
"""
Retrieve CDMS labels.
Args:
dataset_id: Filter by dataset ID
label_type: Filter by label type
limit: Maximum number of labels to return
offset: Offset for pagination
Returns:
APIResponse with label data
"""
params = {
'limit': limit,
'offset': offset
}
if dataset_id:
params['dataset_id'] = dataset_id
if label_type:
params['label_type'] = label_type
response = self.get('/labels', params=params)
if response.success:
logger.info(f"Retrieved {len(response.data.get('labels', []))} labels")
else:
logger.error(f"Failed to retrieve labels: {response.error_message}")
return response
def get_label_by_id(self, label_id: str) -> APIResponse:
"""
Get a specific label by ID.
Args:
label_id: Label identifier
Returns:
APIResponse with label data
"""
response = self.get(f'/labels/{label_id}')
if response.success:
logger.info(f"Retrieved label: {label_id}")
else:
logger.error(f"Failed to retrieve label {label_id}: {response.error_message}")
return response
def search_labels(
self,
query: str,
filters: Optional[Dict[str, Any]] = None,
limit: int = 50
) -> APIResponse:
"""
Search labels by query.
Args:
query: Search query
filters: Additional filters
limit: Maximum results
Returns:
APIResponse with search results
"""
data = {
'query': query,
'limit': limit
}
if filters:
data['filters'] = filters
response = self.post('/labels/search', json_data=data)
if response.success:
results_count = len(response.data.get('results', []))
logger.info(f"Search returned {results_count} results for query: '{query}'")
else:
logger.error(f"Label search failed: {response.error_message}")
return response
def get_datasets(self, limit: int = 100, offset: int = 0) -> APIResponse:
"""
Get available datasets.
Args:
limit: Maximum number of datasets
offset: Offset for pagination
Returns:
APIResponse with dataset list
"""
params = {
'limit': limit,
'offset': offset
}
response = self.get('/datasets', params=params)
if response.success:
logger.info(f"Retrieved {len(response.data.get('datasets', []))} datasets")
else:
logger.error(f"Failed to retrieve datasets: {response.error_message}")
return response
def get_dataset_labels(self, dataset_id: str) -> APIResponse:
"""
Get labels for a specific dataset.
Args:
dataset_id: Dataset identifier
Returns:
APIResponse with dataset labels
"""
response = self.get(f'/datasets/{dataset_id}/labels')
if response.success:
labels_count = len(response.data.get('labels', []))
logger.info(f"Retrieved {labels_count} labels for dataset: {dataset_id}")
else:
logger.error(f"Failed to retrieve labels for dataset {dataset_id}: {response.error_message}")
return response
def create_label(self, label_data: Dict[str, Any]) -> APIResponse:
"""
Create a new label.
Args:
label_data: Label data dictionary
Returns:
APIResponse with created label
"""
# Add timestamp if not provided
if 'created_at' not in label_data:
label_data['created_at'] = datetime.utcnow().isoformat()
response = self.post('/labels', json_data=label_data)
if response.success:
label_id = response.data.get('id', 'unknown')
logger.info(f"Created label: {label_id}")
else:
logger.error(f"Failed to create label: {response.error_message}")
return response
def update_label(self, label_id: str, label_data: Dict[str, Any]) -> APIResponse:
"""
Update an existing label.
Args:
label_id: Label identifier
label_data: Updated label data
Returns:
APIResponse with updated label
"""
# Add update timestamp
label_data['updated_at'] = datetime.utcnow().isoformat()
response = self.put(f'/labels/{label_id}', json_data=label_data)
if response.success:
logger.info(f"Updated label: {label_id}")
else:
logger.error(f"Failed to update label {label_id}: {response.error_message}")
return response
def delete_label(self, label_id: str) -> APIResponse:
"""
Delete a label.
Args:
label_id: Label identifier
Returns:
APIResponse confirming deletion
"""
response = self.delete(f'/labels/{label_id}')
if response.success:
logger.info(f"Deleted label: {label_id}")
else:
logger.error(f"Failed to delete label {label_id}: {response.error_message}")
return response
def get_label_metadata(self, label_id: str) -> APIResponse:
"""
Get metadata for a label.
Args:
label_id: Label identifier
Returns:
APIResponse with label metadata
"""
response = self.get(f'/labels/{label_id}/metadata')
if response.success:
logger.info(f"Retrieved metadata for label: {label_id}")
else:
logger.error(f"Failed to retrieve metadata for label {label_id}: {response.error_message}")
return response
def bulk_import_labels(self, labels: List[Dict[str, Any]]) -> APIResponse:
"""
Import multiple labels in bulk.
Args:
labels: List of label data dictionaries
Returns:
APIResponse with import results
"""
data = {
'labels': labels,
'import_timestamp': datetime.utcnow().isoformat()
}
response = self.post('/labels/bulk-import', json_data=data)
if response.success:
imported_count = response.data.get('imported_count', 0)
logger.info(f"Bulk imported {imported_count} labels")
else:
logger.error(f"Bulk import failed: {response.error_message}")
return response
def export_labels(
self,
dataset_id: Optional[str] = None,
format: str = 'json'
) -> APIResponse:
"""
Export labels in specified format.
Args:
dataset_id: Optional dataset filter
format: Export format (json, csv, xml)
Returns:
APIResponse with exported data
"""
params = {
'format': format
}
if dataset_id:
params['dataset_id'] = dataset_id
response = self.get('/labels/export', params=params)
if response.success:
logger.info(f"Exported labels in {format} format")
else:
logger.error(f"Export failed: {response.error_message}")
return response
def get_statistics(self) -> APIResponse:
"""
Get CDMS statistics.
Returns:
APIResponse with statistics
"""
response = self.get('/statistics')
if response.success:
logger.info("Retrieved CDMS statistics")
else:
logger.error(f"Failed to retrieve statistics: {response.error_message}")
return response
def health_check(self) -> bool:
"""
Check if CDMS API is healthy.
Returns:
True if API is healthy
"""
try:
response = self.get('/health')
return response.success and response.data.get('status') == 'healthy'
except Exception as e:
logger.error(f"Health check failed: {e}")
return False
|