Changeset ff99eae in flex_extract.git for python/tools.py

Timestamp:

Jun 1, 2018, 8:34:59 PM (6 years ago)

Author:

Anne Philipp <anne.philipp@…>

Branches:

master, ctbto, dev

Children:

e1228f3

Parents:

ccab809

Message:

completed application of pep8 style guide and pylint investigations. added documentation almost everywhere

File:

• python/tools.py (moved) (moved from python/Tools.py) (20 diffs)

python/tools.py

@@ -2 +2 @@
 # -*- coding: utf-8 -*-
 #************************************************************************
-# TODO AP
-# - check myerror
-# - check normalexit
-# - check getListAsString
+# ToDo AP
+# - check my_error
+# - check normal_exit
+# - check get_list_as_string
 # - seperate args and control interpretation
 #************************************************************************
@@ -15 +15 @@
 # @Change History:
 #    October 2014 - Anne Fouilloux (University of Oslo)
-#        - created functions silentremove and product (taken from ECMWF)
+#        - created functions silent_remove and product (taken from ECMWF)
 #
 #    November 2015 - Leopold Haimberger (University of Vienna)
-#        - created functions: interpret_args_and_control, cleanup
-#          myerror, normalexit, init128, toparamId
+#        - created functions: interpret_args_and_control, clean_up
+#          my_error, normal_exit, init128, to_param_id
 #
 #    April 2018 - Anne Philipp (University of Vienna):
 #        - applied PEP8 style guide
 #        - added documentation
-#        - moved all functions from file FlexpartTools to this file Tools
-#        - added function getListAsString
+#        - moved all functions from file Flexparttools to this file tools
+#        - added function get_list_as_string
 #
 # @License:
@@ -39 +39 @@
 # @Module Content:
 #    - interpret_args_and_control
-#    - cleanup
-#    - myerror
-#    - normalexit
+#    - clean_up
+#    - my_error
+#    - normal_exit
 #    - product
-#    - silentremove
+#    - silent_remove
 #    - init128
-#    - toparamId
-#    - getListAsString
+#    - to_param_id
+#    - get_list_as_string
 #
 #*******************************************************************************
@@ -57 +57 @@
 import sys
 import glob
+import inspect
+import subprocess
 import traceback
-from numpy import *
-from gribapi import *
 from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter
+import numpy as np
 
 # software specific class from flex_extract
@@ -123 +124 @@
     parser.add_argument("--flexpart_root_scripts", dest="flexpart_root_scripts",
                         help="FLEXPART root directory (to find grib2flexpart \
-                        and COMMAND file)\n\ Normally ECMWFDATA resides in \
+                        and COMMAND file)\n Normally ECMWFDATA resides in \
                         the scripts directory of the FLEXPART distribution")
 
-    # this is only used by prepareFLEXPART.py to rerun a postprocessing step
+    # this is only used by prepare_flexpart.py to rerun a postprocessing step
     parser.add_argument("--ppid", dest="ppid",
                         help="Specify parent process id for \
-                        rerun of prepareFLEXPART")
+                        rerun of prepare_flexpart")
 
     # arguments for job submission to ECMWF, only needed by submit.py
@@ -152 +153 @@
     except IOError:
         try:
-            c = ControlFile(localpythonpath + args.controlfile)
-        except:
-            print('Could not read CONTROL file "' + args.controlfile + '"')
-            print('Either it does not exist or its syntax is wrong.')
-            print('Try "' + sys.argv[0].split('/')[-1] +
-                  ' -h" to print usage information')
+            LOCAL_PYTHON_PATH = os.path.dirname(os.path.abspath(
+                inspect.getfile(inspect.currentframe())))
+            c = ControlFile(LOCAL_PYTHON_PATH + args.controlfile)
+        except IOError:
+            print 'Could not read CONTROL file "' + args.controlfile + '"'
+            print 'Either it does not exist or its syntax is wrong.'
+            print 'Try "' + sys.argv[0].split('/')[-1] + \
+                  ' -h" to print usage information'
             exit(1)
 
     # check for having at least a starting date
     if  args.start_date is None and getattr(c, 'start_date') is None:
-        print('start_date specified neither in command line nor \
-               in CONTROL file ' + args.controlfile)
-        print('Try "' + sys.argv[0].split('/')[-1] +
-              ' -h" to print usage information')
+        print 'start_date specified neither in command line nor \
+               in CONTROL file ' + args.controlfile
+        print 'Try "' + sys.argv[0].split('/')[-1] + \
+              ' -h" to print usage information'
         exit(1)
 
@@ -206 +209 @@
         l = args.area.split('/')
         if afloat:
-            for i in range(len(l)):
-                l[i] = str(int(float(l[i]) * 1000))
+            for i, item in enumerate(l):
+                item = str(int(float(item) * 1000))
         c.upper, c.left, c.lower, c.right = l
 
@@ -218 +221 @@
         if 'to' in args.step.lower():
             if 'by' in args.step.lower():
-                ilist = arange(int(l[0]), int(l[2]) + 1, int(l[4]))
+                ilist = np.arange(int(l[0]), int(l[2]) + 1, int(l[4]))
                 c.step = ['{:0>3}'.format(i) for i in ilist]
             else:
-                myerror(None, args.step + ':\n' +
-                        'please use "by" as well if "to" is used')
+                my_error(None, args.step + ':\n' +
+                         'please use "by" as well if "to" is used')
         else:
             c.step = l
@@ -239 +242 @@
 
 
-def cleanup(c):
+def clean_up(c):
     '''
     @Description:
@@ -263 +266 @@
     '''
 
-    print("cleanup")
+    print "clean_up"
 
     cleanlist = glob.glob(c.inputdir + "/*")
     for cl in cleanlist:
         if c.prefix not in cl:
-            silentremove(cl)
+            silent_remove(cl)
         if c.ecapi is False and (c.ectrans == '1' or c.ecstorage == '1'):
-            silentremove(cl)
-
-    print("Done")
+            silent_remove(cl)
+
+    print "Done"
 
     return
 
 
-def myerror(c, message='ERROR'):
+def my_error(c, message='ERROR'):
     '''
     @Description:
@@ -303 +306 @@
         <nothing>
     '''
-    # uncomment if user wants email notification directly from python
-    #try:
-        #target = c.mailfail
-    #except AttributeError:
-        #target = os.getenv('USER')
-
-    #if(type(target) is not list):
-        #target = [target]
-
-    print(message)
-
-    # uncomment if user wants email notification directly from python
-    #for t in target:
-    #p = subprocess.Popen(['mail','-s ECMWFDATA v7.0 ERROR', os.path.expandvars(t)],
-    #                     stdin = subprocess.PIPE, stdout = subprocess.PIPE,
-    #                     stderr = subprocess.PIPE, bufsize = 1)
-    #tr = '\n'.join(traceback.format_stack())
-    #pout = p.communicate(input = message+'\n\n'+tr)[0]
-    #print 'Email sent to '+os.path.expandvars(t) # +' '+pout.decode()
+
+    print message
+
+    # comment if user does not want email notification directly from python
+    try:
+        target = []
+        target.extend(c.mailfail)
+    except AttributeError:
+        target = []
+        target.extend(os.getenv('USER'))
+
+    for t in target:
+        p = subprocess.Popen(['mail', '-s ECMWFDATA v7.0 ERROR',
+                              os.path.expandvars(t)],
+                             stdin=subprocess.PIPE,
+                             stdout=subprocess.PIPE,
+                             stderr=subprocess.PIPE,
+                             bufsize=1)
+        tr = '\n'.join(traceback.format_stack())
+        pout = p.communicate(input=message + '\n\n' + tr)[0]
+        print 'Email sent to ' + os.path.expandvars(t) + ' ' + pout.decode()
 
     exit(1)
@@ -328 +333 @@
 
 
-def normalexit(c, message='Done!'):
+def normal_exit(c, message='Done!'):
     '''
     @Description:
@@ -354 +359 @@
 
     '''
-    # Uncomment if user wants notification directly from python
-    #try:
-        #target = c.mailops
-        #if(type(target) is not list):
-            #target = [target]
-        #for t in target:
-            #p = subprocess.Popen(['mail','-s ECMWFDATA v7.0 normal exit',
-            #                      os.path.expandvars(t)],
-            #                      stdin = subprocess.PIPE,
-            #                      stdout = subprocess.PIPE,
-            #                      stderr = subprocess.PIPE, bufsize = 1)
-            #pout = p.communicate(input = message+'\n\n')[0]
-            #print pout.decode()
-    #except:
-        #pass
-
-    print(message)
+    print message
+
+    # comment if user does not want notification directly from python
+    try:
+        target = []
+        target.extend(c.mailops)
+        for t in target:
+            p = subprocess.Popen(['mail', '-s ECMWFDATA v7.0 normal exit',
+                                  os.path.expandvars(t)],
+                                 stdin=subprocess.PIPE,
+                                 stdout=subprocess.PIPE,
+                                 stderr=subprocess.PIPE,
+                                 bufsize=1)
+            pout = p.communicate(input=message+'\n\n')[0]
+            print 'Email sent to ' + os.path.expandvars(t) + ' ' + pout.decode()
+    finally:
+        pass
 
     return
@@ -411 +416 @@
 
 
-def silentremove(filename):
+def silent_remove(filename):
     '''
     @Description:
@@ -435 +440 @@
 
 
-def init128(fn):
+def init128(filepath):
     '''
     @Description:
@@ -441 +446 @@
 
     @Input:
-        fn: string
+        filepath: string
             Path to file of ECMWF grib table number 128.
 
@@ -451 +456 @@
     '''
     table128 = dict()
-    with open(fn) as f:
+    with open(filepath) as f:
         fdata = f.read().split('\n')
     for data in fdata:
@@ -460 +465 @@
 
 
-def toparamId(pars, table):
+def to_param_id(pars, table):
     '''
     @Description:
@@ -486 +491 @@
     ipar = []
     for par in cpar:
-        found = False
         for k, v in table.iteritems():
             if par == k or par == v:
                 ipar.append(int(k))
-                found = True
                 break
-        if found is False:
-            print('Warning: par ' + par + ' not found in table 128')
+        else:
+            print 'Warning: par ' + par + ' not found in table 128'
 
     return ipar
 
-def getListAsString(listObj):
+def get_list_as_string(list_obj, concatenate_sign=', '):
     '''
     @Description:
@@ -503 +506 @@
 
     @Input:
-        listObj: list
+        list_obj: list
             A list with arbitrary content.
 
-    @Return:
-        strOfList: string
+        concatenate_sign: string, optional
+            A string which is used to concatenate the single
+            list elements. Default value is ", ".
+
+    @Return:
+        str_of_list: string
             The content of the list as a single string.
     '''
 
-    strOfList = ", ".join( str(l) for l in listObj)
-
-    return strOfList
+    str_of_list = concatenate_sign.join(str(l) for l in list_obj)
+
+    return str_of_list