malwareDetector 0.1.9__tar.gz → 0.1.11__tar.gz

{malwareDetector-0.1.9 → malwareDetector-0.1.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: malwareDetector
-Version: 0.1.9
+Version: 0.1.11
 Summary: Malware detector specification for NTUST isLab
 Author: PO-LIN LAI
 Author-email: bolin8017@gmail.com

{malwareDetector-0.1.9 → malwareDetector-0.1.11}/malwareDetector/config.py

@@ -25,6 +25,7 @@ class PathConfig(BaseModel, extra=Extra.allow):
     '''
     input: str = DEFAULT_INPUT_PATH
     output: str = DEFAULT_OUT_PATH
+    config: str = DEFAULT_CONFIG_PATH
 
     def set_param(self, __name: str, __value: Any):
         if hasattr(self, __name):
@@ -185,6 +186,12 @@ def parameter_parser(config: Config) -> Config:
                         help="Embeddings path."
                         )
 
+    parser.add_argument("--config-path","-c",
+                        dest="config_path",
+                        nargs="?",
+                        default=DEFAULT_CONFIG_PATH,
+                        help="Configuration file path.")
+
     parser.add_argument("--dimensions",
                         dest="dimensions",
                         type=int,
@@ -241,7 +248,7 @@ def parameter_parser(config: Config) -> Config:
                         help='Select the model(KNN, LR, MLP, RF, SVM).'
                         )
 
-    parser.add_argument('--classify', '-c',
+    parser.add_argument('--classify', '-f',
                         dest="classify",
                         action='store_true',
                         default=DEFAULT_CLASSIFY,
@@ -251,6 +258,7 @@ def parameter_parser(config: Config) -> Config:
     args = parser.parse_args()
     config.path.input = args.input_path
     config.path.output = args.output_path
+    config.path.config = args.config_path
     config.model.dimensions = args.dimensions
     config.model.workers = args.workers
     config.model.epochs = args.epochs
@@ -263,58 +271,62 @@ def parameter_parser(config: Config) -> Config:
 
     return config
 
-def write_config_to_file(config: Config):
+def write_config_to_file(config: Config, config_file_path=DEFAULT_CONFIG_PATH):
     '''
-    Writes the parameter settings of
-    the config object to a JSON file in
-    the execution folder with the
-    default name `config.json`.
+    Writes the parameter settings of the config object to a JSON file
+    in the execution folder with the default path `"./config.json."`
+    or you can specify the path by passing the `config_file_path` parameter.
     '''
 
-    with open(CONFIG_FILE_NAME, "w", encoding="utf8") as file:
+    with open(config_file_path, "w", encoding="utf8") as file:
         file.write(config.json(exclude={"folder": {"folder_list"}}))
 
-def detect_config_file() -> None:
+def detect_config_file(config_file_path=DEFAULT_CONFIG_PATH) -> None:
     '''
     If you run Python using the IPython approach,
     the command line parsing functionality will not be enabled.
     On the other hand, if you execute Python in the regular way,
     it will utilize argparse to read the parameters passed through the command line.
+    default config.json will be created in the local folder if it does not exist.
+    `config_file_path` is the path to the config file.
     '''
 
     if 'ipykernel' not in sys.modules and len(sys.argv) > 1:
         logging.info(
             "Creating local config file by argparse."
         )
-        write_config_to_file(parameter_parser(Config()))
-        logging.info(f"{CONFIG_FILE_NAME} created!")
-    elif CONFIG_FILE_NAME in os.listdir():
-        logging.info(f"{CONFIG_FILE_NAME} detected!")
+        config = parameter_parser(Config())
+        config_file_path = config.path.config
+        write_config_to_file(config, config.path.config)
+        logging.info(f"{config_file_path} created!")
+    elif config_file_path in os.listdir():
+        logging.info(f"{config_file_path} detected!")
     else:
         logging.info(
             "config file not found. creating local config file by default config."
         )
-        write_config_to_file(Config())
-        logging.info(f"{CONFIG_FILE_NAME} created!")
+        write_config_to_file(Config(), config_file_path)
+        logging.info(f"{config_file_path} created!")
+    return config_file_path
 
-def read_config(count=1) -> Config:
+def read_config(config_file_path=DEFAULT_CONFIG_PATH, count=1) -> Config:
     '''
-    Reads the settings from the `config.json` file.
+    Reads the settings from config_file_path and returns a Config object.
     '''
+
     if count > 3:
         logging.warning("Failed to read config, returning default config")
         return Config()
     if count != 1:
         logging.info(f"Trying to read config time:{count}")
     try:
-        with open(CONFIG_FILE_NAME, encoding="utf-8") as file:
+        config_file_path = detect_config_file(config_file_path=config_file_path)
+        with open(config_file_path, encoding="utf-8") as file:
             config = Config.parse_raw(file.read())
             config.folder.update_folder_list()
             return config
     except Exception as err:
         logging.warning(err)
-        detect_config_file(argparse=False)
-        return read_config(count=count+1)
+        return read_config(config_file_path=config_file_path, count=count+1)
 
-detect_config_file()
 logging.info("config.py got executed")

{malwareDetector-0.1.9 → malwareDetector-0.1.11}/malwareDetector/const.py

@@ -1,10 +1,10 @@
 '''
 Save the variables of the system's default constants.
 '''
-CONFIG_FILE_NAME="config.json"
 
 DEFAULT_INPUT_PATH="./Dataset/malware"
 DEFAULT_OUT_PATH="./Feature/feature.csv"
+DEFAULT_CONFIG_PATH="./config.json"
 DEFAULT_MODEL_NAME="SVM"
 DEFAULT_DIMENSIONS=128
 DEFAULT_WORKERS=4

{malwareDetector-0.1.9 → malwareDetector-0.1.11}/malwareDetector.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: malwareDetector
-Version: 0.1.9
+Version: 0.1.11
 Summary: Malware detector specification for NTUST isLab
 Author: PO-LIN LAI
 Author-email: bolin8017@gmail.com

{malwareDetector-0.1.9 → malwareDetector-0.1.11}/setup.py

@@ -11,7 +11,7 @@ required_packages = [
 setup(
     name='malwareDetector',
     packages=find_packages(include=['malwareDetector']),
-    version='0.1.9',
+    version='0.1.11',
     description='Malware detector specification for NTUST isLab',
     long_description=long_description,
     long_description_content_type="text/markdown",