Changeset 4126

Timestamp:

2013-10-24T18:49:17+02:00 (11 years ago)

Author:

andrewryan

Message:

added latest version of OOO namelist editor and test suite

Location:

branches/2013/dev_r3987_UKMO4_OBS/NEMOGCM/TOOLS/OBSTOOLS/OOO/ooo

Files:

• nml.py (modified) (3 diffs)
• test_nml.py (modified) (10 diffs)

branches/2013/dev_r3987_UKMO4_OBS/NEMOGCM/TOOLS/OBSTOOLS/OOO/ooo/nml.py

@@ -153 +153 @@
 """
 __version__ = "0.1.0"
-
 import re
 
@@ -270 +269 @@
         data = sanitize(data)
     for k, v in data.iteritems():
-        pat = r"(%s\s+=\s+).+?(\s*[!\n])" % (k,)
+        pat = r"(%s\s*=\s*).+?(\s*[!\n])" % (k,)
         repl = r"\g<1>%s\g<2>" % (v,)
         text = re.sub(pat, repl, text)
@@ -342 +341 @@
     """
     if isinstance(data, list):
-        # Conversion function
-        def convert(word):
-            if isinstance(word, str):
-                result = "'%s'" % (word,)
-            else:
-                result = str(word)
-            return result
-        text = " ".join([convert(item) for item in data])
-    elif isinstance(data, bool):
-        if data:
-            text = ".TRUE."
+        if same_type(data):
+            delim = " "
         else:
-            text = ".FALSE."
+            delim = ", "
+        text = delim.join([convert(item) for item in data])
     else:
-        text = str(data)
+        text = convert(data)
     return text
+
+def numeric(word):
+    # Tests input string is numeric data
+    parts = word.split(" ")
+    try:
+        map(float, parts)
+        flag = True
+    except ValueError:
+        flag = False
+    return flag
+
+def logical(word):
+    # Tests input string is numeric data
+    if word.upper() in [".FALSE.", ".TRUE."]:
+        flag = True
+    else:
+        flag = False
+    return flag
+
+def listed(word):
+    # Tests input string is not a list
+    if ("," in word) or (" " in word):
+        flag = True
+    else:
+        flag = False
+    return flag
+
+def convert(word):
+    # Conversion function
+    if isinstance(word, str):
+        if (quoted(word) or numeric(word) 
+            or logical(word) or listed(word)):
+            result = "%s" % (word,)
+        else:
+            result = "'%s'" % (word,)
+    elif isinstance(word, bool):
+        if word:
+            result = ".TRUE."
+        else:
+            result = ".FALSE."
+    else:
+        result = str(word)
+    return result
+
+def quoted(word):
+    # Checks if string begins/ends with quotation marks
+    if (word.startswith("'") and word.endswith("'")):
+        flag = True
+    elif (word.startswith('"') and word.endswith('"')):
+        flag = True
+    else: 
+        flag = False
+    return flag
+
+def same_type(data):
+    # True if all entries are the same type
+    types = map(type, data)
+    if len(set(types)) == 1:
+        flag = True
+    else:
+        flag = False
+    return flag
 
 def sanitize(data):

branches/2013/dev_r3987_UKMO4_OBS/NEMOGCM/TOOLS/OBSTOOLS/OOO/ooo/test_nml.py

@@ -5 +5 @@
 def version(vn):
     # Converts module version string to int tuple as PEP-440
-    return tuple(map(int, nml.__version__.split(".")))
+    return tuple(map(int, vn.split(".")))
 
 HEADER = """
@@ -16 +16 @@
 LOGIC = " ln_test = .TRUE. ! Comment\n"
 NUMERIC = " nn_off_idx = 1 2 3\n"
-FORD = " nn_off_idx=1 2 3\n"
+NOSPACE = " nn_off_idx=1 2 3\n"
 NEGATIVE = " nn_off_idx = -1 -2 -3\n"
 LIST = " off_files = 'a.nc' 'b.nc' 'c.nc' ! Comment\n"
@@ -28 +28 @@
         self.logic_text = "\n".join([HEADER, LOGIC, FOOTER])
         self.numeric_text = "\n".join([HEADER, NUMERIC, FOOTER])
-        self.ford_text = "\n".join([HEADER, FORD, FOOTER])
+        self.nospace_text = "\n".join([HEADER, NOSPACE, FOOTER])
         self.neg_numeric_text = "\n".join([HEADER, NEGATIVE, FOOTER])
         self.list_text = "\n".join([HEADER, LIST, FOOTER])
@@ -63 +63 @@
         self.assertDictEqual(data, truth)
 
-    def test_ford_data(self):
-        data = nml.variables(self.ford_text)
+    def test_nospace_data(self):
+        data = nml.variables(self.nospace_text)
         truth = {"nn_off_idx": "1 2 3"}
         self.assertDictEqual(data, truth)
@@ -84 +84 @@
 
     def test_replace_variable_comment(self):
-        FIXTURE = " x = y ! comment \n"
-        RESULT = " x = z ! comment \n"
+        FIXTURE = " x = 'y' ! comment \n"
+        RESULT = " x = 'z' ! comment \n"
         text = nml.replace(FIXTURE, {"x": "z"})
         self.assertEqual(text, RESULT)
 
     def test_replace_variable_no_comment(self):
-        FIXTURE = " x = y \n"
-        RESULT = " x = z \n"
+        FIXTURE = " x = 'y' \n"
+        RESULT = " x = 'z' \n"
+        text = nml.replace(FIXTURE, {"x": "z"})
+        self.assertEqual(text, RESULT)
+
+    def test_replace_variable_no_space(self):
+        FIXTURE = " x='y' \n"
+        RESULT = " x='z' \n"
+        text = nml.replace(FIXTURE, {"x": "z"})
+        self.assertEqual(text, RESULT)
+
+    def test_replace_variable_no_space_comment(self):
+        FIXTURE = " x='y' ! comment \n"
+        RESULT = " x='z' ! comment \n"
         text = nml.replace(FIXTURE, {"x": "z"})
         self.assertEqual(text, RESULT)
@@ -160 +172 @@
         self.char = "foo@bar.com"
         self.num = 10
+        self.mixed_list = ["foo.nc", -1, True]
+
+    def test_should_format_mixed_list(self):
+        data = nml.tostring(self.mixed_list)
+        result = "'foo.nc', -1, .TRUE."
+        self.assertEqual(data, result)
 
     def test_should_format_numeric_list(self):
@@ -173 +191 @@
     def test_should_format_strings(self):
         data = nml.tostring(self.char)
-        result = self.char
+        result = "'%s'" % (self.char,)
         self.assertEqual(data, result)
 
@@ -180 +198 @@
         result = str(self.num)
         self.assertEqual(data, result)
+
+    def test_should_not_format_numeric_string(self):
+        input = "3.14159"
+        self.assertEqual(nml.tostring(input), input)
 
     def test_should_format_logicals(self):
@@ -186 +208 @@
         self.assertEqual(data.upper(), result)
 
+    def test_should_not_format_string_of_list_data(self):
+        for input in ["1 2 3", "1, 2, 3", ".TRUE. .FALSE."]:
+            case = nml.tostring(input)
+            self.assertEqual(case, input)
+
 class TestUpdateNamelist(unittest.TestCase):
     def setUp(self):
@@ -194 +221 @@
         self.single = """
 &namone
-   x = y
+   x = 'y'
 /
 """
         self.single_update = """
 &namone
-   x = z
+   x = 'z'
 /
 """
 
     def test_should_append_new_variable_to_namelist(self):
-        trial = nml.update("namone", self.empty, {"x": "y"})
+        trial = nml.update("namone", self.empty, {"x": "'y'"})
         self.assertEqual(trial, self.single)
 
     def test_should_update_existing_variables(self):
-        trial = nml.update("namone", self.single, {"x": "z"})
+        trial = nml.update("namone", self.single, {"x": "'z'"})
         self.assertEqual(trial, self.single_update)