! improve show-duplicate-java-classes

- ignore BadZipFile for jar file
- extract functions
  - biz function print_duplicate_classes_info
  - util function print_box_message
- adjust function layout, move util functions to the front
- from __future__ import print_function
- use start=1 for enumerate
- rename var name: java_class -> class/clazz

Author: oldratlee

bin/show-duplicate-java-classes

@@ -12,28 +12,51 @@
 # @author tg123 (farmer1992 at gmail dot com)
 # @author Jerry Lee (oldratlee at gmail dot com)
 
+from __future__ import print_function
+
 __author__ = 'tg123'
 
 import sys
 from glob import glob
 from os import walk
-from zipfile import ZipFile
+from zipfile import ZipFile, BadZipfile
 from os.path import relpath, isdir
 from optparse import OptionParser
 
 
-def list_jar_file_under_lib_dirs(libs):
+################################################################################
+# utils functions
+################################################################################
+
+def check_python_version():
+    if sys.version_info < (2, 7):
+        exit('Using python 2 and its version lower than 2.7, not supported!\n'
+             'Please use python 3 instead!\nPython version: ' + sys.version)
+
+
+def print_box_message(msg):
+    print()
+    print('=' * 80)
+    print(msg)
+    print('=' * 80)
+
+
+def list_jar_file_under_lib_dirs(lib_dirs):
     jar_files = set()
-    for lib in libs:
-        if isdir(lib):
-            jar_files |= {f for f in glob(lib + '/*.jar')}
+    for lib_dir in lib_dirs:
+        if isdir(lib_dir):
+            jar_files |= {f for f in glob(lib_dir + '/*.jar')}
         else:
-            jar_files.add(lib)
+            jar_files.add(lib_dir)
     return jar_files
 
 
 def list_class_under_jar_file(jar_file):
-    return {f for f in ZipFile(jar_file).namelist() if f.lower().endswith('.class')}
+    try:
+        return {f for f in ZipFile(jar_file).namelist() if f.lower().endswith('.class')}
+    except BadZipfile:
+        print('WARN: %s is bad zip file, ignored!' % jar_file, file=sys.stderr)
+        return set()
 
 
 def list_class_under_class_dir(class_dir):
@@ -42,89 +65,84 @@ def list_class_under_class_dir(class_dir):
             for filename in file_names if filename.lower().endswith('.class')}
 
 
-def expand_2_class_path(jar_files, class_dirs):
-    java_class_2_class_paths = {}
+################################################################################
+# biz functions
+################################################################################
+
+def build_index__class_to_class_paths(jar_files, class_dirs):
+    class_to_class_paths = {}
+
     # list all classes in jar files
     for jar_file in jar_files:
         for class_file in list_class_under_jar_file(jar_file):
-            java_class_2_class_paths.setdefault(class_file, set()).add(jar_file)
-    # list all classes in class dir
+            class_to_class_paths.setdefault(class_file, set()).add(jar_file)
+
+    # list all classes in class dirs
     for class_dir in class_dirs:
         for class_file in list_class_under_class_dir(class_dir):
-            java_class_2_class_paths.setdefault(class_file, set()).add(class_dir)
+            class_to_class_paths.setdefault(class_file, set()).add(class_dir)
 
-    return java_class_2_class_paths, jar_files | set(class_dirs)
+    return class_to_class_paths, jar_files | set(class_dirs)
 
 
-def find_duplicate_classes(java_class_2_class_paths):
-    class_path_2_duplicate_classes = {}
+def find_duplicate_classes(class_to_class_paths):
+    class_paths_to_duplicate_classes = {}
 
-    for java_class, class_paths in list(java_class_2_class_paths.items()):
+    for clazz, class_paths in class_to_class_paths.items():
         # skip java 9 module-info files
-        if java_class.endswith('/module-info.class'):
+        if clazz.endswith('/module-info.class'):
             continue
         if len(class_paths) > 1:
-            classes = class_path_2_duplicate_classes.setdefault(frozenset(class_paths), set())
-            classes.add(java_class)
+            classes = class_paths_to_duplicate_classes.setdefault(frozenset(class_paths), set())
+            classes.add(clazz)
 
-    return class_path_2_duplicate_classes
+    return class_paths_to_duplicate_classes
 
 
-def print_class_paths(class_paths):
-    print('')
-    print('=' * 80)
-    print('class paths to find:')
-    print('=' * 80)
-    for idx, class_path in enumerate(class_paths):
-        print('%-3d: %s' % (idx + 1, class_path))
+def print_duplicate_classes_info(class_paths_to_duplicate_classes):
+    print('Found duplicate classes in below class paths:')
+    for idx, jars in enumerate(class_paths_to_duplicate_classes, start=1):
+        print('%-3d(%d@%d): %s' % (idx, len(class_paths_to_duplicate_classes[jars]), len(jars), ' '.join(jars)))
+
+    print_box_message('Duplicate classes detail info:')
+    for idx, (jars, classes) in enumerate(class_paths_to_duplicate_classes.items(), start=1):
+        print('%-3d(%d@%d): %s' % (idx, len(class_paths_to_duplicate_classes[jars]), len(jars), ' '.join(jars)))
+        for i, c in enumerate(classes, start=1):
+            print('%7d %s' % (i, c))
+
+
+def print_class_paths_info(class_paths):
+    print_box_message('class paths to find:')
+    for idx, class_path in enumerate(class_paths, start=1):
+        print('%-3d: %s' % (idx, class_path))
 
 
 def main():
     option_parser = OptionParser('usage: %prog '
                                  '[-c class-dir1 [-c class-dir2] ...] '
                                  '[lib-dir1|jar-file1 [lib-dir2|jar-file2] ...]')
     option_parser.add_option('-c', '--class-dir', dest='class_dirs', default=[], action='append', help='add class dir')
-    options, libs = option_parser.parse_args()
+    options, lib_dirs = option_parser.parse_args()
+    if not options.class_dirs and not lib_dirs:
+        lib_dirs = ['.']
 
-    if not options.class_dirs and not libs:
-        libs = ['.']
+    class_to_class_paths, class_paths = build_index__class_to_class_paths(
+        list_jar_file_under_lib_dirs(lib_dirs), options.class_dirs)
 
-    java_class_2_class_paths, class_paths = expand_2_class_path(
-        list_jar_file_under_lib_dirs(libs), options.class_dirs)
+    class_paths_to_duplicate_classes = find_duplicate_classes(class_to_class_paths)
 
-    class_path_2_duplicate_classes = find_duplicate_classes(java_class_2_class_paths)
-
-    if not class_path_2_duplicate_classes:
+    have_duplicate_classes = bool(class_paths_to_duplicate_classes)
+    if have_duplicate_classes:
+        print_duplicate_classes_info(class_paths_to_duplicate_classes)
+    else:
         print('COOL! No duplicate classes found!')
-        print_class_paths(class_paths)
-        exit()
 
-    print('Found duplicate classes in below class path:')
-    for idx, jars in enumerate(class_path_2_duplicate_classes):
-        print('%-3d(%d@%d): %s' % (idx + 1, len(class_path_2_duplicate_classes[jars]), len(jars), ' '.join(jars)))
+    print_class_paths_info(class_paths)
 
-    print('')
-    print('=' * 80)
-    print('Duplicate classes detail info:')
-    print('=' * 80)
-    for idx, (jars, classes) in enumerate(class_path_2_duplicate_classes.items()):
-        print('%-3d(%d@%d): %s' % (idx + 1, len(class_path_2_duplicate_classes[jars]), len(jars), ' '.join(jars)))
-        for i, c in enumerate(classes):
-            print('\t%-3d %s' % (i + 1, c))
-
-    print_class_paths(class_paths)
-    exit(1)
-
-
-def check_python_version():
-    python_version = sys.version_info
-    if python_version.major > 2:
-        return
-    if python_version.minor < 7:
-        exit('Using python 2 and its version lower than 2.7, not support!\n'
-             'Please use python 3 instead!\nPython version: ' + sys.version)
+    return int(have_duplicate_classes)
 
 
 if __name__ == '__main__':
     check_python_version()
-    main()
+
+    exit(main())