Pep8 ification

compare-db.py

@@ -13,74 +13,95 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-#
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+# USA.
+
+"""Compare contents of db with output from other version of file(1)."""
+
+from __future__ import print_function
 
-import os
 import sys
+import mutex
 from pyfile import *
-from pyfile.progressbar import ProgressBar
 from pyfile.threadpool import *
-import mutex
 
-def compare_all_files(file_name = 'file', magdir = 'Magdir', exact = False):
-	pool = ThreadPool(4)
-	m = mutex.mutex()
 
-	split_patterns(magdir, file_name)
-	compile_patterns(file_name)
-	compiled = is_compilation_supported(file_name)
+def compare_all_files(file_name='file', magdir='Magdir', exact=False):
+    """
+    Compares all saved file(1) output in db with that of other file(1) version.
+
+    Creates a ThreadPool to do this in parallel. Uses a mutex lock to ensure
+    that text output is not garbled.
+    """
+    n_threads = 4
+    pool = ThreadPool(n_threads)
+    print_lock = mutex.mutex()
+
+    split_patterns(magdir, file_name)
+    compile_patterns(file_name)
+    compiled = is_compilation_supported(file_name)
+
+    entries = get_stored_files("db")
+
+    def store_mimedata(entry):
+        """For a single db entry, calls file(1) and compares it to db data."""
+        metadata = get_full_metadata(entry, file_name, compiled)
+        stored_metadata = get_stored_metadata(entry)
+        text = "PASS " + entry
+        if is_regression(stored_metadata, metadata, exact):
+            text = "FAIL " + entry + "\n" + \
+                   get_diff(stored_metadata, metadata, exact)
+        return text
+
+    def data_print(data):
+        """Print result for single entry and unlock print lock."""
+        print(data)
+        print_lock.unlock()
+
+    def data_stored(data):
+        """Call data_print as soon as print lock has been acquired."""
+        print_lock.lock(data_print, data)
+
+    for entry in entries:
+        # Insert tasks into the queue and let them run
+        pool.queueTask(store_mimedata, args=(entry, ),
+                       callback=data_stored)
+
+    # When all tasks are finished, allow the threads to terminate
+    pool.joinAll()
+    print('')
+
 
-	entries = get_stored_files("db")
+def main():
+    """Parse arguments, call :py:func:`compare_all_files`."""
+    file_name = 'file'
+    magdir = "Magdir"
+    exact = False
 
-	def store_mimedata(data):
-		metadata = get_full_metadata(data[0], file_name, compiled)
-		stored_metadata = get_stored_metadata(data[0])
-		text = "PASS " + data[0]
-		if is_regression(stored_metadata, metadata, exact):
-			text = "FAIL " + data[0] + "\n" + get_diff(stored_metadata, metadata, exact)
-		return text
+    if len(sys.argv) >= 3:
+        file_name = sys.argv[1]
+        magdir = sys.argv[2]
+    elif (len(sys.argv) == 2 and sys.argv[1] == "-h") or len(sys.argv) == 1:
+        print("Compares files in database with output of current file binary.")
+        print(sys.argv[0] + " [path_to_magdir_directory] [file_name]")
+        print("  Default path_to_magdir_directory='Magdir'")
+        print("  Default file_name='file'")
+        print("Examples:")
+        print("  " + sys.argv[0] + " file-5.07;")
+        print("  " + sys.argv[0] + " file-5.07 file-5.04/magic/Magdir;")
+        sys.exit(0)
 
-	def data_print(data):
-		print data
-		m.unlock()
+    if magdir == "exact":
+        exact = True
+        magdir = "Magdir"
 
-	def data_stored(data):
-		m.lock(data_print, data)
+    if len(sys.argv) == 4 and sys.argv[3] == "exact":
+        exact = True
 
-	for i,entry in enumerate(entries):
-		# Insert tasks into the queue and let them run
-		pool.queueTask(store_mimedata, (entry, i % 2), data_stored)
+    file_name = sys.argv[1]
+    compare_all_files(file_name, magdir, exact)
 
-	# When all tasks are finished, allow the threads to terminate
-	pool.joinAll()
-	print ''
 
 # run this only if started as script from command line
 if __name__ == '__main__':
-	file_name = 'file'
-	magdir = "Magdir"
-	exact = False
-
-	if len(sys.argv) >= 3:
-		file_name = sys.argv[1]
-		magdir = sys.argv[2]
-	elif (len(sys.argv) == 2 and sys.argv[1] == "-h") or len(sys.argv) == 1:
-		print "Compares files in database with output of current file binary."
-		print sys.argv[0] + " [path_to_magdir_directory] [file_name]"
-		print "  Default path_to_magdir_directory='Magdir'"
-		print "  Default file_name='file'"
-		print "Examples:"
-		print "  " + sys.argv[0] + " file-5.07;"
-		print "  " + sys.argv[0] + " file-5.07 file-5.04/magic/Magdir;"
-		sys.exit(0)
-
-	if magdir == "exact":
-		exact = True
-		magdir = "Magdir"
-
-	if len(sys.argv) == 4 and sys.argv[3] == "exact":
-		exact = True
-
-	file_name = sys.argv[1]
-	compare_all_files(file_name, magdir, exact)
+    main()

fast-regression-test.py

@@ -14,87 +14,110 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-#
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+# USA.
+
+"""Do a quick comparison of output of file(1) with that saved in db."""
+
+from __future__ import print_function
 
-import os
 import sys
 import getopt
+import mutex
 from pyfile import *
 from pyfile.threadpool import *
-import mutex
-
-ret = 0
 
-def test_all_files(exact = False, binary = "file"):
 
-	global ret
-	ret = 0
+#: return value from test_all_files
+#: TODO: make this a nonlocal in py3
+ret = 0
 
-	print_file_info(binary)
 
-	m = mutex.mutex()
+def test_all_files(exact=False, binary="file"):
+    """Compare output of given file(1) binary with db for all entries."""
+    global ret
+    ret = 0
+
+    print_file_info(binary)
+
+    print_lock = mutex.mutex()
+
+    entries = sorted(get_stored_files("db"))
+
+    def store_mimedata(filename):
+        """Compare file(1) output with db for single entry."""
+        metadata = get_simple_metadata(filename, binary)
+        try:
+            stored_metadata = get_stored_metadata(filename)
+        except IOError:
+            # file not found or corrupt
+            text = "FAIL " + filename + "\n" + \
+                   "FAIL   could not find stored metadata!\n" + \
+                   "This can mean that the File failed to generate " + \
+                   "any output for this file."
+        else:
+            text = "PASS " + filename
+            if is_regression(stored_metadata, metadata, exact):
+                text = "FAIL " + filename + "\n" + \
+                       get_diff(stored_metadata, metadata, exact)
+        return text
+
+    def data_print(data):
+        """Print given text, set global return value, unlock print lock."""
+        print(data)
+        if data[0] == "F":
+            global ret
+            ret = 1
+        print_lock.unlock()
+
+    def data_stored(data):
+        """Acquire print lock and call :py:function:`data_print`."""
+        print_lock.lock(data_print, data)
+
+    # create here so program exits if error occurs earlier
+    n_threads = 1
+    pool = ThreadPool(n_threads)
+
+    for entry in entries:
+        # Insert tasks into the queue and let them run
+        pool.queueTask(store_mimedata, entry, data_stored)
+
+    # When all tasks are finished, allow the threads to terminate
+    pool.joinAll()
+    print('')
+    return ret
 
-	entries = sorted(get_stored_files("db"))
 
-	def store_mimedata(filename):
-		metadata = get_simple_metadata(filename, binary)
-		try:
-			stored_metadata = get_stored_metadata(filename)
-		except IOError:
-			# file not found or corrupt
-			text = "FAIL " + filename + "\n" + "FAIL   could not find stored metadata!\n\
-			This can mean that the File failed to generate any output for this file."
-		else:
-			text = "PASS " + filename
-			if is_regression(stored_metadata, metadata, exact):
-				text = "FAIL " + filename + "\n" + get_diff(stored_metadata, metadata, exact)
-		return text
+def usage(ecode):
+    """Print info on how to use this program. Return given code."""
+    print("Runs regressions.")
+    print(sys.argv[0] + " [-e] [-b <file-binary>]")
+    print("  Default file_binary='file'")
+    print("Examples:")
+    print("  " + sys.argv[0] + " -e -b '../file -m ../../magic/magic.mgc'")
+    print("  " + sys.argv[0] + " -e")
+    sys.exit(ecode)
 
-	def data_print(data):
-		print data
-		if data[0] == "F":
-			global ret
-			ret = 1
-		m.unlock()
 
-	def data_stored(data):
-		m.lock(data_print, data)
+def main():
+    """Called when running this as script. Parse args, call test_all_files."""
+    exact = False
+    file_binary = "file"
+    args = sys.argv[1:]
 
-	pool = ThreadPool(4)  # create here so program exits if error occurs earlier
+    optlist, args = getopt.getopt(args, 'b:e')
 
-	for entry in entries:
-		# Insert tasks into the queue and let them run
-		pool.queueTask(store_mimedata, entry, data_stored)
+    for option, arg in optlist:
+        if option == '-b':
+            file_binary = arg
+        elif option == '-e':
+            exact = True
+        else:
+            usage(1)
 
-	# When all tasks are finished, allow the threads to terminate
-	pool.joinAll()
-	print ''
-	return ret
+    sys.exit(test_all_files(exact, file_binary))
 
-def usage(ecode):
-	print "Runs regressions."
-	print sys.argv[0] + " [-e] [-b <file-binary>]"
-	print "  Default file_binary='file'"
-	print "Examples:"
-	print "  " + sys.argv[0] + " -e -b '../file -m ../../magic/magic.mgc'"
-	print "  " + sys.argv[0] + " -e"
-	sys.exit(ecode)
 
 # run this only if started as script from command line
 if __name__ == '__main__':
-	exact = False
-	file_binary = "file"
-	args = sys.argv[1:]
-
-	optlist, args = getopt.getopt(args, 'b:e')
-
-	for o, a in optlist:
-		if o == '-b':
-			file_binary = a
-		elif o == '-e':
-			exact = True
-		else:
-			usage(1)
-
-	sys.exit(test_all_files(exact, file_binary))
+    main()