Fix windows installation and add tests

Author: mfi-xor

askai/entrypoint_config.py

@@ -1,5 +1,8 @@
+from pathlib import Path
+
 import click
 
+from .constants import CONFIG_PATH
 from .utils import ConfigHelper, PrintHelper
 
 
@@ -11,10 +14,15 @@ def config() -> None:
 
 @config.command(help="Reset the config to default")
 def reset() -> None:
+    _reset()
+
+
+def _reset(config_path: Path = CONFIG_PATH) -> None:
+    """Separate function for testing"""
     user_verification = input("Do you want to reset your config to the default values? [y/Y]? ")
 
     if user_verification.lower() in ["y", "yes"]:
-        ConfigHelper().reset()
+        ConfigHelper().reset(config_path=config_path)
     else:
         click.echo("Config not reset. Aborted!")
 
@@ -31,6 +39,11 @@ def update() -> None:
 
 @update.command("all", help="Interface to update the full default config")
 def update_all() -> None:
+    _update_all()
+
+
+def _update_all(config_path: Path = CONFIG_PATH) -> None:
+    """Separate function for testing"""
     config_helper = ConfigHelper()
     PrintHelper.update_config()
 
@@ -62,60 +75,95 @@ def update_all() -> None:
     PrintHelper.presence_penalty()
     config_helper.input_presence_penalty()
 
-    config_helper.update()
+    config_helper.update(config_path=config_path)
 
 
 @update.command(help="Update model")
 def model() -> None:
+    _model()
+
+
+def _model(config_path: Path = CONFIG_PATH) -> None:
+    """Separate function for testing"""
     PrintHelper.model()
     config_helper = ConfigHelper.from_file()
     config_helper.input_model()
-    config_helper.update()
+    config_helper.update(config_path=config_path)
 
 
 @update.command(help="Update number of altenative answers generated per question")
 def num_answers() -> None:
+    _num_answers()
+
+
+def _num_answers(config_path: Path = CONFIG_PATH) -> None:
+    """Separate function for testing"""
     PrintHelper.num_answers()
     config_helper = ConfigHelper.from_file()
     config_helper.input_num_answer()
-    config_helper.update()
+    config_helper.update(config_path=config_path)
 
 
 @update.command(help="Update maximum number of tokens")
 def max_tokens() -> None:
+    _max_tokens()
+
+
+def _max_tokens(config_path: Path = CONFIG_PATH) -> None:
+    """Separate function for testing"""
     PrintHelper.max_tokens()
     config_helper = ConfigHelper().from_file()
     config_helper.input_max_token()
-    config_helper.update()
+    config_helper.update(config_path=config_path)
 
 
 @update.command(help="Update temperature")
 def temperature() -> None:
+    _temperature()
+
+
+def _temperature(config_path: Path = CONFIG_PATH) -> None:
+    """Separate function for testing"""
     PrintHelper.temperature()
     config_helper = ConfigHelper().from_file()
     config_helper.input_temperature()
-    config_helper.update()
+    config_helper.update(config_path=config_path)
 
 
 @update.command(help="Update top_p")
 def top_p() -> None:
+    _top_p()
+
+
+def _top_p(config_path: Path = CONFIG_PATH) -> None:
+    """Separate function for testing"""
     PrintHelper.top_p()
     config_helper = ConfigHelper().from_file()
     config_helper.input_top_p()
-    config_helper.update()
+    config_helper.update(config_path=config_path)
 
 
 @update.command(help="Update frequency penalty")
 def frequency_penalty() -> None:
+    _frequency_penalty()
+
+
+def _frequency_penalty(config_path: Path = CONFIG_PATH) -> None:
+    """Separate function for testing"""
     PrintHelper.frequency_penalty()
     config_helper = ConfigHelper.from_file()
     config_helper.input_frequency_penalty()
-    config_helper.update()
+    config_helper.update(config_path=config_path)
 
 
 @update.command(help="Update presence penalty")
 def presence_penalty() -> None:
+    _frequency_penalty()
+
+
+def _presence_penalty(config_path: Path = CONFIG_PATH) -> None:
+    """Separate function for testing"""
     PrintHelper.presence_penalty()
     config_helper = ConfigHelper.from_file()
     config_helper.input_presence_penalty()
-    config_helper.update()
+    config_helper.update(config_path=config_path)

askai/entrypoint_init.py

@@ -1,19 +1,27 @@
+from pathlib import Path
+
 import click
 
+from .constants import CONFIG_PATH, API_KEY_PATH
 from .utils import KeyHelper, ConfigHelper, PrintHelper
 
 
 @click.command()
 def init() -> None:
     """Initialize askai."""
-    key_helper = KeyHelper()
-    config_helper = ConfigHelper()
+    _init()
+
+
+def _init(config_path: Path = CONFIG_PATH, api_key_path: Path = API_KEY_PATH) -> None:
+    """Separate function for testing"""
     PrintHelper.logo()
 
+    key_helper = KeyHelper()
     PrintHelper.key()
     key_helper.input()
-    key_helper.save()
+    key_helper.save(api_key_path=api_key_path)
 
-    config_helper.reset()
+    config_helper = ConfigHelper()
+    config_helper.reset(config_path=config_path)
 
     click.echo("Initialization done!")

askai/entrypoint_key.py

@@ -1,3 +1,5 @@
+from pathlib import Path
+
 import click
 
 from .utils import KeyHelper, PrintHelper
@@ -13,22 +15,32 @@ def key():
 @key.command()
 def add() -> None:
     """Add API key"""
+    _add()
+
+
+def _add(api_key_path: Path = API_KEY_PATH) -> None:
+    """Separate function for testing"""
     if API_KEY_PATH.is_file():
         PrintHelper.key_exists()
 
     key_helper = KeyHelper()
     key_helper.input()
-    key_helper.save()
+    key_helper.save(api_key_path=api_key_path)
 
 
 @key.command()
 def remove() -> None:
     """Remove your stored API key"""
+    _remove()
+
+
+def _remove(api_key_path: Path = API_KEY_PATH) -> None:
+    """Separate function for testing"""
     if not API_KEY_PATH.is_file():
         PrintHelper.no_key()
     else:
         user_verification = input("Do you want to remove your API key? [y/Y]? ")
         if user_verification.lower() in ["y", "yes"]:
-            KeyHelper().remove()
+            KeyHelper().remove(api_key_path=api_key_path)
         else:
             click.echo("API key not removed.")

askai/utils.py

@@ -51,7 +51,7 @@ class ConfigHelper:
     @classmethod
     def from_file(cls, config_path: Path = CONFIG_PATH) -> 'ConfigHelper':
         if config_path.is_file():
-            with open(config_path, "r") as f:
+            with open(config_path, "r", encoding="utf8") as f:
                 config = yaml.safe_load(f)
                 return cls(**config)
         else:
@@ -145,15 +145,15 @@ def as_dict(self) -> dict:
 
     def update(self, config_path: Path = CONFIG_PATH) -> None:
         config = self.as_dict()
-        with open(config_path, "w") as f:
+        with open(config_path, "w", encoding="utf8") as f:
             yaml.dump(config, f)
 
         click.echo(click.style("Config updated successfully!", fg="green"))
 
     @staticmethod
     def reset(config_path: Path = CONFIG_PATH) -> None:
         config = ConfigHelper().as_dict()  # Create config with default values
-        with open(config_path, "w") as f:
+        with open(config_path, "w", encoding="utf8") as f:
             yaml.dump(config, f)
 
         click.echo("\nDefault config has been created with the following values:")
@@ -168,7 +168,7 @@ def show(config_path: Path = CONFIG_PATH) -> None:
             click.echo("No config exists. Please reset the config ('askai config reset') "
                        "or see 'askai config --help'.\n")
         else:
-            with open(config_path, "r") as f:
+            with open(config_path, "r", encoding="utf8") as f:
                 try:
                     config = yaml.safe_load(f)
                     for key, value in config.items():
@@ -229,9 +229,9 @@ def _input_float(default_value: float,
         exit(1)
 
 
-@dataclass
 class KeyHelper:
-    api_key: str = ""
+    def __init__(self):
+        self._api_key: str = ""
 
     def input(self) -> None:
         key = getpass("Enter API Key: ")
@@ -245,22 +245,26 @@ def input(self) -> None:
             key = getpass("Enter API Key: ")
             num_tries += 1
 
-        self.api_key = key
+        self._api_key = key
 
-    def save(self) -> None:
-        API_KEY_PATH.parent.mkdir(parents=True, exist_ok=True)
-        API_KEY_PATH.write_text(self.api_key)
+    def save(self, api_key_path: Path = API_KEY_PATH) -> None:
+        api_key_path.parent.mkdir(parents=True, exist_ok=True)
+        api_key_path.write_text(self._api_key, encoding="utf8")
         click.echo(click.style("Your API key has been successfully added!", fg="green"))
 
     @staticmethod
-    def remove() -> None:
-        API_KEY_PATH.unlink()
-        click.echo(click.style("API key removed.", fg="green"))
+    def remove(api_key_path: Path = API_KEY_PATH) -> None:
+        try:
+            api_key_path.unlink()
+            click.echo(click.style("API key removed.", fg="green"))
+        except FileNotFoundError:
+            click.echo(click.style("No API key found.", fg="red"))
+            exit()
 
-    @classmethod
-    def from_file(cls) -> str:
-        if API_KEY_PATH.is_file():
-            with open(API_KEY_PATH, "r") as f:
+    @staticmethod
+    def from_file(api_key_path: Path = API_KEY_PATH) -> str:
+        if api_key_path.is_file():
+            with open(api_key_path, "r", encoding="utf8") as f:
                 api_key = f.read().strip()
             return api_key
         else:

setup.py

@@ -6,7 +6,7 @@
     version="1.0.3",
     author="Max Fischer",
     description="Your simple terminal helper",
-    long_description=open('README.md').read(),
+    long_description=open("README.md", encoding="utf8").read(),
     long_description_content_type="text/markdown",
     license="MIT",
     url="https://github.com/maxvfischer/askai",

tests/test_auxiliary.py

@@ -0,0 +1,27 @@
+import pytest
+
+from askai.utils import _is_int, _is_float
+
+
+@pytest.mark.parametrize(
+    "value, is_int",
+    [
+        ("1", True),
+        ("a", False),
+        ("0.1", False),
+    ]
+)
+def test_is_int(value: str, is_int: bool) -> None:
+    assert _is_int(value) == is_int
+
+
+@pytest.mark.parametrize(
+    "value, is_float",
+    [
+        ("1", True),
+        ("1.0", True),
+        ("a", False),
+    ]
+)
+def test_is_float(value: str, is_float: bool) -> None:
+    assert _is_float(value) == is_float