Modify VS Code settings for efficiency

Author: simonkurtz-MSFT

.vscode/settings.json

@@ -8,7 +8,41 @@
         "./.venv/Scripts/python.exe"
     ],
     "jupyter.kernels.excludePythonEnvironments": [
-        "apim-samples"
+        "**/anaconda3/**",
+        "**/conda/**",
+        "**/miniconda3/**",
+        "**/python3.*",
+        "*/site-packages/*",
+        "/bin/python",
+        "/bin/python3",
+        "/opt/python/*/bin/python*",
+        "/usr/bin/python",
+        "/usr/bin/python3",
+        "/usr/local/bin/python",
+        "/usr/local/bin/python3",
+        "python",
+        "python3",
+        "**/.venv/**/python*",
+        "**/Scripts/python*",
+        "**/bin/python*"
+    ],
+    "search.exclude": {
+        "**/.venv": true,
+        "**/.venv/**": true
+    },
+    "files.watcherExclude": {
+        "**/.venv/**": true
+    },
+    "files.exclude": {
+        "**/.venv": true
+    },
+    "python.analysis.exclude": [
+        "**/node_modules",
+        "**/__pycache__",
+        ".git",
+        "**/build",
+        "env/**",
+        "**/.venv/**"
     ],
     "files.trimTrailingWhitespace": true,
     "files.insertFinalNewline": true,
@@ -32,5 +66,11 @@
     "plantuml.exportFormat": "svg",
     "plantuml.java": "C:\\Program Files\\OpenJDK\\jdk-22.0.2\\bin\\java.exe",
     "plantuml.diagramsRoot": "assets/diagrams/src",
-    "plantuml.exportOutDir": "assets/diagrams/out"
-}
+    "plantuml.exportOutDir": "assets/diagrams/out",
+    "jupyter.kernels.filter": [
+        {
+            "path": "apim-samples",
+            "type": "pythonEnvironment"
+        }
+    ]
+}

setup/setup_python_path.py

@@ -21,6 +21,75 @@
 from pathlib import Path  # Cross-platform path handling (Windows: \, Unix: /)
 
 
+DEFAULT_VSCODE_SEARCH_EXCLUDE = {
+    "**/.venv": True,
+    "**/.venv/**": True,
+}
+
+DEFAULT_VSCODE_FILES_WATCHER_EXCLUDE = {
+    "**/.venv/**": True,
+}
+
+DEFAULT_VSCODE_FILES_EXCLUDE = {
+    "**/.venv": True,
+}
+
+DEFAULT_PYTHON_ANALYSIS_EXCLUDE = [
+    "**/node_modules",
+    "**/__pycache__",
+    ".git",
+    "**/build",
+    "env/**",
+    "**/.venv/**",
+]
+
+
+def _merge_bool_map(existing: object, required: dict[str, bool]) -> dict[str, bool]:
+    """Merge boolean map settings while enforcing required keys.
+
+    For VS Code exclude maps, required keys are forced to True.
+    """
+
+    if isinstance(existing, dict):
+        merged: dict[str, bool] = {str(k): bool(v) for k, v in existing.items()}
+    else:
+        merged = {}
+
+    for key in required:
+        merged[key] = True
+
+    return merged
+
+
+def _normalize_string_list(value: object) -> list[str]:
+    if value is None:
+        return []
+    if isinstance(value, list):
+        return [str(item) for item in value if str(item).strip()]
+    if isinstance(value, str) and value.strip():
+        return [value]
+    return []
+
+
+def _merge_string_list(existing: object, required: list[str]) -> list[str]:
+    """Merge lists while preserving order and avoiding duplicates.
+
+    Required items come first, followed by any existing items.
+    """
+
+    existing_list = _normalize_string_list(existing)
+    merged: list[str] = []
+
+    for item in required:
+        if item not in merged:
+            merged.append(item)
+    for item in existing_list:
+        if item not in merged:
+            merged.append(item)
+
+    return merged
+
+
 def get_project_root() -> Path:
     """
     Get the absolute path to the project root directory.
@@ -183,6 +252,8 @@ def create_vscode_settings():
     vscode_dir.mkdir(exist_ok=True)
 
     # Settings to update for kernel and Python configuration
+    # Note: exclude settings (search/files watcher/Pylance) are merged separately
+    # to avoid clobbering any user customizations.
     required_settings = {
         "files.trimTrailingWhitespace": True,
         "files.insertFinalNewline": True,
@@ -246,6 +317,24 @@ def create_vscode_settings():
             # Merge required settings with existing ones
             existing_settings.update(required_settings)
 
+            # Merge performance excludes without overwriting other patterns
+            existing_settings["search.exclude"] = _merge_bool_map(
+                existing_settings.get("search.exclude"),
+                DEFAULT_VSCODE_SEARCH_EXCLUDE,
+            )
+            existing_settings["files.watcherExclude"] = _merge_bool_map(
+                existing_settings.get("files.watcherExclude"),
+                DEFAULT_VSCODE_FILES_WATCHER_EXCLUDE,
+            )
+            existing_settings["files.exclude"] = _merge_bool_map(
+                existing_settings.get("files.exclude"),
+                DEFAULT_VSCODE_FILES_EXCLUDE,
+            )
+            existing_settings["python.analysis.exclude"] = _merge_string_list(
+                existing_settings.get("python.analysis.exclude"),
+                DEFAULT_PYTHON_ANALYSIS_EXCLUDE,
+            )
+
             # Write back the merged settings
             with open(settings_file, 'w', encoding='utf-8') as f:
                 json.dump(existing_settings, f, indent=4)
@@ -254,6 +343,7 @@ def create_vscode_settings():
             print("   - Existing settings preserved")
             print("   - Default kernel set to 'apim-samples'")
             print("   - Python interpreter configured for .venv")
+            print("   - .venv excluded from search/watcher/Pylance indexing")
 
         except (json.JSONDecodeError, IOError):
             print("⚠️  Existing settings.json has comments or formatting issues")
@@ -265,12 +355,18 @@ def create_vscode_settings():
     else:
         # Create new settings file
         try:
+            required_settings["search.exclude"] = DEFAULT_VSCODE_SEARCH_EXCLUDE
+            required_settings["files.watcherExclude"] = DEFAULT_VSCODE_FILES_WATCHER_EXCLUDE
+            required_settings["files.exclude"] = DEFAULT_VSCODE_FILES_EXCLUDE
+            required_settings["python.analysis.exclude"] = DEFAULT_PYTHON_ANALYSIS_EXCLUDE
+
             with open(settings_file, 'w', encoding='utf-8') as f:
                 json.dump(required_settings, f, indent=4)
 
             print(f"✅ VS Code settings created: {settings_file}")
             print("   - Default kernel set to 'apim-samples'")
             print("   - Python interpreter configured for .venv")
+            print("   - .venv excluded from search/watcher/Pylance indexing")
         except (ImportError, IOError) as e:
             print(f"❌ Failed to create VS Code settings: {e}")
             return False
@@ -365,6 +461,13 @@ def force_kernel_consistency():
         ]
     }
 
+    performance_exclude_settings = {
+        "search.exclude": DEFAULT_VSCODE_SEARCH_EXCLUDE,
+        "files.watcherExclude": DEFAULT_VSCODE_FILES_WATCHER_EXCLUDE,
+        "files.exclude": DEFAULT_VSCODE_FILES_EXCLUDE,
+        "python.analysis.exclude": DEFAULT_PYTHON_ANALYSIS_EXCLUDE,
+    }
+
     try:
         # Read existing settings or create new ones
         existing_settings = {}
@@ -378,6 +481,24 @@ def force_kernel_consistency():
         # Merge settings, with our strict kernel settings taking priority
         existing_settings.update(strict_kernel_settings)
 
+        # Merge performance excludes without clobbering user patterns
+        existing_settings["search.exclude"] = _merge_bool_map(
+            existing_settings.get("search.exclude"),
+            performance_exclude_settings["search.exclude"],
+        )
+        existing_settings["files.watcherExclude"] = _merge_bool_map(
+            existing_settings.get("files.watcherExclude"),
+            performance_exclude_settings["files.watcherExclude"],
+        )
+        existing_settings["files.exclude"] = _merge_bool_map(
+            existing_settings.get("files.exclude"),
+            performance_exclude_settings["files.exclude"],
+        )
+        existing_settings["python.analysis.exclude"] = _merge_string_list(
+            existing_settings.get("python.analysis.exclude"),
+            performance_exclude_settings["python.analysis.exclude"],
+        )
+
         # Write updated settings
         with open(settings_file, 'w', encoding='utf-8') as f:
             json.dump(existing_settings, f, indent=4)

tests/python/test_setup_python_path_settings.py

@@ -0,0 +1,115 @@
+"""Unit tests for setup_python_path VS Code settings generation."""
+
+from __future__ import annotations
+
+import importlib
+import json
+import sys
+from pathlib import Path
+from types import ModuleType
+from typing import TYPE_CHECKING, cast
+
+import pytest
+
+# Ensure the setup folder is on sys.path so the setup script is importable.
+PROJECT_ROOT = Path(__file__).resolve().parents[2]
+SETUP_PATH = PROJECT_ROOT / "setup"
+if str(SETUP_PATH) not in sys.path:
+    sys.path.insert(0, str(SETUP_PATH))
+
+if TYPE_CHECKING:  # pragma: no cover
+    sps = cast(ModuleType, None)
+else:
+    sps = cast(ModuleType, importlib.import_module("setup_python_path"))
+
+
+@pytest.fixture
+def temp_project_root(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> Path:
+    """Create a temp project root and force setup script to use it."""
+
+    # The script expects these indicator files to exist at project root.
+    (tmp_path / "README.md").write_text("x", encoding="utf-8")
+    (tmp_path / "requirements.txt").write_text("x", encoding="utf-8")
+    (tmp_path / "bicepconfig.json").write_text("{}", encoding="utf-8")
+
+    monkeypatch.setattr(sps, "get_project_root", lambda: tmp_path)
+    return tmp_path
+
+
+def _read_settings(project_root: Path) -> dict:
+    settings_path = project_root / ".vscode" / "settings.json"
+    return json.loads(settings_path.read_text(encoding="utf-8"))
+
+
+def test_create_vscode_settings_creates_perf_excludes(temp_project_root: Path) -> None:
+    assert sps.create_vscode_settings() is True
+
+    settings = _read_settings(temp_project_root)
+
+    assert settings["search.exclude"]["**/.venv"] is True
+    assert settings["search.exclude"]["**/.venv/**"] is True
+    assert settings["files.watcherExclude"]["**/.venv/**"] is True
+    assert settings["files.exclude"]["**/.venv"] is True
+
+    assert settings["python.analysis.exclude"][: len(sps.DEFAULT_PYTHON_ANALYSIS_EXCLUDE)] == sps.DEFAULT_PYTHON_ANALYSIS_EXCLUDE
+
+
+def test_create_vscode_settings_merges_excludes(temp_project_root: Path) -> None:
+    vscode_dir = temp_project_root / ".vscode"
+    vscode_dir.mkdir(parents=True)
+
+    (vscode_dir / "settings.json").write_text(
+        json.dumps(
+            {
+                "search.exclude": {"custom/**": True, "**/.venv": False},
+                "python.analysis.exclude": ["custom2/**", "**/__pycache__"],
+            },
+            indent=4,
+        ),
+        encoding="utf-8",
+    )
+
+    assert sps.create_vscode_settings() is True
+
+    settings = _read_settings(temp_project_root)
+
+    # Required keys forced on, custom preserved
+    assert settings["search.exclude"]["custom/**"] is True
+    assert settings["search.exclude"]["**/.venv"] is True
+    assert settings["search.exclude"]["**/.venv/**"] is True
+
+    # Required patterns come first, custom patterns preserved afterwards
+    assert settings["python.analysis.exclude"][: len(sps.DEFAULT_PYTHON_ANALYSIS_EXCLUDE)] == sps.DEFAULT_PYTHON_ANALYSIS_EXCLUDE
+    assert "custom2/**" in settings["python.analysis.exclude"]
+
+
+def test_force_kernel_consistency_merges_excludes(temp_project_root: Path, monkeypatch: pytest.MonkeyPatch) -> None:
+    vscode_dir = temp_project_root / ".vscode"
+    vscode_dir.mkdir(parents=True)
+
+    (vscode_dir / "settings.json").write_text(
+        json.dumps(
+            {
+                "search.exclude": {"**/.venv/**": False},
+                "files.watcherExclude": {"other/**": True},
+                "python.analysis.exclude": ["custom3/**"],
+            },
+            indent=4,
+        ),
+        encoding="utf-8",
+    )
+
+    # Avoid calling jupyter/kernelspec subprocesses in tests.
+    monkeypatch.setattr(sps, "validate_kernel_setup", lambda: True)
+
+    assert sps.force_kernel_consistency() is True
+
+    settings = _read_settings(temp_project_root)
+
+    assert settings["search.exclude"]["**/.venv"] is True
+    assert settings["search.exclude"]["**/.venv/**"] is True
+    assert settings["files.watcherExclude"]["**/.venv/**"] is True
+    assert settings["files.watcherExclude"]["other/**"] is True
+
+    assert settings["python.analysis.exclude"][: len(sps.DEFAULT_PYTHON_ANALYSIS_EXCLUDE)] == sps.DEFAULT_PYTHON_ANALYSIS_EXCLUDE
+    assert "custom3/**" in settings["python.analysis.exclude"]