improvements to check validity of config file

Checks have been added to verify file name lenght and to check if it's really a .yaml file.

All tests are now green.

Fixed error

Moved the syspath cariable to be globally available

Fix error

path variable was named wrong

Try to fix github action error

Changed file name for config file.

Fixed Test

Fixed copyfile for test case

Check if config is valid

load_config now gives correct error messages and does not catch any exceptions.

The functions are now also properly seperated.

removed print statements

Print statements have been removed and replaced them with RuntimeErrors where applicable.

which_path was renamed to default_config_path.

Improved code

I merged the two isInstance calls to improve readability.

Author: Jonathan Lutterbeck

examples/configloader.py

@@ -1,12 +1,17 @@
 import shutil
 import sys
 import os.path
+import pathlib
 import yaml
 
-#TODO: change active project
-project = "somthing-else"
 
-def which_path():
+def default_config_path():
+    """
+
+    this checks the operation system of the user.
+    this is used to determine the standard save location for the global gridscale config file.
+
+    """
     #check if os is linux
     if(sys.platform in ("linux", "linux2")):
         path = "~/.config/gridscale"
@@ -26,27 +31,32 @@ def which_path():
         if not os.path.exists(path):
             os.makedirs(path)
     else:
-        print("Operating System not supported")
+        raise RuntimeError("Operating system not supported")
 
     return path
 
-def create_config(path):
-    cwd = os.getcwd()
-    shutil.copyfile(f"{cwd}/config.yaml", syspath)
-    print(f"New config file created, edit config file at: {syspath}")
 
-def load_config(path):
-    syspath = which_path() + "/config.yaml"
+def create_config(path):
+    """
+    this will copy the currently used config file in the standard folder
+    """
+    syspath = default_config_path() + "/config.yaml"
+    shutil.copyfile(path, syspath)
 
-    if not os.path.exists(syspath):
-        create_config(syspath)
 
-    with open(f"{syspath}", 'r') as stream:
-        try:
+def load_config(path):
+    """
+    First checking "path" to match minimum length and other requirements.
+
+    Then it opens the specified config file and returns all keys which include token and UserId.
+    """
+    # opens specified file to retrieve config tokens
+    if isinstance(path, (pathlib.Path, str)):
+        assert path
+        with open(f"{path}", 'r') as stream:
             data = yaml.safe_load(stream)
-            #return list of dictionaries for all projects
+            # return list of dictionaries for all projects
             for value in data.values():
-                return(value)
-
-        except yaml.YAMLError as exc:
-            print(exc)
+                return (value)
+    else:
+        raise AssertionError

examples/examples.py

@@ -10,8 +10,6 @@
 from gs_api_client import Configuration
 
 
-CURRENT_DIR = os.path.dirname(os.path.realpath(__file__))
-
 if __name__ == '__main__':
 
     # run `pip3 install index_by` before executing this file
@@ -20,9 +18,8 @@
     # api_config.debug = True
     api_config.host = 'https://api.gridscale.io'
 
-    #TODO: Change project
-    example_config = os.path.join(CURRENT_DIR, "config.yaml")
-    configfile = load_config(example_config)
+    #TODO: Change filename
+    configfile = load_config("config.yaml")
     api_config.api_key['X-Auth-Token'] = configfile[0].get("token")
     api_config.api_key['X-Auth-UserId'] = configfile[0].get("userId")
     api_config.debug = True