From c2eb371bec21b7fbef29868fc6b92d1f2703d288 Mon Sep 17 00:00:00 2001 From: Alexander Vasarab Date: Thu, 2 Jul 2020 12:46:53 -0700 Subject: [PATCH] Fix issues shown by pylint(1) Here were the most common fixes: - Lots of wrong hanging indentations (bad-continuation) - Many logging-not-lazy warnings - A few unnecessary-semicolon warnings :0) - A few line-too-long warnings A few warnings were suppressed globally (.pylintrc), and in particular, in the mapping functions, several whitespace warnings were suppressed locally. --- .pylintrc | 8 ++++ infoex-autowx.py | 122 ++++++++++++++++++++++++----------------------- 2 files changed, 70 insertions(+), 60 deletions(-) create mode 100644 .pylintrc diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..be50ffa --- /dev/null +++ b/.pylintrc @@ -0,0 +1,8 @@ +[MASTER] +# justifications for disabling the following, program-wide +# +# import-error: due to importation of the zeep module, this may be +# (more correctly) fixable by pylintrc init-hook +# +# invalid-name: infoex-autowx should be infoex_autowx, but it's too ugly +disable = import-error,invalid-name diff --git a/infoex-autowx.py b/infoex-autowx.py index a16b7e6..0755e4a 100755 --- a/infoex-autowx.py +++ b/infoex-autowx.py @@ -49,20 +49,20 @@ def get_parser(): parser = OptionParser(version=__version__) parser.add_option("--config", - dest="config", - metavar="FILE", - help="location of config file") + dest="config", + metavar="FILE", + help="location of config file") parser.add_option("--log-level", - dest="log_level", - default=None, - help="set the log level (debug, info, warning)") + dest="log_level", + default=None, + help="set the log level (debug, info, warning)") parser.add_option("--dry-run", - action="store_true", - dest="dry_run", - default=False, - help="fetch data but don't upload to InfoEx") + action="store_true", + dest="dry_run", + default=False, + help="fetch data but don't upload to InfoEx") return parser @@ -102,23 +102,24 @@ def setup_config(config): station['desired_data'] = config['station']['desired_data'] # construct full API URL (sans start/end time, added later) - station['source'] = station['source'] + '?token=' + config['station']['token'] + '&within=60&units=' + station['units'] + '&stid=' + station['station_id'] + '&vars=' + station['desired_data'] - - except KeyError as e: - LOG.critical("%s not defined in %s" % (e, options.config)) - exit(1) - except Exception as exc: - LOG.critical("Exception occurred in config parsing: '%s'" % (exc)) + station['source'] = station['source'] + '?token=' + \ + config['station']['token'] + \ + '&within=60&units=' + station['units'] + \ + '&stid=' + station['station_id'] + \ + '&vars=' + station['desired_data'] + + except KeyError as err: + LOG.critical("%s not defined in configuration file", err) exit(1) # all sections/values present in config file, final sanity check try: for key in config.sections(): for subkey in config[key]: - if not len(config[key][subkey]): - raise ValueError; - except ValueError as exc: - LOG.critical("Config value '%s.%s' is empty" % (key, subkey)) + if not config[key][subkey]: + raise ValueError + except ValueError: + LOG.critical("Config value '%s.%s' is empty", key, subkey) exit(1) return (infoex, station) @@ -128,7 +129,7 @@ def setup_logging(log_level): try: from systemd.journal import JournalHandler LOG.addHandler(JournalHandler()) - except: + except ImportError: ## fallback to syslog #import logging.handlers #LOG.addHandler(logging.handlers.SysLogHandler()) @@ -185,8 +186,8 @@ def main(): (begin_date, end_date) = setup_time_values() # get the data - LOG.debug("Getting %s data from %s to %s" % (str(station['desired_data']), - str(begin_date), str(end_date))) + LOG.debug("Getting %s data from %s to %s", str(station['desired_data']), + str(begin_date), str(end_date)) time_all_elements = time.time() @@ -195,10 +196,10 @@ def main(): infoex['wx_data'] = get_nrcs_data(begin_date, end_date, station) elif station['provider'] == 'mesowest': infoex['wx_data'] = get_mesowest_data(begin_date, end_date, - station) + station) - LOG.info("Time taken to get all data : %.3f sec" % (time.time() - - time_all_elements)) + LOG.info("Time taken to get all data : %.3f sec", time.time() - + time_all_elements) LOG.debug("infoex[wx_data]: %s", str(infoex['wx_data'])) @@ -208,9 +209,9 @@ def main(): final_data[fmap['obDate']] = end_date.strftime('%m/%d/%Y') final_data[fmap['obTime']] = end_date.strftime('%H:%M') - for elementCd in infoex['wx_data']: - if elementCd not in iemap: - LOG.warning("BAD KEY wx_data['%s']" % (elementCd)) + for element_cd in infoex['wx_data']: + if element_cd not in iemap: + LOG.warning("BAD KEY wx_data['%s']", element_cd) continue # CONSIDER: Casting every value to Float() -- need to investigate if @@ -222,14 +223,14 @@ def main(): # storedUnitCd. But that's pretty network-intensive and # may not even be worth it if there's only e.g. one or two # exceptions to any otherwise uniformly Float value set. - final_data[fmap[iemap[elementCd]]] = infoex['wx_data'][elementCd] + final_data[fmap[iemap[element_cd]]] = infoex['wx_data'][element_cd] - LOG.debug("final_data: %s" % (str(final_data))) + LOG.debug("final_data: %s", str(final_data)) if not write_local_csv(infoex['csv_filename'], final_data): LOG.warning('Could not write local CSV file: %s', infoex['csv_filename']) - return 1; + return 1 if not options.dry_run: upload_csv(infoex['csv_filename'], infoex) @@ -243,16 +244,17 @@ def setup_infoex_fields_mapping(location_uuid): Create a mapping of InfoEx fields to the local data's indexing scheme. INFOEX FIELDS - + This won't earn style points in Python, but here we establish a couple of helpful mappings variables. The reason this is helpful is that the end result is simply an ordered set, the CSV file. But we still may want to manipulate the values arbitrarily before writing that file. - + Also note that the current Auto Wx InfoEx documentation shows these keys in a graphical table with the "index" beginning at 1, but here we sanely index beginning at 0. """ + # pylint: disable=too-many-statements,multiple-statements,bad-whitespace fmap = {} ; final_data = [None] * 29 fmap['Location UUID'] = 0 ; final_data[0] = location_uuid fmap['obDate'] = 1 ; final_data[1] = None @@ -322,19 +324,19 @@ def get_nrcs_data(begin, end, station): client = zeep.Client(wsdl=station['source'], transport=transport) remote_data = {} - for elementCd in station['desired_data']: + for element_cd in station['desired_data']: time_element = time.time() - # get the last three hours of data for this elementCd + # get the last three hours of data for this elementCd/element_cd tmp = client.service.getHourlyData( - stationTriplets=[station['station_id']], - elementCd=elementCd, - ordinal=1, - beginDate=begin, - endDate=end) + stationTriplets=[station['station_id']], + elementCd=element_cd, + ordinal=1, + beginDate=begin, + endDate=end) - LOG.info("Time to get elementCd '%s': %.3f sec" % (elementCd, - time.time() - time_element)) + LOG.info("Time to get NRCS elementCd '%s': %.3f sec", element_cd, + time.time() - time_element) values = tmp[0]['values'] @@ -345,9 +347,9 @@ def get_nrcs_data(begin, end, station): # so perhaps this decision will be re-evaluated in the future if values: ordered = sorted(values, key=lambda t: t['dateTime'], reverse=True) - remote_data[elementCd] = ordered[0]['value'] + remote_data[element_cd] = ordered[0]['value'] else: - remote_data[elementCd] = None + remote_data[element_cd] = None return remote_data @@ -377,7 +379,7 @@ def get_mesowest_data(begin, end, station): pos = len(observations['date_time']) - 1 - for elementCd in station['desired_data'].split(','): + for element_cd in station['desired_data'].split(','): # sort and isolate the most recent, see note above in NRCS for how and # why this is done # @@ -392,14 +394,14 @@ def get_mesowest_data(begin, end, station): # irregularities # we may not have the data at all - key_name = elementCd + '_set_1' + key_name = element_cd + '_set_1' if key_name in observations: if observations[key_name][pos]: - remote_data[elementCd] = observations[key_name][pos] + remote_data[element_cd] = observations[key_name][pos] else: - remote_data[elementCd] = None + remote_data[element_cd] = None else: - remote_data[elementCd] = None + remote_data[element_cd] = None return remote_data @@ -423,19 +425,19 @@ def switch_units_to_metric(data_map, mapping): # CSV operations def write_local_csv(path_to_file, data): """Write the specified CSV file to disk""" - with open(path_to_file, 'w') as f: + with open(path_to_file, 'w') as file_object: # The requirement is that empty values are represented in the CSV # file as "", csv.QUOTE_NONNUMERIC achieves that - LOG.debug("writing CSV file '%s'" % (path_to_file)) - writer = csv.writer(f, quoting=csv.QUOTE_NONNUMERIC) + LOG.debug("writing CSV file '%s'", path_to_file) + writer = csv.writer(file_object, quoting=csv.QUOTE_NONNUMERIC) writer.writerow(data) - f.close() + file_object.close() return True def upload_csv(path_to_file, infoex_data): """Upload the specified CSV file to InfoEx FTP and remove the file""" with open(path_to_file, 'rb') as file_object: - LOG.debug("uploading FTP file '%s'" % (infoex_data['host'])) + LOG.debug("uploading FTP file '%s'", infoex_data['host']) ftp = FTP(infoex_data['host'], infoex_data['uuid'], infoex_data['api_key']) ftp.storlines('STOR ' + path_to_file, file_object) @@ -447,10 +449,10 @@ def upload_csv(path_to_file, infoex_data): def setup_time_values(): """establish time bounds of data request(s)""" # floor time to nearest hour - dt = datetime.datetime.now() - end_date = dt - datetime.timedelta(minutes=dt.minute % 60, - seconds=dt.second, - microseconds=dt.microsecond) + date_time = datetime.datetime.now() + end_date = date_time - datetime.timedelta(minutes=date_time.minute % 60, + seconds=date_time.second, + microseconds=date_time.microsecond) begin_date = end_date - datetime.timedelta(hours=3) return (begin_date, end_date) -- 2.30.2