malwareDetector 0.1.7__tar.gz → 0.1.9__tar.gz

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

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

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

@@ -9,17 +9,33 @@ from pydantic import BaseModel, Extra
 from typing import List, Any
 from .const import *
 
-class PathConfig(BaseModel):
+class PathConfig(BaseModel, extra=Extra.allow):
     '''
     The `PathConfig` class stores the input file path
     and output file path settings for the detector,
     which are obtained from `parameter_parser()`.
     If no additional settings are provided,
     default values will be used.
+
+    If you wish to create a customized parameter,
+    there has two methods to do it.
+    1. please refer to the `set_param` and `del_param`
+    method of the `PathConfig` class.
+    2. directly set the parameter in the `config.json` file.
     '''
     input: str = DEFAULT_INPUT_PATH
     output: str = DEFAULT_OUT_PATH
 
+    def set_param(self, __name: str, __value: Any):
+        if hasattr(self, __name):
+            raise AttributeError(f"Parameter {__name} already exists.")
+        else:
+            setattr(self, __name, __value)
+
+    def del_param(self, __name: str):
+        if hasattr(self, __name):
+            delattr(self, __name)
+
 class ModelConfig(BaseModel, extra=Extra.allow):
     '''
     The `ModelConfig` class stores the
@@ -29,8 +45,10 @@ class ModelConfig(BaseModel, extra=Extra.allow):
     default values will be used.
 
     If you wish to create a customized parameter,
-    please refer to the `set_param` method of
-    the `ModelConfig` class.
+    there has two methods to do it.
+    1. please refer to the `set_param` and `del_param`
+    method of the `ModelConfig` class.
+    2. directly set the parameter in the `config.json` file.
     '''
     modelName: str = DEFAULT_MODEL_NAME
     dimensions: int = DEFAULT_DIMENSIONS
@@ -56,19 +74,20 @@ class FolderConfig(BaseModel, extra=Extra.allow):
     The `FolderConfig` class stores the names
     of folders where the stored data is kept.
 
-    If you wish to create a customized folder,
-    please refer to the `set_folder` method of
-    the `FolderConfig` class.
+    If you wish to create a customized parameter,
+    there has two methods to do it.
+    1. please refer to the `set_folder` and `del_folder`
+    method of the `FolderConfig` class.
+    2. directly set the parameter in the `config.json` file.
     '''
     dataset: str = DATASET_DIR
     feature: str = FEATURE_DIR
     vectorize: str = VECTORIZE_DIR
     model: str = MODEL_DIR
     predict: str = PREDICT_DIR
-    folder_list: List[str] = [dataset, feature, vectorize, model, predict]
 
     def update_folder_list(self):
-        self.folder_list = [self.dataset, self.feature, self.vectorize, self.model, self.predict]
+        self.folder_list = [getattr(self, folder) for folder in self.__dict__.keys()]
 
     def __iter__(self):
         return FolderClassIter(self.folder_list)
@@ -110,7 +129,7 @@ class FolderClassIter(object):
             return member
         raise StopIteration
 
-class Config(BaseModel):
+class Config(BaseModel, extra=Extra.allow):
     '''
     The `Config` class stores all the external settings
     for the detector, which are obtained from `parameter_parser()`.
@@ -121,12 +140,28 @@ class Config(BaseModel):
         `FolderConfig`: Contains configurations for folders and directories.
         `ModelConfig`: Includes settings specific to the model.
         `classify`: Determines whether the task is malware family classification or simple malware detection.
+
+    If you wish to create a customized parameter,
+    there has two methods to do it.
+    1. please refer to the `set_param` and `del_param`
+    method of the `Config` class.
+    2. directly set the parameter in the `config.json` file.
     '''
     path: PathConfig = PathConfig()
     folder: FolderConfig = FolderConfig()
     model: ModelConfig = ModelConfig()
     classify: bool = DEFAULT_CLASSIFY
 
+    def set_param(self, __name: str, __value: Any):
+        if hasattr(self, __name):
+            raise AttributeError(f"Parameter {__name} already exists.")
+        else:
+            setattr(self, __name, __value)
+
+    def del_param(self, __name: str):
+        if hasattr(self, __name):
+            delattr(self, __name)
+
 def parameter_parser(config: Config) -> Config:
     '''
     A method for parsing command line parameters
@@ -233,10 +268,11 @@ def write_config_to_file(config: Config):
     Writes the parameter settings of
     the config object to a JSON file in
     the execution folder with the
-    default name `"config.json."`
+    default name `config.json`.
     '''
+
     with open(CONFIG_FILE_NAME, "w", encoding="utf8") as file:
-        file.write(config.json())
+        file.write(config.json(exclude={"folder": {"folder_list"}}))
 
 def detect_config_file() -> None:
     '''

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

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

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

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