supports adding datasets of different extension types

Author: PeterVL02

README.md

@@ -196,6 +196,20 @@ Below is a list of commands. The commands have obligatory and optional parameter
  */
 ```
 
+### Command (Data)
+```bash
+>> list_cols
+```
+
+```javascript
+/**
+ * Lists the columns of the dataset of the current project.
+ *
+ * @description
+ * Use this function to list the columns of the dataset. The column names will be displayed in the console.
+ */
+```
+
 ### Command (Data)
 ```bash
 >> clean_data

requirements.txt

@@ -33,7 +33,7 @@ def _parse_models(*args: Any) -> tuple[InplaceModel, InplaceModel]:
         model = args[0]
         try:
             project = model.projects[model.current_project]
-        except (AttributeError, IndexError):
+        except (AttributeError, IndexError, KeyError):
             project = InplaceModel()
     except IndexError:
         model = InplaceModel()

src/cliresult.py

@@ -4,7 +4,7 @@
                                     add_data, read_data, make_X_y, 
                                     clean_data, summary,
                                     save, load_project_from_file,
-                                    plot, show, stats
+                                    plot, show, stats, list_cols
                                     )
 from src.commands.ml_cmds import (linreg, mlpreg, naivebayes, mlpclas, 
                                   logisticreg, decisiontree, randomforest, 
@@ -42,6 +42,7 @@ def list_cmds(*args, **kwargs) -> str:
     "pcp" : pcp,
     "help" : list_cmds,
     "add_data": add_data,
+    "list_cols": list_cols,
     "read_data": read_data,
     "make_x_y": make_X_y,
     "clean_data": clean_data,

src/commands/command_factory.py

@@ -37,7 +37,7 @@ def convert_to_type(type_str: str) -> ProjectType:
         type_str = short_type[type_str]
     try:
         return ProjectType[type_str.upper()]
-    except ValueError:
+    except (ValueError, KeyError):
         raise ValueError(f"Invalid project type: {type_str}")
 
 def convert_to_ml_type(type_str: str) -> MlModel:

src/commands/command_utils.py

@@ -1,8 +1,10 @@
 from src.commands.project_store_protocol import Model
 from src.commands.command_utils import convert_to_type, convert_to_ml_type
+from src.cliresult import chain, add_warning
 
 import numpy as np
 
+@chain
 def create(model: Model, alias: str, type: str, *args, **kwargs) -> str:
     """Creates a new project with the given alias and type.
 
@@ -15,13 +17,14 @@ def create(model: Model, alias: str, type: str, *args, **kwargs) -> str:
         str: Optional message to display to the user.
     """
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     new_type = convert_to_type(type)
     return model.create(alias, new_type)
 
+@chain
 def delete(model: Model, alias: str, from_dir: bool = False, *args, **kwargs) -> str:
     """
     Deletes the project with the given alias.
@@ -34,12 +37,13 @@ def delete(model: Model, alias: str, from_dir: bool = False, *args, **kwargs) ->
         str: Optional message to display to the user.
     """
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     return model.delete(alias, from_dir = from_dir)
 
+@chain
 def list_projects(model: Model, *args, **kwargs) -> str:
     """
     Lists all projects in the model.
@@ -51,12 +55,13 @@ def list_projects(model: Model, *args, **kwargs) -> str:
         list[str]: A list of project aliases.
     """
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     return model.list_projects()
 
+@chain
 def set_current_project(model: Model, alias: str, *args, **kwargs) -> str:
     """
     Sets the current project to the one with the given alias.
@@ -69,9 +74,9 @@ def set_current_project(model: Model, alias: str, *args, **kwargs) -> str:
         str: Optional message to display to the user.
     """
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     return model.set_current_project(alias)
 
@@ -87,24 +92,32 @@ def pcp(model: Model) -> str:
     """
     return model.pcp()
 
-def add_data(model: Model, df_name: str, *args, **kwargs) -> str:
+@chain
+def add_data(model: Model, df_name: str, delimiter: str = ',', *args, **kwargs) -> str:
     """
     Adds a DataFrame to the current project.
+    
+    Supported file extensions:
+    - .csv
+    - .txt
+    - .xls, .xlsx
+    - .json
+    - .xml
+    - .html        
 
     Args:
         model (Model): Parsed automatically by the command parser.
-        df_name (str): Name of the DataFrame to add.
-
-    Returns:
-        None
+        alias (str): Name of the DataFrame to add.
+        delimiter (str): Delimiter used in the DataFrame (ignored if format is not '.txt' or '.csv').
     """
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
-    return model.add_data(df_name)
+    return model.add_data(df_name, delimiter = delimiter)
 
+@chain
 def read_data(model: Model, head: int = 5, *args, **kwargs) -> str:
     """
     Reads the data from the current project.
@@ -117,12 +130,31 @@ def read_data(model: Model, head: int = 5, *args, **kwargs) -> str:
         str: A string representation of the DataFrame.
     """
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     return model.read_data(head)
 
+@chain
+def list_cols(model: Model, *args, **kwargs) -> str:
+    """
+    Lists the columns of dataframe in the current project.
+
+    Args:
+        model (Model): Parsed automatically by the command parser.
+
+    Returns:
+        str: A list of columns in the current project.
+    """
+    if args:
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
+    elif kwargs:
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
+        
+    return model.list_cols()
+
+@chain
 def make_X_y(model: Model, target: str, *args, **kwargs) -> str:
     """
     Creates the X and y arrays from the current project.
@@ -135,12 +167,13 @@ def make_X_y(model: Model, target: str, *args, **kwargs) -> str:
         str: Optional message to display to the user.
     """
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     return model.make_X_y(target)
 
+@chain
 def clean_data(model: Model, *args, **kwargs) -> str:
     """
     Cleans the data in the current project.
@@ -152,12 +185,13 @@ def clean_data(model: Model, *args, **kwargs) -> str:
         str: Optional message to display to the user.
     """
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     return model.clean_data()
 
+@chain
 def log_model(model: Model, model_name: str, predictions: np.ndarray, params: dict[str, float | int | str], *args, **kwargs) -> str:
     """
     Logs a model in the current project.
@@ -172,13 +206,14 @@ def log_model(model: Model, model_name: str, predictions: np.ndarray, params: di
         str: Optional message to display to the user.
     """
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     model_name = convert_to_ml_type(model_name)
     return model.log_model(model_name, predictions, params)
 
+@chain
 def summary(model: Model, *args, **kwargs) -> str:
     """
     Summarizes the current project.
@@ -190,12 +225,13 @@ def summary(model: Model, *args, **kwargs) -> str:
         str: A summary of the current project.
     """
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     return model.summary()
 
+@chain
 def save(model: Model, overwrite: bool = False, *args, **kwargs) -> str:
     """
     Saves the current project.
@@ -208,12 +244,13 @@ def save(model: Model, overwrite: bool = False, *args, **kwargs) -> str:
         str: Optional message to display to the user.
     """
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     return model.save(overwrite=overwrite)
 
+@chain
 def load_project_from_file(model: Model, alias: str, *args, **kwargs) -> str:
     """
     Loads a project from a file.
@@ -226,12 +263,13 @@ def load_project_from_file(model: Model, alias: str, *args, **kwargs) -> str:
         str: Optional message to display to the user.
     """        
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     return model.load_project_from_file(alias)
 
+@chain
 def plot(model: Model, cmd: str, labels: str | list[str] | None = None, show: bool = False, *args, **kwargs) -> str:
     """
     Generates a plot based on the given command and labels.
@@ -248,12 +286,13 @@ def plot(model: Model, cmd: str, labels: str | list[str] | None = None, show: bo
     if labels is None:
         labels = []
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     return model.plot(cmd, labels, show)
 
+@chain
 def show(model: Model, *args, **kwargs) -> str:
     """
     Displays the plot for the current project.
@@ -265,12 +304,13 @@ def show(model: Model, *args, **kwargs) -> str:
         str: The result of the show command.
     """
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     return model.show()
 
+@chain
 def stats(model: Model, *args, **kwargs) -> str:
     """
     Displays the statistics for the current project.
@@ -282,8 +322,8 @@ def stats(model: Model, *args, **kwargs) -> str:
         str: The result of the stats command.
     """
     if args:
-        print(f"Warning: extra arguments {args} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {args} will be ignored.")
     elif kwargs:
-        print(f"Warning: extra arguments {kwargs} will be ignored.")
+        add_warning(model, f"Warning: extra arguments {kwargs} will be ignored.")
 
     return model.stats()

src/commands/proj_cmds.py

@@ -22,9 +22,11 @@ def set_current_project(self, alias: str) -> str: ...
 
     def pcp(self) -> str: ...
 
-    def add_data(self, df_name: str) -> str: ...
+    def add_data(self, df_name: str, delimiter: str = ',') -> str: ...
 
     def read_data(self, head: int = 5) -> str: ...
+    
+    def list_cols(self) -> str: ...
 
     def make_X_y(self, target: str) -> str: ...