refactor

added some comments and moved to scripts/reset_db.py
OpenAdaptAI · Jun 1, 2023 · b728c98 · b728c98
1 parent f6fba8a
commit b728c98
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/openadapt/scripts/__init__.py b/openadapt/scripts/__init__.py
diff --git a/openadapt/renew.py → openadapt/scripts/reset_db.py b/openadapt/renew.py → openadapt/scripts/reset_db.py
@@ -3,10 +3,16 @@
 from openadapt.config import getenv_fallback
 
 
-def clear_db():
+def reset_db():
+    """
+    The function clears the database by removing the database file and running a
+    database migration using Alembic.
+    """
     db = getenv_fallback("DB_FNAME")
     if os.path.exists(db):
         os.remove(db)
+
+    # Prevents duplicate logging of config values by piping stderr and filtering the output.
     result = run(["alembic", "upgrade", "head"], stderr=PIPE, text=True)
     print(result.stderr[result.stderr.find("INFO  [alembic") :])
     if result.returncode != 0:
@@ -16,4 +22,4 @@ def clear_db():
 
 
 if __name__ == "__main__":
-    clear_db()
+    reset_db()