Add run_with_env.py script to load environment variables and execute commands (e.g. VSCode tasks)

Author: PierreRaybaut

.vscode/tasks.json

@@ -7,6 +7,8 @@
             "label": "🧽 Ruff Formatter",
             "command": "${command:python.interpreterPath}",
             "args": [
+                "scripts/run_with_env.py",
+                "${command:python.interpreterPath}",
                 "-m",
                 "ruff",
                 "format"
@@ -32,6 +34,8 @@
             "label": "🔦 Ruff Linter",
             "command": "${command:python.interpreterPath}",
             "args": [
+                "scripts/run_with_env.py",
+                "${command:python.interpreterPath}",
                 "-m",
                 "ruff",
                 "check",
@@ -58,6 +62,8 @@
             "label": "🔦 Pylint",
             "command": "${command:python.interpreterPath}",
             "args": [
+                "scripts/run_with_env.py",
+                "${command:python.interpreterPath}",
                 "-m",
                 "pylint",
                 "plotpy",
@@ -92,6 +98,8 @@
             "label": "🔎 Scan translations",
             "command": "${command:python.interpreterPath}",
             "args": [
+                "scripts/run_with_env.py",
+                "${command:python.interpreterPath}",
                 "-m",
                 "guidata.utils.translations",
                 "scan",
@@ -123,6 +131,8 @@
             "label": "📚 Compile translations",
             "command": "${command:python.interpreterPath}",
             "args": [
+                "scripts/run_with_env.py",
+                "${command:python.interpreterPath}",
                 "-m",
                 "guidata.utils.translations",
                 "compile",
@@ -152,6 +162,8 @@
             "label": "🚀 Pytest",
             "command": "${command:python.interpreterPath}",
             "args": [
+                "scripts/run_with_env.py",
+                "${command:python.interpreterPath}",
                 "-m",
                 "pytest",
                 "--ff",
@@ -180,6 +192,8 @@
             "label": "Generate requirements",
             "command": "${command:python.interpreterPath}",
             "args": [
+                "scripts/run_with_env.py",
+                "${command:python.interpreterPath}",
                 "-m",
                 "guidata.utils.genreqs",
                 "all",
@@ -260,6 +274,8 @@
             "type": "shell",
             "command": "${command:python.interpreterPath}",
             "args": [
+                "scripts/run_with_env.py",
+                "${command:python.interpreterPath}",
                 "-m",
                 "pip",
                 "install",
@@ -295,6 +311,8 @@
             "label": "📚 Build documentation",
             "command": "${command:python.interpreterPath}",
             "args": [
+                "scripts/run_with_env.py",
+                "${command:python.interpreterPath}",
                 "-m",
                 "sphinx",
                 "build",
@@ -347,6 +365,8 @@
             "type": "shell",
             "command": "${command:python.interpreterPath}",
             "args": [
+                "scripts/run_with_env.py",
+                "${command:python.interpreterPath}",
                 "-m",
                 "guidata.utils.securebuild",
             ],
@@ -441,6 +461,8 @@
             "type": "shell",
             "command": "${command:python.interpreterPath}",
             "args": [
+                "scripts/run_with_env.py",
+                "${command:python.interpreterPath}",
                 "-m",
                 "coverage",
                 "run",

scripts/run_with_env.py

@@ -0,0 +1,52 @@
+# Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file.
+
+"""Run a command with environment variables loaded from a .env file."""
+
+from __future__ import annotations
+
+import os
+import subprocess
+import sys
+from pathlib import Path
+
+
+def load_env_file(env_path: str | None = None) -> None:
+    """Load environment variables from a .env file."""
+    if env_path is None:
+        # Get ".eenv" file from the current directory
+        env_path = Path.cwd() / ".env"
+    if not Path(env_path).is_file():
+        raise FileNotFoundError(f"Environment file not found: {env_path}")
+    print(f"Loading environment variables from: {env_path}")
+    with open(env_path, encoding="utf-8") as f:
+        for line in f:
+            line = line.strip()
+            if not line or line.startswith("#") or "=" not in line:
+                continue
+            key, value = line.split("=", 1)
+            os.environ[key.strip()] = value.strip()
+            print(f"  Loaded variable: {key.strip()}={value.strip()}")
+
+
+def execute_command(command: list[str]) -> int:
+    """Execute a command with the loaded environment variables."""
+    print("Executing command:")
+    print(" ".join(command))
+    print("")
+    result = subprocess.call(command)
+    print(f"Process exited with code {result}")
+    return result
+
+
+def main() -> None:
+    """Main function to load environment variables and execute a command."""
+    if len(sys.argv) < 2:
+        print("Usage: python run_with_env.py <command> [args ...]")
+        sys.exit(1)
+    print("🏃 Running with environment variables")
+    load_env_file()
+    return execute_command(sys.argv[1:])
+
+
+if __name__ == "__main__":
+    main()