Changeset 0f89116 in flex_extract.git for Source/Python/Classes/GribUtil.py

Timestamp:

Dec 19, 2019, 8:07:12 PM (4 years ago)

Author:

Anne Philipp <anne.philipp@…>

Branches:

master, ctbto, dev

Children:

a73c0f6

Parents:

0d99607

Message:

diverse changes due to PEP8 style guide and eliminating grib2flexpart; removed unused parameter

File:

• Source/Python/Classes/GribUtil.py (modified) (9 diffs)

Source/Python/Classes/GribUtil.py

@@ -68 +68 @@
 
 
-    def get_keys(self, keynames, wherekeynames=[], wherekeyvalues=[]):
+    def get_keys(self, keynames, wherekeynames, wherekeyvalues):
         '''Get keyvalues for a given list of keynames a where statement
         can be given (list of key and list of values)
@@ -77 +77 @@
             List of keynames.
 
-        wherekeynames : :obj:`list` of :obj:`string`, optional
-            Default value is an empty list.
-
-        wherekeyvalues : :obj:`list` of :obj:`string`, optional
-            Default value is an empty list.
+        wherekeynames : :obj:`list` of :obj:`string`
+            List of key names for indexing grib message parameter.
+
+        wherekeyvalues : :obj:`list` of :obj:`string`
+            List of key values corresponding the key names.
 
         Return
@@ -122 +122 @@
 
 
-    def set_keys(self, fromfile, keynames, keyvalues, wherekeynames=[],
-                 wherekeyvalues=[], strict=False, filemode='wb'):
+    def set_keys(self, fromfile, keynames, keyvalues, wherekeynames,
+                 wherekeyvalues, filemode='wb'):
         '''Opens the file to read the grib messages and then write
         the selected messages (with wherekeys) to a new output file.
@@ -141 +141 @@
             Default is an empty list.
 
-        wherekeynames : :obj:`list` of :obj:`string`, optional
+        wherekeynames : :obj:`list` of :obj:`string`
             List of keynames to select correct message.
-            Default value is an empty list.
-
-        wherekeyvalues : :obj:`list` of :obj:`string`, optional
+
+        wherekeyvalues : :obj:`list` of :obj:`string`
             List of keyvalues for keynames to select correct message.
-            Default value is an empty list.
-
-        strict : :obj:`boolean`, optional
-            Decides if everything from keynames and keyvalues
-            is written out the grib file (False) or only those
-            meeting the where statement (True). Default is False.
 
         filemode : :obj:`string`, optional
@@ -200 +193 @@
         return
 
-    def copy_dummy_msg(self, filename_in, selectWhere=True,
-                 keynames=[], keyvalues=[], filemode='wb'):
+    def copy_dummy_msg(self, filename_in, keynames, keyvalues,
+                       selectwhere=True, filemode='wb'):
         '''Add the content of another input grib file to the objects file but
         only messages corresponding to keys/values passed to the function.
@@ -212 +205 @@
             Filename of the input file to read the grib messages from.
 
-        selectWhere : :obj:`boolean`, optional
+        selectwhere : :obj:`boolean`, optional
             Decides if to copy the keynames and values equal to (True) or
             different to (False) the keynames/keyvalues list passed to the
             function. Default is True.
 
-        keynames : :obj:`list` of :obj:`string`, optional
-            List of keynames. Default is an empty list.
-
-        keyvalues : :obj:`list` of :obj:`string`, optional
-            List of keyvalues. Default is an empty list.
+        keynames : :obj:`list` of :obj:`string`
+            List of keynames.
+
+        keyvalues : :obj:`list` of :obj:`string`
+            List of keyvalues.
 
         filemode : :obj:`string`, optional
@@ -254 +247 @@
                     raise Exception("Key was not defined")
 
-                if selectWhere:
+                if selectwhere:
                     select = (select and (str(keyvalues[i]) ==
                                           str(codes_get(gid, key))))
@@ -272 +265 @@
         return
 
-    def index(self, index_keys=["mars"], index_file="my.idx"):
+    def index(self, index_keys, index_file="my.idx"):
         '''Create index file from a list of files if it does not exist or
         read an index file.
@@ -278 +271 @@
         Parameters
         ----------
-        index_keys: :obj:`list` of :obj:`string`, optional
+        index_keys: :obj:`list` of :obj:`string`
             Contains the list of key parameter names from
             which the index is to be created.
-            Default is a list with a single entry string "mars".
 
         index_file: :obj:`string`, optional