Merge pull request #2367 from makermelissa/main

Updated Web Workflow utility script env.py to use settings.toml instead of .env files

Author: dhalbert

Web_Workflow_Quickstart/env.py

@@ -6,79 +6,87 @@
 import storage
 import microcontroller
 
-# Get all files in the format of .env.xxxxxxxxxx
-def enumerate_env_files():
+SETTINGS_FOLDER = "/"
+
+# Get all files in the format of xxxxxxxxxx.toml except settings.toml
+def enumerate_toml_files():
     found_files = []
-    all_files = os.listdir("/")
+    all_files = os.listdir(SETTINGS_FOLDER)
     for current_file in all_files:
-        if current_file[:4] == ".env" and len(current_file) > 4:
-            found_files.append(current_file)
+        if (
+            not current_file.startswith("._")
+            and current_file.endswith(".toml")
+            and current_file != "settings.toml"
+        ):
+            found_files.append(SETTINGS_FOLDER + current_file)
     return found_files
 
 
-# Compare .env to enumerated env files
-def get_current_env_file(enumerated_files):
-    with open(".env") as env:
-        env_lines = env.readlines()
-        for env_file in enumerated_files:
-            with open(env_file) as f:
+# Compare settings.toml to enumerated toml files
+def get_current_toml_file(enumerated_files):
+    with open("settings.toml") as settings:
+        settings_lines = settings.readlines()
+        for toml_file in enumerated_files:
+            with open(toml_file) as f:
                 lines = f.readlines()
-                if len(env_lines) != len(lines):
+                if len(settings_lines) != len(lines):
                     continue
                 file_may_match = True
-                for line_no, env_line in enumerate(env_lines):
-                    if env_line != lines[line_no]:
+                for line_no, settings_line in enumerate(settings_lines):
+                    if settings_line != lines[line_no]:
                         file_may_match = False
                         break
                 if not file_may_match:
                     continue
-                return env_file
+                return toml_file
     return None
 
 
-# Erase .env then write the contents of the new env file
-def change_env_file(env_file):
+# Erase settings.toml then write the contents of the new settings.toml file
+def change_toml_file(toml_file):
     try:
         storage.remount("/", False)
-        open(".env", "w").close()
-        with open(".env", "w") as env, open(env_file) as f:
+        with open("settings.toml", "w") as settings:
+            settings.write("")
+        with open("settings.toml", "w") as settings, open(toml_file) as f:
             for line in f.readlines():
-                env.write(line)
-        env.close()
+                settings.write(line)
         print("Done. Hard resetting board...")
         microcontroller.reset()
     except RuntimeError:
         print("You can't change the env file with this script while USB is mounted")
 
 
-# Return a prettier name than the env file
-def pretty_name(env_file):
-    name = env_file[5:]
+# Return a prettier name than the toml filename
+def pretty_name(toml_file):
+    name = toml_file.rsplit("/", 1)[1]
+    name = name[:-5]
     name = name[0].upper() + name[1:]
-    return f"{name} .env file"
+    return f"{name} toml file"
+
 
-env_files = enumerate_env_files()
+toml_files = enumerate_toml_files()
 
-if len(env_files) < 2:
-    print("You need to have at least 2 env files to change")
+if len(toml_files) < 2:
+    print("You need to have at least 2 .toml files to change")
 
-result = get_current_env_file(env_files)
+result = get_current_toml_file(toml_files)
 if result:
-    env_files.remove(result)
-print("WARNING: This will overwrite all of your current .env file settings.")
-if len(env_files) == 1:
-    answer = input(f"Change to {pretty_name(env_files[0])}? ")
+    toml_files.remove(result)
+print("WARNING: This will overwrite all of your current settings.toml file settings.")
+if len(toml_files) == 1:
+    answer = input(f"Change to {pretty_name(toml_files[0])}? ")
     answer = answer.lower()
     if answer in ("y", "yes"):
-        change_env_file(env_files[0])
+        change_toml_file(toml_files[0])
 else:
     valid_selection = False
     while not valid_selection:
         print("Select an option:")
-        for index, file in enumerate(env_files):
+        for index, file in enumerate(toml_files):
             print(f"{index + 1}: {pretty_name(file)}")
         answer = input("Which option would you like? ")
-        if answer.isdigit() and 0 < int(answer) <= len(env_files):
+        if answer.isdigit() and 0 < int(answer) <= len(toml_files):
             valid_selection = True
-            change_env_file(env_files[int(answer) - 1])
+            change_toml_file(toml_files[int(answer) - 1])
         print(f"{answer} was an invalid selection.\n")