Changeset ff99eae in flex_extract.git for python/GribTools.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/GribTools.py (modified) (15 diffs)

python/GribTools.py

@@ -1 +1 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-#************************************************************************
-# TODO AP
-# - GribTools name möglicherweise etwas verwirrend.
-# - change self.filename in self.filenames!!!
-# - bis auf --init-- und index wird keine Funktion verwendet!?
-#************************************************************************
 #*******************************************************************************
 # @Author: Anne Fouilloux (University of Oslo)
@@ -36 +30 @@
 # @Class Content:
 #    - __init__
-#    - getkeys
-#    - setkeys
+#    - get_keys
+#    - set_keys
 #    - copy
 #    - index
+#
+# @Class Attributes:
+#    - filenames
 #
 #*******************************************************************************
@@ -47 +44 @@
 # ------------------------------------------------------------------------------
 import os
-from gribapi import *
+from gribapi import grib_new_from_file, grib_is_defined, grib_get, \
+                    grib_release, grib_set, grib_write, grib_index_read, \
+                    grib_index_new_from_file, grib_index_add_file,  \
+                    grib_index_write
 
 # ------------------------------------------------------------------------------
 # CLASS
 # ------------------------------------------------------------------------------
-class GribTools:
+class Gribtools(object):
     '''
     Class for GRIB utilities (new methods) based on GRIB API
@@ -62 +62 @@
         '''
         @Description:
-            Initialise an object of GribTools and assign a list
+            Initialise an object of Gribtools and assign a list
             of filenames.
 
@@ -73 +73 @@
         '''
 
-        self.filename = filenames
+        self.filenames = filenames
 
         return
 
 
-    def getkeys(self, keynames, wherekeynames=[], wherekeyvalues=[]):
+    def get_keys(self, keynames, wherekeynames=[], wherekeyvalues=[]):
         '''
         @Description:
@@ -88 +88 @@
                 List of keynames.
 
-            wherekeynames: list of ???, optional
+            wherekeynames: list of strings, optional
                 Default value is an empty list.
 
-            wherekeyvalues: list of ???, optional
+            wherekeyvalues: list of strings, optional
                 Default value is an empty list.
 
@@ -99 +99 @@
         '''
 
-        fileid = open(self.filename, 'r')
+        fileid = open(self.filenames, 'r')
 
         return_list = []
@@ -136 +136 @@
 
 
-    def setkeys(self, fromfile, keynames, keyvalues, wherekeynames=[],
-                wherekeyvalues=[], strict=False, filemode='w'):
+    def set_keys(self, fromfile, keynames, keyvalues, wherekeynames=[],
+                 wherekeyvalues=[], strict=False, filemode='w'):
         '''
         @Description:
@@ -150 +150 @@
                 Filename of the input file to read the grib messages from.
 
-            keynames: list of ???
+            keynames: list of strings
                 List of keynames. Default is an empty list.
 
-            keyvalues: list of ???
+            keyvalues: list of strings
                 List of keynames. Default is an empty list.
 
-            wherekeynames: list of ???, optional
+            wherekeynames: list of strings, optional
                 Default value is an empty list.
 
-            wherekeyvalues: list of ???, optional
+            wherekeyvalues: list of strings, optional
                 Default value is an empty list.
 
@@ -174 +174 @@
 
         '''
-        fout = open(self.filename, filemode)
+        fout = open(self.filenames, filemode)
         fin = open(fromfile)
 
@@ -196 +196 @@
                 i += 1
 
-#AP is it secured that the order of keynames is equal to keyvalues?
             if select:
                 i = 0
@@ -203 +202 @@
                     i += 1
 
-#AP this is a redundant code section
-# delete the if/else :
-#
-#           grib_write(gid_in, fout)
-#
-            if strict:
-                if select:
-                    grib_write(gid_in, fout)
-            else:
-                grib_write(gid_in, fout)
-#AP end
+            grib_write(gid_in, fout)
+
             grib_release(gid_in)
 
@@ -238 +228 @@
                 function. Default is True.
 
-            keynames: list of ???, optional
+            keynames: list of strings, optional
                 List of keynames. Default is an empty list.
 
-            keyvalues: list of ???, optional
+            keyvalues: list of strings, optional
                 List of keynames. Default is an empty list.
 
@@ -252 +242 @@
 
         fin = open(filename_in)
-        fout = open(self.filename, filemode)
+        fout = open(self.filenames, filemode)
 
         while 1:
@@ -307 +297 @@
                 Grib index id.
         '''
-        print("... index will be done")
-        self.iid = None
-
-        if (os.path.exists(index_file)):
-            self.iid = grib_index_read(index_file)
-            print("Use existing index file: %s " % (index_file))
+        print "... index will be done"
+        iid = None
+
+        if os.path.exists(index_file):
+            iid = grib_index_read(index_file)
+            print "Use existing index file: %s " % (index_file)
         else:
-            for file in self.filename:
-                print("Inputfile: %s " % (file))
-                if self.iid is None:
-                    self.iid = grib_index_new_from_file(file, index_keys)
+            for filename in self.filenames:
+                print "Inputfile: %s " % (filename)
+                if iid is None:
+                    iid = grib_index_new_from_file(filename, index_keys)
                 else:
                     print 'in else zweig'
-                    grib_index_add_file(self.iid, file)
-
-            if self.iid is not None:
-                grib_index_write(self.iid, index_file)
-
-        print('... index done')
-
-        return self.iid
-
-
-
-
-
+                    grib_index_add_file(iid, filename)
+
+            if iid is not None:
+                grib_index_write(iid, index_file)
+
+        print '... index done'
+
+        return iid