Prioritize specific categories when sorting

Author: soimkim

src/fosslight_source/_license_matched.py

@@ -8,18 +8,21 @@
 logger = logging.getLogger(constant.LOGGER_NAME)
 HEADER = ['No', 'Category', 'License',
           'Matched Text', 'File Count', 'Files']
+LOW_PRIORITY = ['Permissive', 'Public Domain']
+
 
 class MatchedLicense:
     license = ""
     files = []
     category = ""
     matched_text = ""
+    priority = 0
 
     def __init__(self, lic, category, text, file):
         self.files = [file]
         self.license = lic
-        self.category = category
         self.matched_text = text
+        self.set_category(category)
 
     def __del__(self):
         pass
@@ -32,6 +35,10 @@ def set_files(self, value):
 
     def set_category(self, value):
         self.category = value
+        if value in LOW_PRIORITY:
+            self.priority = 1
+        else:
+            self.priority = 0
 
     def set_matched_text(self, value):
         self.matched_text = value
@@ -43,7 +50,7 @@ def get_row_to_print(self):
 
 def get_license_list_to_print(license_list):
     license_items = license_list.values()
-    license_items = sorted(license_items, key=lambda row: (row.category, row.license))
+    license_items = sorted(license_items, key=lambda row: (row.priority, row.category, row.license))
     license_rows = [lic_item.get_row_to_print() for lic_item in license_items]
     license_rows.insert(0, HEADER)
     return license_rows

src/fosslight_source/_parsing_scancode_file_item.py

@@ -121,7 +121,7 @@ def parsing_file_item(scancode_file_list, has_error, need_matched_license=False)
 
     rc = True
     scancode_file_item = []
-    license_list = {} # Key :[license]+[matched_text], value: MatchedLicense()
+    license_list = {}  # Key :[license]+[matched_text], value: MatchedLicense()
     msg = "TOTAL FILE COUNT: " + str(len(scancode_file_list)) + "\n"
 
     prev_dir = ""

src/fosslight_source/convert_scancode.py

@@ -52,9 +52,11 @@ def convert_json_to_excel(scancode_json, excel_name, result_log, need_license=Fa
                                 file_name = os.path.basename(file)
                                 file_list = sorted(
                                     file_list, key=lambda row: (''.join(row.licenses)))
-                                sheet_list[sheet_SRC_prefix +"_" + file_name] = [scan_item.get_row_to_print() for scan_item in file_list]
+                                sheet_name = sheet_SRC_prefix + "_" + file_name
+                                sheet_list[sheet_name] = [scan_item.get_row_to_print() for scan_item in file_list]
                                 if need_license:
-                                    sheet_list[sheet_license_prefix+"_" + file_name] = get_license_list_to_print(lic_list)
+                                    lic_sheet_name = sheet_license_prefix + "_" + file_name
+                                    sheet_list[lic_sheet_name] = get_license_list_to_print(lic_list)
                         except Exception as ex:
                             logger.warning("Error parsing "+file+":" + str(ex))
 

tox.ini

@@ -23,7 +23,7 @@ commands =
   fosslight_source -p tests/test_files -j -o test_scan/scan_result -m
   cat test_scan/scan_result_SRC.csv
   fosslight_convert -p tests/json_result/scan_has_error.json -o test_convert/convert_result2
-  fosslight_convert -p test_scan/scan_result.json -o test_convert/convert_result
+  fosslight_convert -p test_scan/scan_result.json -o test_convert/convert_result -m
   cat test_convert/convert_result_SRC.csv
   python tests/cli_test.py
 
@@ -34,10 +34,10 @@ deps =
 commands =
   fosslight_source -h
   fosslight_convert -h
-  fosslight_source -p tests/test_files -j -o test_scan/scan_result
+  fosslight_source -p tests/test_files -j -o test_scan/scan_result -m
   cat test_scan/scan_result_SRC.csv
   fosslight_convert -p tests/json_result/scan_has_error.json -o test_convert/convert_result2
-  fosslight_convert -p test_scan/scan_result.json -o test_convert/convert_result
+  fosslight_convert -p test_scan/scan_result.json -o test_convert/convert_result -m
   cat test_convert/convert_result_SRC.csv
   python tests/cli_test.py
   pytest -v --flake8