vscode-common-python-lsp 0.3.0__tar.gz → 0.5.0__tar.gz

{vscode_common_python_lsp-0.3.0 → vscode_common_python_lsp-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vscode-common-python-lsp
-Version: 0.3.0
+Version: 0.5.0
 Summary: Shared Python utilities for VS Code Python tool extensions
 Author: Microsoft Corporation
 License-Expression: MIT

{vscode_common_python_lsp-0.3.0 → vscode_common_python_lsp-0.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vscode-common-python-lsp"
-version = "0.3.0"
+version = "0.5.0"
 description = "Shared Python utilities for VS Code Python tool extensions"
 readme = "README.md"
 license = "MIT"

{vscode_common_python_lsp-0.3.0 → vscode_common_python_lsp-0.5.0}/tests/test_process_runner.py

@@ -8,7 +8,12 @@ import unittest
 from dataclasses import dataclass
 from unittest.mock import MagicMock
 
-from vscode_common_python_lsp.process_runner import run_message_loop, update_sys_path
+from vscode_common_python_lsp.process_runner import (
+    resolve_bundle_path,
+    run_message_loop,
+    update_environ_path,
+    update_sys_path,
+)
 
 
 class TestUpdateSysPath(unittest.TestCase):
@@ -60,6 +65,54 @@ class TestUpdateSysPath(unittest.TestCase):
             sys.path[:] = original
 
 
+class TestUpdateEnvironPath(unittest.TestCase):
+    """Tests for update_environ_path."""
+
+    def test_adds_scripts_to_path(self):
+        import sysconfig
+
+        scripts = sysconfig.get_path("scripts")
+        if not scripts:
+            self.skipTest("sysconfig does not report scripts path")
+
+        # Remove scripts from PATH if present
+        original_env = os.environ.copy()
+        path_var = "PATH" if "PATH" in os.environ else "Path"
+        paths = os.environ.get(path_var, "").split(os.pathsep)
+        paths = [p for p in paths if p != scripts]
+        os.environ[path_var] = os.pathsep.join(paths)
+
+        try:
+            update_environ_path()
+            new_paths = os.environ[path_var].split(os.pathsep)
+            assert scripts in new_paths
+            assert new_paths[0] == scripts
+        finally:
+            os.environ.clear()
+            os.environ.update(original_env)
+
+    def test_does_not_duplicate(self):
+        import sysconfig
+
+        scripts = sysconfig.get_path("scripts")
+        if not scripts:
+            self.skipTest("sysconfig does not report scripts path")
+
+        original_env = os.environ.copy()
+        path_var = "PATH" if "PATH" in os.environ else "Path"
+        # Ensure scripts is already in PATH
+        os.environ[path_var] = scripts + os.pathsep + os.environ.get(path_var, "")
+
+        try:
+            count_before = os.environ[path_var].split(os.pathsep).count(scripts)
+            update_environ_path()
+            count_after = os.environ[path_var].split(os.pathsep).count(scripts)
+            assert count_after == count_before
+        finally:
+            os.environ.clear()
+            os.environ.update(original_env)
+
+
 @dataclass
 class _MockResult:
     """Minimal result object for testing."""
@@ -254,5 +307,81 @@ class TestRunMessageLoop(unittest.TestCase):
         assert "Unknown method: unknown_method" in sent["error"]
 
 
+class TestBootstrapSysPath(unittest.TestCase):
+    """Tests for resolve_bundle_path (and its alias bootstrap_sys_path)."""
+
+    def test_adds_tool_and_libs_dirs(self):
+        """resolve_bundle_path adds both tool/ and libs/ to sys.path."""
+        import tempfile
+
+        original = sys.path[:]
+        with tempfile.TemporaryDirectory() as tmp:
+            # Create the expected directory layout:
+            # <tmp>/tool/lsp_server.py
+            # <tmp>/libs/
+            tool_dir = os.path.join(tmp, "tool")
+            libs_dir = os.path.join(tmp, "libs")
+            os.makedirs(tool_dir)
+            os.makedirs(libs_dir)
+            script = os.path.join(tool_dir, "lsp_server.py")
+            open(script, "w").close()
+
+            try:
+                result = resolve_bundle_path(script)
+                assert result == tmp
+                assert tool_dir in sys.path
+                assert libs_dir in sys.path
+                # Both should be at the front of sys.path (before original entries)
+                assert sys.path.index(tool_dir) < len(original)
+                assert sys.path.index(libs_dir) < len(original)
+            finally:
+                sys.path[:] = original
+
+    def test_returns_bundle_dir_path(self):
+        """resolve_bundle_path returns the bundle directory."""
+        import tempfile
+
+        original = sys.path[:]
+        with tempfile.TemporaryDirectory() as tmp:
+            tool_dir = os.path.join(tmp, "tool")
+            libs_dir = os.path.join(tmp, "libs")
+            os.makedirs(tool_dir)
+            os.makedirs(libs_dir)
+            script = os.path.join(tool_dir, "lsp_server.py")
+            open(script, "w").close()
+
+            try:
+                result = resolve_bundle_path(script)
+                assert result == tmp
+            finally:
+                sys.path[:] = original
+
+    def test_respects_ls_import_strategy_env(self):
+        """When LS_IMPORT_STRATEGY=fromEnvironment, libs are appended."""
+        import tempfile
+
+        original = sys.path[:]
+        original_env = os.environ.copy()
+        with tempfile.TemporaryDirectory() as tmp:
+            tool_dir = os.path.join(tmp, "tool")
+            libs_dir = os.path.join(tmp, "libs")
+            os.makedirs(tool_dir)
+            os.makedirs(libs_dir)
+            script = os.path.join(tool_dir, "lsp_server.py")
+            open(script, "w").close()
+
+            os.environ["LS_IMPORT_STRATEGY"] = "fromEnvironment"
+            try:
+                len_before = len(sys.path)
+                resolve_bundle_path(script)
+                assert libs_dir in sys.path
+                # libs should be appended after existing entries
+                assert sys.path.index(libs_dir) >= len_before
+            finally:
+                sys.path[:] = original
+                os.environ.clear()
+                os.environ.update(original_env)
+
+
 if __name__ == "__main__":
     unittest.main()

{vscode_common_python_lsp-0.3.0 → vscode_common_python_lsp-0.5.0}/vscode_common_python_lsp/__init__.py

@@ -59,7 +59,12 @@ from .paths import (
     normalize_path,
     reset_caches,
 )
-from .process_runner import run_message_loop, update_sys_path
+from .process_runner import (
+    resolve_bundle_path,
+    run_message_loop,
+    update_environ_path,
+    update_sys_path,
+)
 from .runner import CustomIO, RunResult, run_api, run_module, run_path
 from .server import ToolServer, ToolServerConfig
 from .version import VersionInfo, check_min_version, extract_version, version_to_tuple
@@ -98,6 +103,8 @@ __all__ = [
     "shutdown_json_rpc",
     # process_runner
     "update_sys_path",
+    "update_environ_path",
+    "resolve_bundle_path",
     "run_message_loop",
     # debug
     "setup_debugpy",

{vscode_common_python_lsp-0.3.0 → vscode_common_python_lsp-0.5.0}/vscode_common_python_lsp/process_runner.py

@@ -5,7 +5,9 @@
 from __future__ import annotations
 
 import os
+import pathlib
 import sys
+import sysconfig
 import traceback
 from collections.abc import Callable
 from typing import TYPE_CHECKING
@@ -34,6 +36,69 @@ def update_sys_path(path_to_add: str, strategy: str) -> None:
             sys.path.append(path_to_add)
 
 
+def resolve_bundle_path(script_file: str) -> str:
+    """Resolve the bundle directory and configure ``sys.path`` for a bundled LSP server.
+
+    Call this at the top of your ``lsp_server.py`` (before importing
+    any bundled libraries) to replace the standard 7-line boilerplate::
+
+        # Instead of:
+        BUNDLE_DIR = pathlib.Path(__file__).parent.parent
+        update_sys_path(os.fspath(BUNDLE_DIR / "tool"), "useBundled")
+        update_sys_path(
+            os.fspath(BUNDLE_DIR / "libs"),
+            os.getenv("LS_IMPORT_STRATEGY", "useBundled"),
+        )
+
+        # Use:
+        from vscode_common_python_lsp import resolve_bundle_path
+        BUNDLE_DIR = resolve_bundle_path(__file__)
+
+    Parameters
+    ----------
+    script_file:
+        The ``__file__`` of the calling script (expected to be at
+        ``<bundle>/tool/lsp_server.py``).
+
+    Returns
+    -------
+    str
+        The resolved bundle directory path (``<extension>/bundled/``),
+        for any further use by the caller.
+    """
+    bundle_dir = pathlib.Path(script_file).parent.parent
+    bundle_str = os.fspath(bundle_dir)
+
+    # Always put the tool directory first (bundled server modules)
+    update_sys_path(os.fspath(bundle_dir / "tool"), "useBundled")
+
+    # Libs follow the LS_IMPORT_STRATEGY env var
+    update_sys_path(
+        os.fspath(bundle_dir / "libs"),
+        os.getenv("LS_IMPORT_STRATEGY", "useBundled"),
+    )
+
+    return bundle_str
+
+
+def update_environ_path() -> None:
+    """Update PATH environment variable with the ``scripts`` directory.
+
+    Ensures tool executables installed in the virtual environment's scripts
+    directory (``Scripts`` on Windows, ``bin`` on Unix) are discoverable.
+    """
+    scripts = sysconfig.get_path("scripts")
+    if not scripts:
+        return
+    for var_name in ("Path", "PATH"):
+        if var_name in os.environ:
+            paths = os.environ[var_name].split(os.pathsep)
+            if scripts not in paths:
+                paths.insert(0, scripts)
+                os.environ[var_name] = os.pathsep.join(paths)
+            break
+
+
 def run_message_loop(
     rpc: JsonRpc,
     run_fn: Callable[..., object],

{vscode_common_python_lsp-0.3.0 → vscode_common_python_lsp-0.5.0}/vscode_common_python_lsp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vscode-common-python-lsp
-Version: 0.3.0
+Version: 0.5.0
 Summary: Shared Python utilities for VS Code Python tool extensions
 Author: Microsoft Corporation
 License-Expression: MIT