Add type hints to each function (#159)

Signed-off-by: ParkSangsin <[email protected]>

Author: ParkSangsin

setup.py

@@ -51,7 +51,11 @@
             "Programming Language :: Python :: 3.8",
             "Programming Language :: Python :: 3.9"],
         install_requires=required,
-        package_data={_PACKAGE_NAME: [os.path.join('resources', 'convert_license.json'), os.path.join(_LICENSE_DIR, '*'), os.path.join('templates', '*')]},
+        package_data={
+            _PACKAGE_NAME: [
+                os.path.join('resources', 'convert_license.json'), os.path.join(_LICENSE_DIR, '*'), os.path.join('templates', '*')
+            ]
+        },
         include_package_data=True,
         entry_points={
             "console_scripts": [

src/fosslight_oss_pkg/_convert.py

@@ -19,7 +19,12 @@
 logger = logging.getLogger(LOGGER_NAME)
 
 
-def convert_report(base_path, output_name, format, need_log_file=True):
+def convert_report(
+    base_path: str,
+    output_name: str,
+    format: str,
+    need_log_file: bool = True
+) -> None:
     oss_yaml_files = []
     file_option_on = False
     output_report = ""

src/fosslight_oss_pkg/_parsing_excel.py

@@ -4,6 +4,7 @@
 # SPDX-License-Identifier: GPL-3.0-only
 import logging
 import os
+from typing import Dict, List
 from fosslight_util.constant import LOGGER_NAME
 from fosslight_util.parsing_yaml import parsing_yml
 from fosslight_util.output_format import write_output_file
@@ -17,7 +18,7 @@
 MAX_SHEET_NAME_LEN = 31
 
 
-def get_sheet_name(yaml_file, sheet_list):
+def get_sheet_name(yaml_file: str, sheet_list: Dict[str, List]) -> str:
     if len(yaml_file) > MAX_SHEET_NAME_LEN:
         yaml_file = yaml_file[0:MAX_SHEET_NAME_LEN]
 
@@ -33,7 +34,12 @@ def get_sheet_name(yaml_file, sheet_list):
     return yaml_file
 
 
-def convert_yml_to_excel(oss_yaml_files, output_file, file_option_on, base_path):
+def convert_yml_to_excel(
+    oss_yaml_files: List[str],
+    output_file: str,
+    file_option_on: bool,
+    base_path: str
+) -> None:
     sheet_list = {}
     header = {}
 

src/fosslight_prechecker/_add.py

@@ -9,6 +9,7 @@
 import sys
 import fosslight_util.constant as constant
 import urllib.request
+import argparse
 from yaml import safe_dump
 from fosslight_util.set_log import init_log
 from fosslight_util.spdx_licenses import get_spdx_licenses_json, get_license_from_nick
@@ -24,6 +25,7 @@
 from reuse.project import Project
 from bs4 import BeautifulSoup
 from pathlib import Path
+from typing import List, Optional
 
 
 PKG_NAME = "fosslight_prechecker"
@@ -37,13 +39,13 @@
 logger = logging.getLogger(constant.LOGGER_NAME)
 
 
-def convert_to_spdx_style(input_string):
+def convert_to_spdx_style(input_string: str) -> str:
     input_string = input_string.replace(" ", "-")
     input_converted = f"LicenseRef-{input_string}"
     return input_converted
 
 
-def check_input_license_format(input_license):
+def check_input_license_format(input_license: str) -> str:
     for spdx in spdx_licenses:
         if input_license.casefold() == spdx.casefold():
             return spdx
@@ -66,7 +68,7 @@ def check_input_license_format(input_license):
     return converted_license
 
 
-def check_input_copyright_format(input_copyright):
+def check_input_copyright_format(input_copyright: str) -> bool:
     regex = re.compile(r'Copyright(\s)+(\(c\)\s)?\s*\d{4}(-\d{4})*(\s)+(\S)+')
     check_ok = True
 
@@ -77,7 +79,7 @@ def check_input_copyright_format(input_copyright):
     return check_ok
 
 
-def input_license_while_running():
+def input_license_while_running() -> str:
     input_license = ""
 
     logger.info("# Select a license to write in the license missing files ")
@@ -95,7 +97,7 @@ def input_license_while_running():
     return input_license
 
 
-def input_copyright_while_running():
+def input_copyright_while_running() -> Optional[str]:
     input_copyright = ""
     input_copyright = input("# Input Copyright to write in the copyright missing files (ex, <year> <name>): ")
     if input_copyright == 'Quit' or input_copyright == 'quit' or input_copyright == 'Q':
@@ -104,7 +106,7 @@ def input_copyright_while_running():
     return input_copyright
 
 
-def input_dl_url_while_running():
+def input_dl_url_while_running() -> Optional[str]:
     input_dl_url = ""
     input_dl_url = input("# Input Download URL to write to missing files (ex, https://github.com/fosslight/fosslight-prechecker): ")
     if input_dl_url == 'Quit' or input_dl_url == 'quit' or input_dl_url == 'Q':
@@ -113,7 +115,13 @@ def input_dl_url_while_running():
     return input_dl_url
 
 
-def add_dl_url_into_file(main_parser, project, path_to_find, input_dl_url, file_list):
+def add_dl_url_into_file(
+    main_parser: argparse.ArgumentParser,
+    project: Project,
+    path_to_find: str,
+    input_dl_url: str,
+    file_list: List[str]
+) -> None:
     logger.info("\n# Adding Download Location into your files")
     logger.warning(f"  * Your input DownloadLocation : {input_dl_url}")
     add_dl_url_list = [os.path.join(path_to_find, file) for file in file_list]
@@ -125,7 +133,12 @@ def add_dl_url_into_file(main_parser, project, path_to_find, input_dl_url, file_
         dump_error_msg(f"Error_to_add_url : {ex}")
 
 
-def add_license_into_file(main_parser, project, input_license, file_list):
+def add_license_into_file(
+    main_parser: argparse.ArgumentParser,
+    project: Project,
+    input_license: str,
+    file_list: List[str]
+) -> None:
     converted_license = check_input_license_format(input_license)
     logger.warning(f"  * Your input license : {converted_license}")
     parsed_args = main_parser.parse_args(['addheader', '--license', str(converted_license)] + file_list)
@@ -135,7 +148,12 @@ def add_license_into_file(main_parser, project, input_license, file_list):
         dump_error_msg(f"Error_call_run_in_license : {ex}")
 
 
-def add_copyright_into_file(main_parser, project, input_copyright, file_list):
+def add_copyright_into_file(
+    main_parser: argparse.ArgumentParser,
+    project: Project,
+    input_copyright: str,
+    file_list: List[str]
+) -> None:
     input_copyright = f"Copyright {input_copyright}"
 
     input_ok = check_input_copyright_format(input_copyright)
@@ -152,8 +170,16 @@ def add_copyright_into_file(main_parser, project, input_copyright, file_list):
         dump_error_msg(f"Error_call_run_in_copyright : {ex}")
 
 
-def set_missing_license_copyright(missing_license_filtered, missing_copyright_filtered, project,
-                                  path_to_find, license, copyright, total_files_excluded, input_dl_url):
+def set_missing_license_copyright(
+    missing_license_filtered: Optional[List[str]],
+    missing_copyright_filtered: Optional[List[str]],
+    project: Project,
+    path_to_find: str,
+    license: str,
+    copyright: str,
+    total_files_excluded: List[str],
+    input_dl_url: str
+) -> None:
     input_license = ""
     input_copyright = ""
 
@@ -218,15 +244,15 @@ def get_allfiles_list(path):
         dump_error_msg(f"Error - get all files list : {ex}")
 
 
-def save_result_log():
+def save_result_log() -> None:
     try:
         _str_final_result_log = safe_dump(_result_log, allow_unicode=True, sort_keys=True)
         logger.info(_str_final_result_log)
     except Exception as ex:
         logger.warning(f"Failed to print add result log. : {ex}")
 
 
-def copy_to_root(path_to_find, input_license):
+def copy_to_root(path_to_find: str, input_license: str) -> None:
     lic_file = f"{input_license}.txt"
     try:
         source = os.path.join(path_to_find, 'LICENSES', f'{lic_file}')
@@ -236,7 +262,7 @@ def copy_to_root(path_to_find, input_license):
         dump_error_msg(f"Error - Can't copy license file: {ex}")
 
 
-def lge_lic_download(path_to_find, input_license):
+def lge_lic_download(path_to_find: str, input_license: str) -> bool:
     success = False
 
     input_license_url = input_license.replace(' ', '_').replace('/', '_').replace('LicenseRef-', '').replace('-', '_')
@@ -269,7 +295,7 @@ def lge_lic_download(path_to_find, input_license):
     return success
 
 
-def present_license_file(path_to_find, lic):
+def present_license_file(path_to_find: str, lic: str) -> bool:
     present = False
     lic_file_path = os.path.join(os.getcwd(), path_to_find, 'LICENSES')
     file_name = f"{lic}.txt"
@@ -278,7 +304,7 @@ def present_license_file(path_to_find, lic):
     return present
 
 
-def find_representative_license(path_to_find, input_license):
+def find_representative_license(path_to_find: str, input_license: str) -> None:
     files = []
     found_file = []
     found_license_file = False
@@ -324,7 +350,7 @@ def find_representative_license(path_to_find, input_license):
         dump_error_msg(f"Error - download representative license text: {ex}")
 
 
-def is_exclude_dir(dir_path):
+def is_exclude_dir(dir_path: str) -> Optional[bool]:
     if dir_path != "":
         dir_path = dir_path.lower()
         dir_path = dir_path if dir_path.endswith(
@@ -335,7 +361,7 @@ def is_exclude_dir(dir_path):
     return
 
 
-def download_oss_info_license(base_path, input_license=""):
+def download_oss_info_license(base_path: str, input_license: str = "") -> None:
     license_list = []
     converted_lic_list = []
     oss_yaml_files = []
@@ -370,7 +396,14 @@ def download_oss_info_license(base_path, input_license=""):
         logger.info(" # There is no license in the path \n")
 
 
-def add_content(target_path="", input_license="", input_copyright="", input_dl_url="", output_path="", need_log_file=True):
+def add_content(
+    target_path: str = "",
+    input_license: str = "",
+    input_copyright: str = "",
+    input_dl_url: str = "",
+    output_path: str = "",
+    need_log_file: bool = True
+) -> None:
     global _result_log, spdx_licenses
     _check_only_file_mode = False
     file_to_check_list = []
@@ -450,7 +483,8 @@ def add_content(target_path="", input_license="", input_copyright="", input_dl_u
         logger.info(f"\n# File list that have both license and copyright : {len(skip_files)} / {len(total_files_excluded)}")
 
         # Filter by file extension
-        total_files_excluded = [file for file in total_files_excluded if os.path.splitext(file)[1].lower() in EXTENSION_COMMENT_STYLE_MAP_LOWERCASE]
+        total_files_excluded = [file for file in total_files_excluded
+                                if os.path.splitext(file)[1].lower() in EXTENSION_COMMENT_STYLE_MAP_LOWERCASE]
         missing_license = [file for file in missing_license if os.path.splitext(file)[1].lower() in EXTENSION_COMMENT_STYLE_MAP_LOWERCASE]
         missing_copyright = [file for file in missing_copyright if os.path.splitext(file)[1].lower() in EXTENSION_COMMENT_STYLE_MAP_LOWERCASE]
 

src/fosslight_prechecker/_help.py

@@ -40,6 +40,6 @@
             -u <dl_location>\t    Download Location to add(ex, "https://github.com/fosslight/fosslight_prechecker")"""
 
 
-def print_help_msg(exitOpt=True):
+def print_help_msg(exitOpt: bool = True) -> None:
     helpMsg = PrintHelpMsg(_HELP_MESSAGE_PRECHECKER)
     helpMsg.print_help_msg(exitOpt)