Changeset 6650

Timestamp:

Mar 27, 2009, 4:21:20 PM (16 years ago)

Author:

rwilson

Message:

Moved file_length() to here, remove from all run_model.py directories.

Location:

anuga_core/source/anuga/utilities

Files:

• system_tools.py (modified) (1 diff)
• test_system_tools.py (modified) (1 diff)

anuga_core/source/anuga/utilities/system_tools.py

@@ -448 +448 @@
     fd.close()
 
-
+##
+# @brief Function to return the length of a file.
+# @param in_file Path to file to get length of.
+# @return Number of lines in file.
+# @note Doesn't count '\n' characters.
+# @note Zero byte file, returns 0.
+# @note No \n in file at all, but >0 chars, returns 1.
+def file_length(in_file):
+    '''Function to return the length of a file.'''
+
+    fid = open(in_file)
+    data = fid.readlines()
+    fid.close()
+    return len(data)
+
+

anuga_core/source/anuga/utilities/test_system_tools.py

@@ -252 +252 @@
         self.failUnless(expected_digest == digest, msg)
 
-
+    def test_file_length_function(self):
+        '''Test that file_length() give 'correct' answer.'''
+
+        # prepare test directory and filenames
+        tmp_dir = tempfile.mkdtemp()
+        test_file1 = os.path.join(tmp_dir, 'test.file1')
+        test_file2 = os.path.join(tmp_dir, 'test.file2')
+        test_file3 = os.path.join(tmp_dir, 'test.file3')
+        test_file4 = os.path.join(tmp_dir, 'test.file4')
+
+        # create files of known length
+        fd = open(test_file1, 'w')      # 0 lines
+        fd.close
+        fd = open(test_file2, 'w')      # 5 lines, all '\n'
+        for i in range(5):
+            fd.write('\n')
+        fd.close()
+        fd = open(test_file3, 'w')      # 25 chars, no \n, 1 lines
+        fd.write('no newline at end of line')
+        fd.close()
+        fd = open(test_file4, 'w')      # 1000 lines
+        for i in range(1000):
+            fd.write('The quick brown fox jumps over the lazy dog.\n')
+        fd.close()
+
+        # use file_length() to get and check lengths
+        size1 = file_length(test_file1)
+        msg = 'Expected file_length() to return 0, but got %d' % size1
+        self.failUnless(size1 == 0, msg)
+        size2 = file_length(test_file2)
+        msg = 'Expected file_length() to return 5, but got %d' % size2
+        self.failUnless(size2 == 5, msg)
+        size3 = file_length(test_file3)
+        msg = 'Expected file_length() to return 1, but got %d' % size3
+        self.failUnless(size3 == 1, msg)
+        size4 = file_length(test_file4)
+        msg = 'Expected file_length() to return 1000, but got %d' % size4
+        self.failUnless(size4 == 1000, msg)
+
+        
 #-------------------------------------------------------------
 if __name__ == "__main__":