vscode-common-python-lsp 0.2.1__tar.gz → 0.4.0__tar.gz

{vscode_common_python_lsp-0.2.1 → vscode_common_python_lsp-0.4.0}/PKG-INFO

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

{vscode_common_python_lsp-0.2.1 → vscode_common_python_lsp-0.4.0}/pyproject.toml

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

{vscode_common_python_lsp-0.2.1 → vscode_common_python_lsp-0.4.0}/tests/test_process_runner.py

@@ -8,7 +8,11 @@ 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 (
+    run_message_loop,
+    update_environ_path,
+    update_sys_path,
+)
 
 
 class TestUpdateSysPath(unittest.TestCase):
@@ -60,6 +64,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."""

{vscode_common_python_lsp-0.2.1 → vscode_common_python_lsp-0.4.0}/tests/test_server.py

@@ -51,6 +51,7 @@ class TestToolServerConfig:
         assert cfg.tool_args == []
         assert cfg.min_version == ""
         assert cfg.runner_script == ""
+        assert cfg.resolve_symlinks is False
         assert cfg.default_notification_level == "off"
         assert cfg.default_settings == {}
 
@@ -330,6 +331,77 @@ class TestGetDocumentKey:
         assert ts.get_document_key(doc) is None
 
 
+class TestResolveSymlinks:
+    """Tests for the resolve_symlinks config propagation to normalize_path."""
+
+    def test_default_config_has_resolve_symlinks_false(self):
+        cfg = ToolServerConfig(tool_module="mod", tool_display="Mod")
+        assert cfg.resolve_symlinks is False
+
+    @patch("vscode_common_python_lsp.server.normalize_path")
+    @patch("vscode_common_python_lsp.server.uris")
+    def test_update_workspace_settings_passes_resolve_symlinks_false(
+        self, mock_uris, mock_normalize
+    ):
+        mock_uris.from_fs_path.return_value = "file:///cwd"
+        mock_normalize.return_value = "/normalized/cwd"
+        ts = _make_server()
+        ts.update_workspace_settings(None)
+        mock_normalize.assert_called_with(os.getcwd(), resolve_symlinks=False)
+
+    @patch("vscode_common_python_lsp.server.normalize_path")
+    @patch("vscode_common_python_lsp.server.uris")
+    def test_update_workspace_settings_passes_resolve_symlinks_true(
+        self, mock_uris, mock_normalize
+    ):
+        mock_uris.from_fs_path.return_value = "file:///cwd"
+        mock_normalize.return_value = "/normalized/cwd"
+        cfg = ToolServerConfig(
+            tool_module="mod", tool_display="Mod", resolve_symlinks=True
+        )
+        ts = _make_server(cfg)
+        ts.update_workspace_settings(None)
+        mock_normalize.assert_called_with(os.getcwd(), resolve_symlinks=True)
+
+    @patch("vscode_common_python_lsp.server.normalize_path")
+    @patch("vscode_common_python_lsp.server.uris")
+    def test_update_workspace_settings_list_passes_resolve_symlinks(
+        self, mock_uris, mock_normalize
+    ):
+        mock_uris.to_fs_path.side_effect = lambda u: u.replace("file://", "")
+        mock_normalize.return_value = "/ws1"
+        ts = _make_server()
+        ts.update_workspace_settings([{"workspace": "file:///ws1"}])
+        mock_normalize.assert_called_with("/ws1", resolve_symlinks=False)
+
+    @patch("vscode_common_python_lsp.server.normalize_path")
+    @patch("vscode_common_python_lsp.server.uris")
+    def test_get_settings_by_document_passes_resolve_symlinks(
+        self, mock_uris, mock_normalize
+    ):
+        mock_uris.from_fs_path.return_value = "file:///parent"
+        mock_normalize.return_value = "/parent"
+        ts = _make_server()
+        doc = _make_document("/parent/file.py")
+        # No workspace settings, document outside all → fallback path
+        ts.get_settings_by_document(doc)
+        mock_normalize.assert_called_with(
+            str(pathlib.Path("/parent/file.py").parent),
+            resolve_symlinks=False,
+        )
+
+    @patch("vscode_common_python_lsp.server.normalize_path")
+    @patch("vscode_common_python_lsp.server.uris")
+    def test_get_settings_by_path_empty_passes_resolve_symlinks(
+        self, mock_uris, mock_normalize
+    ):
+        mock_uris.from_fs_path.return_value = "file:///cwd"
+        mock_normalize.return_value = "/normalized/cwd"
+        ts = _make_server()
+        ts.get_settings_by_path(pathlib.Path("/some/file.py"))
+        mock_normalize.assert_called_with(os.getcwd(), resolve_symlinks=False)
+
+
 # ---------------------------------------------------------------------------
 # CWD resolution
 # ---------------------------------------------------------------------------

{vscode_common_python_lsp-0.2.1 → vscode_common_python_lsp-0.4.0}/vscode_common_python_lsp/__init__.py

@@ -59,7 +59,7 @@ from .paths import (
     normalize_path,
     reset_caches,
 )
-from .process_runner import run_message_loop, update_sys_path
+from .process_runner import 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 +98,7 @@ __all__ = [
     "shutdown_json_rpc",
     # process_runner
     "update_sys_path",
+    "update_environ_path",
     "run_message_loop",
     # debug
     "setup_debugpy",

{vscode_common_python_lsp-0.2.1 → vscode_common_python_lsp-0.4.0}/vscode_common_python_lsp/process_runner.py

@@ -6,6 +6,7 @@ from __future__ import annotations
 
 import os
 import sys
+import sysconfig
 import traceback
 from collections.abc import Callable
 from typing import TYPE_CHECKING
@@ -34,6 +35,24 @@ def update_sys_path(path_to_add: str, strategy: str) -> None:
             sys.path.append(path_to_add)
 
 
+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.2.1 → vscode_common_python_lsp-0.4.0}/vscode_common_python_lsp/server.py

@@ -45,6 +45,10 @@ class ToolServerConfig:
         Minimum supported version string.
     runner_script:
         Path to the bundled JSON-RPC runner script.
+    resolve_symlinks:
+        Whether to resolve symlinks when normalizing workspace paths.
+        All current extension repos use ``False`` to keep workspace
+        keys relative to the (possibly symlinked) workspace root.
     default_notification_level:
         Default value for the ``showNotifications`` setting.
     default_settings:
@@ -58,6 +62,7 @@ class ToolServerConfig:
     tool_args: list[str] = field(default_factory=list)
     min_version: str = ""
     runner_script: str = ""
+    resolve_symlinks: bool = False
     default_notification_level: Literal["off", "onError", "onWarning", "always"] = "off"
     default_settings: dict[str, Any] = field(default_factory=dict)
 
@@ -122,7 +127,9 @@ class ToolServer:
     def update_workspace_settings(self, settings: list[dict[str, Any]] | None) -> None:
         """Populate :attr:`workspace_settings` from the client payload."""
         if not settings:
-            key = normalize_path(os.getcwd())
+            key = normalize_path(
+                os.getcwd(), resolve_symlinks=self.config.resolve_symlinks
+            )
             self.workspace_settings[key] = {
                 "cwd": key,
                 "workspaceFS": key,
@@ -132,7 +139,10 @@ class ToolServer:
             return
 
         for setting in settings:
-            key = normalize_path(uris.to_fs_path(setting["workspace"]))
+            key = normalize_path(
+                uris.to_fs_path(setting["workspace"]),
+                resolve_symlinks=self.config.resolve_symlinks,
+            )
             self.workspace_settings[key] = {
                 **self.get_global_defaults(),
                 **setting,
@@ -142,7 +152,9 @@ class ToolServer:
     def get_settings_by_path(self, file_path: pathlib.Path) -> dict[str, Any]:
         """Return workspace settings for the given file path."""
         if not self.workspace_settings:
-            cwd = normalize_path(os.getcwd())
+            cwd = normalize_path(
+                os.getcwd(), resolve_symlinks=self.config.resolve_symlinks
+            )
             return {
                 "cwd": cwd,
                 "workspaceFS": cwd,
@@ -153,7 +165,9 @@ class ToolServer:
         workspaces = {s["workspaceFS"] for s in self.workspace_settings.values()}
 
         while file_path != file_path.parent:
-            str_file_path = normalize_path(str(file_path))
+            str_file_path = normalize_path(
+                str(file_path), resolve_symlinks=self.config.resolve_symlinks
+            )
             if str_file_path in workspaces:
                 return self.workspace_settings[str_file_path]
             file_path = file_path.parent
@@ -167,7 +181,10 @@ class ToolServer:
             workspaces = {s["workspaceFS"] for s in self.workspace_settings.values()}
 
             while document_workspace != document_workspace.parent:
-                norm_path = normalize_path(str(document_workspace))
+                norm_path = normalize_path(
+                    str(document_workspace),
+                    resolve_symlinks=self.config.resolve_symlinks,
+                )
                 if norm_path in workspaces:
                     return norm_path
                 document_workspace = document_workspace.parent
@@ -178,7 +195,9 @@ class ToolServer:
         """Return workspace settings for the given document."""
         if document is None or document.path is None:
             if not self.workspace_settings:
-                cwd = normalize_path(os.getcwd())
+                cwd = normalize_path(
+                    os.getcwd(), resolve_symlinks=self.config.resolve_symlinks
+                )
                 return {
                     "cwd": cwd,
                     "workspaceFS": cwd,
@@ -191,7 +210,10 @@ class ToolServer:
         if key is not None:
             return self.workspace_settings[key]
 
-        key = normalize_path(str(pathlib.Path(document.path).parent))
+        key = normalize_path(
+            str(pathlib.Path(document.path).parent),
+            resolve_symlinks=self.config.resolve_symlinks,
+        )
         return {
             "cwd": key,
             "workspaceFS": key,

{vscode_common_python_lsp-0.2.1 → vscode_common_python_lsp-0.4.0}/vscode_common_python_lsp.egg-info/PKG-INFO

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