scc_access/scc_access.py

Fri, 12 Oct 2018 16:38:28 +0300

author
Iannis <i.binietoglou@impworks.gr>
date
Fri, 12 Oct 2018 16:38:28 +0300
changeset 31
020e80de1f64
parent 30
4669876326d4
child 32
a7b7e0056fce
permissions
-rw-r--r--

Partial clean-up after merge.

victor@7 1 import requests
moritz@29 2
ioannis@17 3 try:
ioannis@17 4 import urllib.parse as urlparse # Python 3
ioannis@17 5 except ImportError:
ioannis@17 6 import urlparse # Python 2
victor@7 7
victor@7 8 import argparse
madrouin@24 9 import datetime
madrouin@24 10 import logging
victor@7 11 import os
victor@7 12 import re
i@28 13 from io import StringIO
madrouin@24 14 import sys
victor@7 15 import time
madrouin@24 16 import urlparse
victor@7 17 from zipfile import ZipFile
madrouin@24 18
i@14 19 import yaml
victor@7 20
madrouin@24 21 requests.packages.urllib3.disable_warnings()
i@14 22 logger = logging.getLogger(__name__)
victor@7 23
victor@7 24 # The regex to find the measurement id from the measurement page
victor@7 25 # This should be read from the uploaded file, but would require an extra NetCDF module.
victor@7 26 regex = "<h3>Measurement (?P<measurement_id>.{12}) <small>"
victor@7 27
victor@7 28
victor@7 29 class SCC:
madrouin@24 30 """A simple class that will attempt to upload a file on the SCC server.
i@14 31
victor@7 32 The uploading is done by simulating a normal browser session. In the current
madrouin@20 33 version no check is performed, and no feedback is given if the upload
madrouin@20 34 was successful. If everything is setup correctly, it will work.
victor@7 35 """
victor@7 36
i@14 37 def __init__(self, auth, output_dir, base_url):
moritz@29 38
victor@7 39 self.auth = auth
victor@7 40 self.output_dir = output_dir
i@14 41 self.base_url = base_url
victor@7 42 self.session = requests.Session()
moritz@29 43 self.session.auth = auth
moritz@29 44 self.session.verify = False
i@31 45
i@14 46 self.login_url = urlparse.urljoin(self.base_url, 'accounts/login/')
i@31 47 self.logout_url = urlparse.urljoin(self.base_url, 'accounts/logout/')
i@31 48 self.list_measurements_url = urlparse.urljoin(self.base_url, 'data_processing/measurements/')
i@31 49
i@14 50 self.upload_url = urlparse.urljoin(self.base_url, 'data_processing/measurements/quick/')
moritz@29 51 self.download_preprocessed_pattern = urlparse.urljoin(self.base_url,
moritz@29 52 'data_processing/measurements/{0}/download-preprocessed/')
moritz@29 53 self.download_optical_pattern = urlparse.urljoin(self.base_url,
moritz@29 54 'data_processing/measurements/{0}/download-optical/')
moritz@29 55 self.download_graph_pattern = urlparse.urljoin(self.base_url,
moritz@29 56 'data_processing/measurements/{0}/download-plots/')
i@14 57 self.delete_measurement_pattern = urlparse.urljoin(self.base_url, 'admin/database/measurements/{0}/delete/')
i@31 58
i@14 59 self.api_base_url = urlparse.urljoin(self.base_url, 'api/v1/')
i@31 60 self.api_measurement_pattern = urlparse.urljoin(self.api_base_url, 'measurements/{0}/')
i@31 61 self.api_measurements_url = urlparse.urljoin(self.api_base_url, 'measurements')
i@14 62
i@14 63 def login(self, credentials):
i@31 64 """ Login to SCC. """
victor@7 65 logger.debug("Attempting to login to SCC, username %s." % credentials[0])
moritz@29 66 login_credentials = {'username': credentials[0],
moritz@29 67 'password': credentials[1]}
victor@7 68
i@14 69 logger.debug("Accessing login page at %s." % self.login_url)
victor@7 70
victor@7 71 # Get upload form
moritz@29 72 login_page = self.session.get(self.login_url)
victor@7 73
i@31 74 if not login_page.ok:
i@31 75 raise self.PageNotAccessibleError('Could not access login pages. Status code %s' % login_page.status_code)
victor@7 76
i@31 77 logger.debug("Submitting credentials.")
victor@7 78 # Submit the login data
i@14 79 login_submit = self.session.post(self.login_url,
moritz@29 80 data=login_credentials,
victor@7 81 headers={'X-CSRFToken': login_page.cookies['csrftoken'],
moritz@29 82 'referer': self.login_url})
victor@7 83 return login_submit
victor@7 84
victor@7 85 def logout(self):
i@31 86 """ Logout from SCC """
i@31 87 return self.session.get(self.logout_url, stream=True)
victor@7 88
i@31 89 def upload_file(self, filename, system_id, rs_filename=None, ol_filename=None, lr_filename=None):
madrouin@20 90 """ Upload a filename for processing with a specific system. If the
victor@7 91 upload is successful, it returns the measurement id. """
victor@7 92 # Get submit page
moritz@29 93 upload_page = self.session.get(self.upload_url)
victor@7 94
victor@7 95 # Submit the data
victor@7 96 upload_data = {'system': system_id}
victor@7 97 files = {'data': open(filename, 'rb')}
victor@7 98
madrouin@20 99 if rs_filename is not None:
i@31 100 logger.debug('Adding sounding file %s' % rs_filename)
madrouin@20 101 files['sounding_file'] = open(rs_filename, 'rb')
madrouin@20 102
i@31 103 if ol_filename is not None:
i@31 104 logger.debug('Adding overlap file %s' % ol_filename)
i@31 105 files['overlap_file'] = open(ol_filename, 'rb')
i@31 106
i@31 107 if lr_filename is not None:
i@31 108 logger.debug('Adding lidar ratio file %s' % lr_filename)
i@31 109 files['lidar_ratio_file'] = open(lr_filename, 'rb')
i@31 110
i@14 111 logger.info("Uploading of file %s started." % filename)
victor@7 112
i@14 113 upload_submit = self.session.post(self.upload_url,
victor@7 114 data=upload_data,
victor@7 115 files=files,
victor@7 116 headers={'X-CSRFToken': upload_page.cookies['csrftoken'],
moritz@29 117 'referer': self.upload_url})
victor@7 118
victor@7 119 if upload_submit.status_code != 200:
i@14 120 logger.warning("Connection error. Status code: %s" % upload_submit.status_code)
victor@7 121 return False
victor@7 122
victor@7 123 # Check if there was a redirect to a new page.
i@14 124 if upload_submit.url == self.upload_url:
victor@7 125 measurement_id = False
i@14 126 logger.error("Uploaded file rejected! Try to upload manually to see the error.")
victor@7 127 else:
victor@7 128 measurement_id = re.findall(regex, upload_submit.text)[0]
madrouin@23 129 logger.info("Successfully uploaded measurement with id %s." % measurement_id)
victor@7 130
victor@7 131 return measurement_id
victor@7 132
victor@7 133 def download_files(self, measurement_id, subdir, download_url):
victor@7 134 """ Downloads some files from the download_url to the specified
madrouin@20 135 subdir. This method is used to download preprocessed file, optical
victor@7 136 files etc.
victor@7 137 """
victor@7 138 # Get the file
moritz@29 139 request = self.session.get(download_url, stream=True)
moritz@29 140
moritz@29 141 if not request.ok:
moritz@29 142 raise Exception("Could not download files for measurement '%s'" % measurement_id)
victor@7 143
victor@7 144 # Create the dir if it does not exist
victor@7 145 local_dir = os.path.join(self.output_dir, measurement_id, subdir)
victor@7 146 if not os.path.exists(local_dir):
victor@7 147 os.makedirs(local_dir)
victor@7 148
victor@7 149 # Save the file by chunk, needed if the file is big.
ioannis@17 150 memory_file = StringIO()
victor@7 151
victor@7 152 for chunk in request.iter_content(chunk_size=1024):
victor@7 153 if chunk: # filter out keep-alive new chunks
victor@7 154 memory_file.write(chunk)
victor@7 155 memory_file.flush()
victor@7 156
victor@7 157 zip_file = ZipFile(memory_file)
victor@7 158
victor@7 159 for ziped_name in zip_file.namelist():
victor@7 160 basename = os.path.basename(ziped_name)
victor@7 161
victor@7 162 local_file = os.path.join(local_dir, basename)
victor@7 163
victor@7 164 with open(local_file, 'wb') as f:
victor@7 165 f.write(zip_file.read(ziped_name))
victor@7 166
victor@7 167 def download_preprocessed(self, measurement_id):
victor@7 168 """ Download preprocessed files for the measurement id. """
victor@7 169 # Construct the download url
i@14 170 download_url = self.download_preprocessed_pattern.format(measurement_id)
victor@7 171 self.download_files(measurement_id, 'scc_preprocessed', download_url)
victor@7 172
victor@7 173 def download_optical(self, measurement_id):
victor@7 174 """ Download optical files for the measurement id. """
victor@7 175 # Construct the download url
moritz@29 176 download_url = self.download_optical_pattern.format(measurement_id)
victor@7 177 self.download_files(measurement_id, 'scc_optical', download_url)
victor@7 178
victor@7 179 def download_graphs(self, measurement_id):
victor@7 180 """ Download profile graphs for the measurement id. """
victor@7 181 # Construct the download url
i@14 182 download_url = self.download_graph_pattern.format(measurement_id)
victor@7 183 self.download_files(measurement_id, 'scc_plots', download_url)
victor@7 184
victor@7 185 def rerun_processing(self, measurement_id, monitor=True):
madrouin@26 186 measurement, status = self.get_measurement(measurement_id)
victor@7 187
victor@7 188 if measurement:
moritz@29 189 request = self.session.get(measurement.rerun_processing_url, stream=True)
victor@7 190
victor@7 191 if request.status_code != 200:
i@14 192 logger.error(
i@14 193 "Could not rerun processing for %s. Status code: %s" % (measurement_id, request.status_code))
victor@7 194 return
victor@7 195
victor@7 196 if monitor:
victor@7 197 self.monitor_processing(measurement_id)
victor@7 198
victor@7 199 def rerun_all(self, measurement_id, monitor=True):
victor@7 200 logger.debug("Started rerun_all procedure.")
victor@7 201
victor@7 202 logger.debug("Getting measurement %s" % measurement_id)
madrouin@26 203 measurement, status = self.get_measurement(measurement_id)
victor@7 204
victor@7 205 if measurement:
victor@7 206 logger.debug("Attempting to rerun all processing through %s." % measurement.rerun_all_url)
victor@7 207
moritz@29 208 request = self.session.get(measurement.rerun_all_url, stream=True)
victor@7 209
victor@7 210 if request.status_code != 200:
victor@7 211 logger.error("Could not rerun pre processing for %s. Status code: %s" %
victor@7 212 (measurement_id, request.status_code))
victor@7 213 return
victor@7 214
victor@7 215 if monitor:
victor@7 216 self.monitor_processing(measurement_id)
victor@7 217
i@30 218 def process(self, filename, system_id, monitor, rs_filename=None):
victor@7 219 """ Upload a file for processing and wait for the processing to finish.
victor@7 220 If the processing is successful, it will download all produced files.
victor@7 221 """
victor@7 222 logger.info("--- Processing started on %s. ---" % datetime.datetime.now())
victor@7 223 # Upload file
madrouin@26 224 logger.info("--- Uploading file")
madrouin@21 225 measurement_id = self.upload_file(filename, system_id, rs_filename=rs_filename)
victor@7 226
madrouin@26 227 logger.info("--- Monitoring processing")
moritz@29 228 if monitor:
moritz@29 229 return self.monitor_processing(measurement_id)
moritz@29 230 return None
victor@7 231
victor@7 232 def monitor_processing(self, measurement_id):
victor@7 233 """ Monitor the processing progress of a measurement id"""
victor@7 234
madrouin@24 235 # try to deal with error 404
madrouin@24 236 error_count = 0
madrouin@24 237 error_max = 6
madrouin@26 238 time_sleep = 10
madrouin@24 239
madrouin@25 240 # try to wait for measurement to appear in API
madrouin@24 241 measurement = None
madrouin@26 242 logger.info("looking for measurement %s in SCC", measurement_id)
madrouin@26 243 while error_count < error_max:
madrouin@26 244 time.sleep(time_sleep)
madrouin@26 245 measurement, status = self.get_measurement(measurement_id)
madrouin@26 246 if status != 200 and error_count < error_max:
madrouin@26 247 logger.error("measurement not found. waiting %ds", time_sleep)
madrouin@24 248 error_count += 1
madrouin@26 249 else:
madrouin@26 250 break
madrouin@24 251
madrouin@24 252 if error_count == error_max:
madrouin@24 253 logger.critical("measurement %s doesn't seem to exist", measurement_id)
madrouin@26 254 sys.exit(1)
madrouin@26 255
madrouin@26 256 logger.info('measurement %s found', measurement_id)
madrouin@24 257
victor@7 258 if measurement is not None:
victor@7 259 while measurement.is_running:
madrouin@24 260 logger.info("Measurement is being processed (status: %s, %s, %s). Please wait.", measurement.upload, measurement.pre_processing, measurement.processing)
victor@7 261 time.sleep(10)
madrouin@26 262 measurement, status = self.get_measurement(measurement_id)
madrouin@24 263
i@31 264 logger.info("Measurement processing finished (status: %s, %s, %s).", measurement.upload, measurement.pre_processing, measurement.processing)
victor@7 265 if measurement.pre_processing == 127:
victor@7 266 logger.info("Downloading preprocessed files.")
victor@7 267 self.download_preprocessed(measurement_id)
victor@7 268 if measurement.processing == 127:
victor@7 269 logger.info("Downloading optical files.")
victor@7 270 self.download_optical(measurement_id)
victor@7 271 logger.info("Downloading graphs.")
victor@7 272 self.download_graphs(measurement_id)
victor@7 273 logger.info("--- Processing finished. ---")
victor@7 274 return measurement
victor@7 275
victor@7 276 def get_measurement(self, measurement_id):
i@31 277 measurement_url = self.api_measurement_pattern.format(measurement_id)
i@31 278 logger.debug("Measurement API URL: %s" % measurement_url)
victor@7 279
moritz@29 280 response = self.session.get(measurement_url)
victor@7 281
moritz@29 282 if not response.ok:
i@14 283 logger.error('Could not access API. Status code %s.' % response.status_code)
madrouin@26 284 return None, response.status_code
i@14 285
victor@7 286 response_dict = response.json()
victor@7 287
victor@7 288 if response_dict:
moritz@29 289 measurement = Measurement(self.base_url, response_dict)
madrouin@26 290 return measurement, response.status_code
victor@7 291 else:
victor@7 292 logger.error("No measurement with id %s found on the SCC." % measurement_id)
madrouin@26 293 return None, response.status_code
victor@7 294
victor@7 295 def delete_measurement(self, measurement_id):
victor@7 296 """ Deletes a measurement with the provided measurement id. The user
madrouin@20 297 should have the appropriate permissions.
madrouin@20 298
victor@7 299 The procedures is performed directly through the web interface and
victor@7 300 NOT through the API.
victor@7 301 """
victor@7 302 # Get the measurement object
i@31 303 measurement, _ = self.get_measurement(measurement_id)
victor@7 304
victor@7 305 # Check that it exists
victor@7 306 if measurement is None:
victor@7 307 logger.warning("Nothing to delete.")
victor@7 308 return None
victor@7 309
victor@7 310 # Go the the page confirming the deletion
moritz@29 311 delete_url = self.delete_measurement_pattern.format(measurement_id)
victor@7 312
moritz@29 313 confirm_page = self.session.get(delete_url)
victor@7 314
victor@7 315 # Check that the page opened properly
victor@7 316 if confirm_page.status_code != 200:
victor@7 317 logger.warning("Could not open delete page. Status: {0}".format(confirm_page.status_code))
victor@7 318 return None
victor@7 319
victor@7 320 # Delete the measurement
victor@7 321 delete_page = self.session.post(delete_url,
victor@7 322 data={'post': 'yes'},
victor@7 323 headers={'X-CSRFToken': confirm_page.cookies['csrftoken'],
victor@7 324 'referer': delete_url}
victor@7 325 )
i@31 326 if not delete_page.ok:
victor@7 327 logger.warning("Something went wrong. Delete page status: {0}".format(
victor@7 328 delete_page.status_code))
victor@7 329 return None
victor@7 330
victor@7 331 logger.info("Deleted measurement {0}".format(measurement_id))
victor@7 332 return True
victor@7 333
victor@7 334 def available_measurements(self):
victor@7 335 """ Get a list of available measurement on the SCC. """
i@31 336 response = self.session.get(self.api_measurements_url)
victor@7 337 response_dict = response.json()
victor@7 338
victor@7 339 if response_dict:
victor@7 340 measurement_list = response_dict['objects']
i@14 341 measurements = [Measurement(self.base_url, measurement_dict) for measurement_dict in measurement_list]
victor@7 342 logger.info("Found %s measurements on the SCC." % len(measurements))
victor@7 343 else:
victor@7 344 logger.warning("No response received from the SCC when asked for available measurements.")
i@31 345 measurements = None
victor@7 346
victor@7 347 return measurements
victor@7 348
moritz@29 349 def list_measurements(self, station=None, system=None, start=None, stop=None, upload_status=None,
moritz@29 350 processing_status=None, optical_processing=None):
moritz@29 351
i@31 352 # TODO: Change this to work through the API
i@31 353
moritz@29 354 # Need to set to empty string if not specified, we won't get any results
moritz@29 355 params = {
moritz@29 356 "station": station if station is not None else "",
moritz@29 357 "system": system if system is not None else "",
moritz@29 358 "stop": stop if stop is not None else "",
moritz@29 359 "start": start if start is not None else "",
moritz@29 360 "upload_status": upload_status if upload_status is not None else "",
moritz@29 361 "preprocessing_status": processing_status if processing_status is not None else "",
moritz@29 362 "optical_processing_status": optical_processing if optical_processing is not None else ""
moritz@29 363 }
i@31 364
i@31 365 response_txt = self.session.get(self.list_measurements_url, params=params).text
moritz@29 366 tbl_rgx = re.compile(r'<table id="measurements">(.*?)</table>', re.DOTALL)
moritz@29 367 entry_rgx = re.compile(r'<tr>(.*?)</tr>', re.DOTALL)
moritz@29 368 measurement_rgx = re.compile(
moritz@29 369 r'.*?<td><a[^>]*>(\w+)</a>.*?<td>.*?<td>([\w-]+ [\w:]+)</td>.*<td data-order="([-]?\d+),([-]?\d+),([-]?\d+)".*',
moritz@29 370 re.DOTALL)
i@31 371 matches = tbl_rgx.findall(response_txt)
moritz@29 372 if len(matches) != 1:
moritz@29 373 return []
moritz@29 374
moritz@29 375 ret = []
moritz@29 376 for entry in entry_rgx.finditer(matches[0]):
moritz@29 377 m = measurement_rgx.match(entry.string[entry.start(0):entry.end(0)])
moritz@29 378 if m:
moritz@29 379 name, date, upload, preproc, optical = m.groups()
moritz@29 380 ret.append(
moritz@29 381 Measurement(self.base_url, {"id": name, "upload": int(upload), "pre_processing": int(preproc),
moritz@29 382 "processing": int(optical)}))
moritz@29 383
moritz@29 384 return ret
moritz@29 385
i@31 386 def measurement_id_for_date(self, t1, call_sign, base_number=0):
victor@7 387 """ Give the first available measurement id on the SCC for the specific
madrouin@20 388 date.
victor@7 389 """
victor@7 390 date_str = t1.strftime('%Y%m%d')
i@31 391 base_id = "%s%s" % (date_str, call_sign)
i@31 392 search_url = urlparse.urljoin(self.api_base_url, 'measurements/?id__startswith=%s' % base_id)
victor@7 393
moritz@29 394 response = self.session.get(search_url)
victor@7 395
victor@7 396 response_dict = response.json()
victor@7 397
victor@7 398 measurement_id = None
victor@7 399
victor@7 400 if response_dict:
victor@7 401 measurement_list = response_dict['objects']
i@31 402
i@31 403 if len(measurement_list) == 100:
i@31 404 raise ValueError('No available measurement id found.')
i@31 405
victor@7 406 existing_ids = [measurement_dict['id'] for measurement_dict in measurement_list]
victor@7 407
victor@7 408 measurement_number = base_number
i@31 409 measurement_id = "%s%02i" % (base_id, measurement_number)
victor@7 410
victor@7 411 while measurement_id in existing_ids:
victor@7 412 measurement_number = measurement_number + 1
i@31 413 measurement_id = "%s%02i" % (base_id, measurement_number)
victor@7 414
victor@7 415 return measurement_id
victor@7 416
i@31 417 class PageNotAccessibleError(RuntimeError):
i@31 418 pass
i@31 419
victor@7 420
ioannis@17 421 class ApiObject(object):
victor@7 422 """ A generic class object. """
victor@7 423
i@14 424 def __init__(self, base_url, dict_response):
i@14 425 self.base_url = base_url
victor@7 426
victor@7 427 if dict_response:
victor@7 428 # Add the dictionary key value pairs as object properties
victor@7 429 for key, value in dict_response.items():
ioannis@17 430 # logger.debug('Setting key {0} to value {1}'.format(key, value))
ioannis@17 431 try:
ioannis@17 432 setattr(self, key, value)
ioannis@17 433 except:
ioannis@17 434 logger.warning('Could not set attribute {0} to value {1}'.format(key, value))
victor@7 435 self.exists = True
victor@7 436 else:
victor@7 437 self.exists = False
victor@7 438
victor@7 439
victor@7 440 class Measurement(ApiObject):
victor@7 441 """ This class represents the measurement object as returned in the SCC API.
victor@7 442 """
victor@7 443
victor@7 444 @property
victor@7 445 def rerun_processing_url(self):
i@14 446 url_pattern = urlparse.urljoin(self.base_url, 'data_processing/measurements/{0}/rerun-optical/')
i@14 447 return url_pattern.format(self.id)
victor@7 448
victor@7 449 @property
victor@7 450 def rerun_all_url(self):
i@14 451 ulr_pattern = urlparse.urljoin(self.base_url, 'data_processing/measurements/{0}/rerun-all/')
i@14 452 return ulr_pattern.format(self.id)
victor@7 453
victor@7 454 def __str__(self):
victor@7 455 return "%s: %s, %s, %s" % (self.id,
victor@7 456 self.upload,
victor@7 457 self.pre_processing,
victor@7 458 self.processing)
victor@7 459
victor@7 460
madrouin@20 461 def upload_file(filename, system_id, settings, rs_filename=None):
victor@7 462 """ Shortcut function to upload a file to the SCC. """
victor@7 463 logger.info("Uploading file %s, using sytem %s" % (filename, system_id))
victor@7 464
i@14 465 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
i@14 466 scc.login(settings['website_credentials'])
madrouin@20 467 measurement_id = scc.upload_file(filename, system_id, rs_filename=rs_filename)
victor@7 468 scc.logout()
victor@7 469 return measurement_id
victor@7 470
victor@7 471
madrouin@21 472 def process_file(filename, system_id, settings, rs_filename=None):
victor@7 473 """ Shortcut function to process a file to the SCC. """
victor@7 474 logger.info("Processing file %s, using sytem %s" % (filename, system_id))
victor@7 475
i@14 476 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
i@14 477 scc.login(settings['website_credentials'])
madrouin@21 478 measurement = scc.process(filename, system_id, rs_filename=rs_filename)
victor@7 479 scc.logout()
victor@7 480 return measurement
victor@7 481
victor@7 482
moritz@29 483 def delete_measurement(measurement_ids, settings):
moritz@29 484 """ Shortcut function to delete measurements from the SCC. """
moritz@29 485 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
moritz@29 486 scc.login(settings['website_credentials'])
moritz@29 487 for m_id in measurement_ids:
moritz@29 488 logger.info("Deleting %s" % m_id)
moritz@29 489 scc.delete_measurement(m_id)
moritz@29 490 scc.logout()
moritz@29 491
moritz@29 492
moritz@29 493 def rerun_all(measurement_ids, monitor, settings):
moritz@29 494 """ Shortcut function to rerun measurements from the SCC. """
i@14 495
i@14 496 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
i@14 497 scc.login(settings['website_credentials'])
moritz@29 498 for m_id in measurement_ids:
moritz@29 499 logger.info("Rerunning all products for %s" % m_id)
moritz@29 500 scc.rerun_all(m_id, monitor)
victor@7 501 scc.logout()
victor@7 502
victor@7 503
moritz@29 504 def rerun_processing(measurement_ids, monitor, settings):
victor@7 505 """ Shortcut function to delete a measurement from the SCC. """
i@14 506
i@14 507 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
i@14 508 scc.login(settings['website_credentials'])
moritz@29 509 for m_id in measurement_ids:
moritz@29 510 logger.info("Rerunning (optical) processing for %s" % m_id)
moritz@29 511 scc.rerun_processing(m_id, monitor)
moritz@29 512 scc.logout()
moritz@29 513
moritz@29 514
moritz@29 515 def list_measurements(settings, station=None, system=None, start=None, stop=None, upload_status=None,
moritz@29 516 preprocessing_status=None,
moritz@29 517 optical_processing=None):
moritz@29 518 """List all available measurements"""
moritz@29 519 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
moritz@29 520 scc.login(settings['website_credentials'])
moritz@29 521 ret = scc.list_measurements(station=station, system=system, start=start, stop=stop, upload_status=upload_status,
moritz@29 522 processing_status=preprocessing_status, optical_processing=optical_processing)
moritz@29 523 for entry in ret:
moritz@29 524 print("%s" % entry.id)
victor@7 525 scc.logout()
victor@7 526
victor@7 527
moritz@29 528 def download_measurements(measurement_ids, download_preproc, download_optical, download_graph, settings):
moritz@29 529 """Download all measurements for the specified IDs"""
i@14 530 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
i@14 531 scc.login(settings['website_credentials'])
moritz@29 532 for m_id in measurement_ids:
moritz@29 533 if download_preproc:
moritz@29 534 logger.info("Downloading preprocessed files for '%s'" % m_id)
moritz@29 535 scc.download_preprocessed(m_id)
moritz@29 536 logger.info("Complete")
moritz@29 537 if download_optical:
moritz@29 538 logger.info("Downloading optical files for '%s'" % m_id)
moritz@29 539 scc.download_optical(m_id)
moritz@29 540 logger.info("Complete")
moritz@29 541 if download_graph:
moritz@29 542 logger.info("Downloading profile graph files for '%s'" % m_id)
moritz@29 543 scc.download_graphs(m_id)
moritz@29 544 logger.info("Complete")
i@14 545
i@14 546
moritz@29 547 def settings_from_path(config_file_path):
i@14 548 """ Read the configuration file.
i@14 549
i@14 550 The file should be in YAML syntax."""
i@14 551
i@14 552 if not os.path.isfile(config_file_path):
moritz@29 553 raise argparse.ArgumentTypeError("Wrong path for configuration file (%s)" % config_file_path)
i@14 554
i@14 555 with open(config_file_path) as yaml_file:
i@14 556 try:
i@14 557 settings = yaml.safe_load(yaml_file)
i@14 558 logger.debug("Read settings file(%s)" % config_file_path)
moritz@29 559 except Exception:
moritz@29 560 raise argparse.ArgumentTypeError("Could not parse YAML file (%s)" % config_file_path)
i@14 561
i@14 562 # YAML limitation: does not read tuples
i@14 563 settings['basic_credentials'] = tuple(settings['basic_credentials'])
i@14 564 settings['website_credentials'] = tuple(settings['website_credentials'])
i@14 565 return settings
i@14 566
i@14 567
moritz@29 568 # Setup for command specific parsers
moritz@29 569 def setup_delete(parser):
moritz@29 570 def delete_from_args(parsed):
moritz@29 571 delete_measurement(parsed.IDs, parsed.config)
moritz@29 572
moritz@29 573 parser.add_argument("IDs", nargs="+", help="measurement IDs to delete.")
moritz@29 574 parser.set_defaults(execute=delete_from_args)
moritz@29 575
moritz@29 576
moritz@29 577 def setup_rerun_all(parser):
moritz@29 578 def rerun_all_from_args(parsed):
moritz@29 579 rerun_all(parsed.IDs, parsed.process, parsed.config)
moritz@29 580
moritz@29 581 parser.add_argument("IDs", nargs="+", help="Measurement IDs to rerun.")
moritz@29 582 parser.add_argument("-p", "--process", help="Wait for the results of the processing.",
moritz@29 583 action="store_true")
moritz@29 584 parser.set_defaults(execute=rerun_all_from_args)
moritz@29 585
moritz@29 586
moritz@29 587 def setup_rerun_processing(parser):
moritz@29 588 def rerun_processing_from_args(parsed):
moritz@29 589 rerun_processing(parsed.IDs, parsed.process, parsed.config)
moritz@29 590
moritz@29 591 parser.add_argument("IDs", nargs="+", help="Measurement IDs to rerun the processing on.")
moritz@29 592 parser.add_argument("-p", "--process", help="Wait for the results of the processing.",
moritz@29 593 action="store_true")
moritz@29 594 parser.set_defaults(execute=rerun_processing_from_args)
moritz@29 595
moritz@29 596
moritz@29 597 def setup_process_file(parser):
moritz@29 598 def process_file_from_args(parsed):
i@30 599 process_file(parsed.file, parsed.system, parsed.process, parsed.config, parsed.radiosounding)
moritz@29 600
moritz@29 601 parser.add_argument("filename", help="Measurement file name or path.")
moritz@29 602 parser.add_argument("system", help="Processing system id.")
i@30 603 parser.add_argument("--radiosounding", default=None, help="Radiosounding file name or path")
moritz@29 604 parser.add_argument("-p", "--process", help="Wait for the results of the processing.",
moritz@29 605 action="store_true")
moritz@29 606 parser.set_defaults(execute=process_file_from_args)
moritz@29 607
moritz@29 608
moritz@29 609 def setup_upload_file(parser):
moritz@29 610 def upload_file_from_args(parsed):
i@30 611 upload_file(parsed.file, parsed.system, parsed.config, parsed.radiosounding)
moritz@29 612
moritz@29 613 parser.add_argument("filename", help="Measurement file name or path.")
moritz@29 614 parser.add_argument("system", help="Processing system id.")
i@30 615 parser.add_argument("--radiosounding", default=None, help="Radiosounding file name or path")
i@30 616
moritz@29 617 parser.set_defaults(execute=upload_file_from_args)
moritz@29 618
moritz@29 619
moritz@29 620 def setup_list_measurements(parser):
moritz@29 621 def list_measurements_from_args(parsed):
moritz@29 622 list_measurements(parsed.config, station=parsed.station, system=parsed.system, start=parsed.start,
moritz@29 623 stop=parsed.stop,
moritz@29 624 upload_status=parsed.upload_status, preprocessing_status=parsed.preprocessing_status,
moritz@29 625 optical_processing=parsed.optical_processing_status)
moritz@29 626
moritz@29 627 def status(arg):
moritz@29 628 if -127 <= int(arg) <= 127:
moritz@29 629 return arg
moritz@29 630 else:
moritz@29 631 raise argparse.ArgumentTypeError("Status must be between -127 and 127")
moritz@29 632
moritz@29 633 def date(arg):
moritz@29 634 if re.match(r'\d{4}-\d{2}-\d{2}', arg):
moritz@29 635 return arg
moritz@29 636 else:
moritz@29 637 raise argparse.ArgumentTypeError("Date must be in format 'YYYY-MM-DD'")
moritz@29 638
moritz@29 639 parser.add_argument("--station", help="Filter for only the selected station")
moritz@29 640 parser.add_argument("--system", help="Filter for only the selected station")
moritz@29 641 parser.add_argument("--start", help="Filter for only the selected station", type=date)
moritz@29 642 parser.add_argument("--stop", help="Filter for only the selected station", type=date)
moritz@29 643 parser.add_argument("--upload-status", help="Filter for only the selected station", type=status)
moritz@29 644 parser.add_argument("--preprocessing-status", help="Filter for only the selected station", type=status)
moritz@29 645 parser.add_argument("--optical-processing-status", help="Filter for only the selected station", type=status)
moritz@29 646 parser.set_defaults(execute=list_measurements_from_args)
moritz@29 647
moritz@29 648
moritz@29 649 def setup_download_measurements(parser):
moritz@29 650 def download_measurements_from_args(parsed):
moritz@29 651 preproc = parsed.download_preprocessed
moritz@29 652 optical = parsed.download_optical
moritz@29 653 graphs = parsed.download_profile_graphs
moritz@29 654 if not preproc and not graphs:
moritz@29 655 optical = True
moritz@29 656 download_measurements(parsed.IDs, preproc, optical, graphs, parsed.config)
moritz@29 657
moritz@29 658 parser.add_argument("IDs", help="Measurement IDs that should be downloaded.", nargs="+")
moritz@29 659 parser.add_argument("--download-preprocessed", action="store_true", help="Download preprocessed files.")
moritz@29 660 parser.add_argument("--download-optical", action="store_true",
moritz@29 661 help="Download optical files (default if no other download is used).")
moritz@29 662 parser.add_argument("--download-profile-graphs", action="store_true", help="Download profile graph files.")
moritz@29 663 parser.set_defaults(execute=download_measurements_from_args)
moritz@29 664
moritz@29 665
victor@7 666 def main():
victor@7 667 # Define the command line arguments.
victor@7 668 parser = argparse.ArgumentParser()
moritz@29 669 subparsers = parser.add_subparsers()
moritz@29 670
moritz@29 671 delete_parser = subparsers.add_parser("delete", help="Deletes a measurement.")
moritz@29 672 rerun_all_parser = subparsers.add_parser("rerun-all", help="Rerun a measurement.")
moritz@29 673 rerun_processing_parser = subparsers.add_parser("rerun-processing",
moritz@29 674 help="Rerun processing routings for a measurement.")
moritz@29 675 process_file_parser = subparsers.add_parser("process-file", help="Process a file.")
moritz@29 676 upload_file_parser = subparsers.add_parser("upload-file", help="Upload a file.")
moritz@29 677 list_parser = subparsers.add_parser("list", help="List all measurements.")
moritz@29 678 download_parser = subparsers.add_parser("download", help="Download selected measurements.")
moritz@29 679
moritz@29 680 setup_delete(delete_parser)
moritz@29 681 setup_rerun_all(rerun_all_parser)
moritz@29 682 setup_rerun_processing(rerun_processing_parser)
moritz@29 683 setup_process_file(process_file_parser)
moritz@29 684 setup_upload_file(upload_file_parser)
moritz@29 685 setup_list_measurements(list_parser)
moritz@29 686 setup_download_measurements(download_parser)
victor@7 687
victor@7 688 # Verbosity settings from http://stackoverflow.com/a/20663028
victor@7 689 parser.add_argument('-d', '--debug', help="Print debugging information.", action="store_const",
victor@7 690 dest="loglevel", const=logging.DEBUG, default=logging.INFO,
victor@7 691 )
victor@7 692 parser.add_argument('-s', '--silent', help="Show only warning and error messages.", action="store_const",
victor@7 693 dest="loglevel", const=logging.WARNING
victor@7 694 )
victor@7 695
moritz@29 696 home = os.path.expanduser("~")
moritz@29 697 default_config_location = os.path.abspath(os.path.join(home, ".scc_access.yaml"))
moritz@29 698 parser.add_argument("-c", "--config", help="Path to the config file.", type=settings_from_path,
moritz@29 699 default=default_config_location)
moritz@29 700
victor@7 701 args = parser.parse_args()
victor@7 702
victor@7 703 # Get the logger with the appropriate level
victor@7 704 logging.basicConfig(format='%(levelname)s: %(message)s', level=args.loglevel)
victor@7 705
moritz@29 706 # Dispatch to appropriate function
moritz@29 707 args.execute(args)
moritz@29 708
i@14 709
moritz@29 710 # When running through terminal
moritz@29 711 if __name__ == '__main__':
moritz@29 712 main()

mercurial