refactor: extract venv management code into its own class (#146)

rchl · rchl · commit e235a4b33b31 · 2026-01-25T20:19:09.000+01:00
diff --git a/.github/workflows/on-pull-request.yml b/.github/workflows/on-pull-request.yml
@@ -30,6 +30,8 @@ jobs:
       - uses: SublimeText/UnitTesting/actions/setup@v1
         with:
           sublime-text-version: 4
+          # Needs to have different name than the dependency to be able to run tests
+          package-name: lsp-utils-dep
           extra-packages: |
             sublimelsp/LSP@main
             sublimelsp/LSP-pyright@master
@@ -52,9 +54,9 @@ jobs:
           cd ./
           # detached head will crash package control
           rm -rf "./.git"
-          echo "Overwriting installed dependency in $ST_LIBS_DIR/$PACKAGE"
-          rm -rf "$ST_LIBS_DIR/$PACKAGE"
-          mv "./st4_py38/$PACKAGE" "$ST_LIBS_DIR"
+          echo "Overwriting installed dependency in $ST_LIBS_DIR/lsp_utils"
+          rm -rf "$ST_LIBS_DIR/lsp_utils"
+          mv "./st4_py38/lsp_utils" "$ST_LIBS_DIR"
           cd -
       - uses: SublimeText/UnitTesting/actions/run-tests@v1
 
@@ -70,7 +72,7 @@ jobs:
       - run: |
           sudo apt update
           sudo apt install --no-install-recommends -y x11-xserver-utils
-      - run: pip3 install mypy==1.7.1 flake8==5.0.4 pyright==1.1.339 --user
+      - run: pip3 install mypy==1.19.1 flake8==7.3.0 pyright==1.1.408 --user
       - run: echo "$HOME/.local/bin" >> $GITHUB_PATH
       - run: git clone https://github.com/sublimelsp/LSP.git
       - run: git clone https://github.com/SublimeText/sublime_lib.git
diff --git a/mypy.ini b/mypy.ini
@@ -4,7 +4,7 @@ python_version = 3.11
 # check_untyped_defs = True
 disallow_untyped_defs = True
 strict_optional = True
-mypy_path = ..:../LSP/stubs:../sublime_lib/st3/
+mypy_path = ..:../LSP/stubs:../sublime_lib/
 namespace_packages = True
 ; Don't report errors in external packages.
 follow_imports = silent
diff --git a/pyrightconfig.json b/pyrightconfig.json
@@ -1,6 +1,7 @@
 {
-    "pythonVersion": "3.11",
+    "pythonVersion": "3.8",
     "reportMissingModuleSource": "none",
+    "reportUnusedCallResult": "none",
     "ignore": ["**/third_party/"],
-    "extraPaths": ["..", "../LSP/stubs", "../sublime_lib/st3"]
+    "extraPaths": ["..", "../LSP/stubs", "../sublime_lib"]
 }
diff --git a/st4_py38/lsp_utils/__init__.py b/st4_py38/lsp_utils/__init__.py
@@ -1,3 +1,4 @@
+from __future__ import annotations
 from ._client_handler import ClientHandler
 from ._client_handler import notification_handler
 from ._client_handler import request_handler
@@ -6,6 +7,7 @@
 from .generic_client_handler import GenericClientHandler
 from .node_runtime import NodeRuntime
 from .npm_client_handler import NpmClientHandler
+from .pip_venv_manager import PipVenvManager
 from .server_npm_resource import ServerNpmResource
 from .server_pip_resource import ServerPipResource
 from .server_resource_interface import ServerResourceInterface
@@ -18,6 +20,7 @@
     'GenericClientHandler',
     'NodeRuntime',
     'NpmClientHandler',
+    'PipVenvManager',
     'ServerResourceInterface',
     'ServerStatus',
     'ServerNpmResource',
diff --git a/st4_py38/lsp_utils/_client_handler/__init__.py b/st4_py38/lsp_utils/_client_handler/__init__.py
@@ -1,3 +1,4 @@
+from __future__ import annotations
 from .abstract_plugin import ClientHandler
 from .api_decorator import notification_handler
 from .api_decorator import request_handler
diff --git a/st4_py38/lsp_utils/_client_handler/abstract_plugin.py b/st4_py38/lsp_utils/_client_handler/abstract_plugin.py
@@ -1,3 +1,4 @@
+from __future__ import annotations
 from .._util import weak_method
 from ..api_wrapper_interface import ApiWrapperInterface
 from ..server_resource_interface import ServerStatus
@@ -14,8 +15,8 @@
 from LSP.plugin import unregister_plugin
 from LSP.plugin import WorkspaceFolder
 from LSP.plugin.core.rpc import method2attr
-from LSP.plugin.core.typing import Any, Callable, Dict, List, Optional, Tuple, TypedDict
 from os import path
+from typing import Any, Callable, Dict, List, Optional, Tuple, TypedDict
 from weakref import ref
 import sublime
 
diff --git a/st4_py38/lsp_utils/_client_handler/api_decorator.py b/st4_py38/lsp_utils/_client_handler/api_decorator.py
@@ -1,6 +1,7 @@
+from __future__ import annotations
 from ..api_wrapper_interface import ApiWrapperInterface
 from .interface import ClientHandlerInterface
-from LSP.plugin.core.typing import Any, Callable, List, Optional, TypeVar, Union
+from typing import Any, Callable, List, Optional, TypeVar, Union
 import inspect
 
 __all__ = [
@@ -72,7 +73,7 @@ def register_decorated_handlers(client_handler: ClientHandlerInterface, api: Api
     """
     for _, func in inspect.getmembers(client_handler, predicate=inspect.isroutine):
         for client_event, handler_mark in _HANDLER_MARKS.items():
-            message_methods = getattr(func, handler_mark, None)  # type: Optional[List[str]]
+            message_methods: Optional[List[str]] = getattr(func, handler_mark, None)
             if message_methods is None:
                 continue
 
diff --git a/st4_py38/lsp_utils/_client_handler/interface.py b/st4_py38/lsp_utils/_client_handler/interface.py
@@ -1,11 +1,12 @@
+from __future__ import annotations
 from ..api_wrapper_interface import ApiWrapperInterface
 from ..server_resource_interface import ServerResourceInterface
 from abc import ABCMeta
 from abc import abstractmethod
 from LSP.plugin import ClientConfig
 from LSP.plugin import DottedDict
 from LSP.plugin import WorkspaceFolder
-from LSP.plugin.core.typing import Dict, List, Optional, Tuple
+from typing import Dict, List, Optional, Tuple
 import sublime
 
 __all__ = ['ClientHandlerInterface']
diff --git a/st4_py38/lsp_utils/_util/__init__.py b/st4_py38/lsp_utils/_util/__init__.py
@@ -1,3 +1,4 @@
+from __future__ import annotations
 from .weak_method import weak_method
 
 __all__ = [
diff --git a/st4_py38/lsp_utils/_util/weak_method.py b/st4_py38/lsp_utils/_util/weak_method.py
@@ -1,5 +1,6 @@
-from LSP.plugin.core.typing import Any, Callable
+from __future__ import annotations
 from types import MethodType
+from typing import Any, Callable
 import weakref
 
 
diff --git a/st4_py38/lsp_utils/api_wrapper_interface.py b/st4_py38/lsp_utils/api_wrapper_interface.py
@@ -1,5 +1,6 @@
+from __future__ import annotations
 from abc import ABCMeta, abstractmethod
-from LSP.plugin.core.typing import Any, Callable
+from typing import Any, Callable
 
 __all__ = ['ApiWrapperInterface']
 
diff --git a/st4_py38/lsp_utils/generic_client_handler.py b/st4_py38/lsp_utils/generic_client_handler.py
@@ -1,3 +1,4 @@
+from __future__ import annotations
 from ._client_handler import ClientHandler
 from .api_wrapper_interface import ApiWrapperInterface
 from .helpers import rmtree_ex
@@ -6,7 +7,7 @@
 from LSP.plugin import ClientConfig
 from LSP.plugin import DottedDict
 from LSP.plugin import WorkspaceFolder
-from LSP.plugin.core.typing import Any, Dict, List, Optional, Tuple
+from typing import Any, Dict, List, Optional, Tuple
 import os
 import sublime
 
diff --git a/st4_py38/lsp_utils/helpers.py b/st4_py38/lsp_utils/helpers.py
@@ -1,4 +1,5 @@
-from LSP.plugin.core.typing import Any, Callable, Dict, List, Optional, Tuple
+from __future__ import annotations
+from typing import Any, Callable, Dict, List, Optional, Tuple
 import os
 import shutil
 import sublime
@@ -11,6 +12,10 @@
 is_windows = sublime.platform() == 'windows'
 
 
+def platform_program_file_extension() -> str:
+    return '.exe' if sublime.platform() == 'windows' else ''
+
+
 def run_command_sync(
     args: List[str],
     cwd: Optional[str] = None,
@@ -60,6 +65,13 @@ def execute(on_success: StringCallback, on_error: StringCallback, args: List[str
     thread.start()
 
 
+def run_command_ex(*cmd: str, cwd: Optional[str] = None) -> str:
+    output, error = run_command_sync(list(cmd), cwd=cwd)
+    if error:
+        raise Exception(error)
+    return output
+
+
 def decode_bytes(data: bytes) -> str:
     """
     Decodes provided bytes using `utf-8` decoding, ignoring potential decoding errors.
diff --git a/st4_py38/lsp_utils/node_runtime.py b/st4_py38/lsp_utils/node_runtime.py
@@ -1,3 +1,4 @@
+from __future__ import annotations
 from .constants import SETTINGS_FILENAME
 from .helpers import rmtree_ex
 from .helpers import run_command_sync
@@ -6,10 +7,10 @@
 from .third_party.semantic_version import NpmSpec, Version
 from contextlib import contextmanager
 from LSP.plugin.core.logging import debug
-from LSP.plugin.core.typing import cast, Any, Dict, Generator, List, Optional, Tuple, Union
 from os import path
 from os import remove
 from sublime_lib import ActivityIndicator
+from typing import cast, Any, Dict, Generator, List, Optional, Tuple, Union
 import os
 import shutil
 import sublime
diff --git a/st4_py38/lsp_utils/npm_client_handler.py b/st4_py38/lsp_utils/npm_client_handler.py
@@ -1,10 +1,11 @@
+from __future__ import annotations
 from .generic_client_handler import GenericClientHandler
 from .server_npm_resource import ServerNpmResource
 from .server_resource_interface import ServerResourceInterface
 from LSP.plugin import ClientConfig
 from LSP.plugin import WorkspaceFolder
-from LSP.plugin.core.typing import Dict, List, Optional, Tuple
 from os import path
+from typing import Dict, List, Optional, Tuple
 import sublime
 
 __all__ = ['NpmClientHandler']
diff --git a/st4_py38/lsp_utils/pip_client_handler.py b/st4_py38/lsp_utils/pip_client_handler.py
@@ -1,8 +1,10 @@
+from __future__ import annotations
 from .generic_client_handler import GenericClientHandler
 from .server_pip_resource import ServerPipResource
 from .server_resource_interface import ServerResourceInterface
-from LSP.plugin.core.typing import List, Optional
 from os import path
+from typing import List, Optional
+from typing_extensions import override
 import shutil
 import sublime
 
@@ -16,9 +18,9 @@ class PipClientHandler(GenericClientHandler):
     Automatically manages a pip-based server by installing and updating dependencies based on provided
     `requirements.txt` file.
     """
-    __server = None  # type: Optional[ServerPipResource]
+    __server: Optional[ServerPipResource] = None
 
-    requirements_txt_path = ''
+    requirements_txt_path: str = ''
     """
     The path to the `requirements.txt` file containing a list of dependencies required by the server.
 
@@ -36,7 +38,7 @@ class PipClientHandler(GenericClientHandler):
     :required: Yes
     """
 
-    server_filename = ''
+    server_filename: str = ''
     """
     The file name of the binary used to start the server.
 
@@ -59,10 +61,12 @@ def get_python_binary(cls) -> str:
     # --- GenericClientHandler handlers -------------------------------------------------------------------------------
 
     @classmethod
+    @override
     def manages_server(cls) -> bool:
         return True
 
     @classmethod
+    @override
     def get_server(cls) -> Optional[ServerResourceInterface]:
         if not cls.__server:
             python_binary = cls.get_python_binary()
@@ -73,6 +77,7 @@ def get_server(cls) -> Optional[ServerResourceInterface]:
         return cls.__server
 
     @classmethod
+    @override
     def get_additional_paths(cls) -> List[str]:
         server = cls.get_server()
         if server:
diff --git a/st4_py38/lsp_utils/pip_venv_manager.py b/st4_py38/lsp_utils/pip_venv_manager.py
@@ -0,0 +1,84 @@
+from __future__ import annotations
+from .helpers import platform_program_file_extension
+from .helpers import rmtree_ex
+from .helpers import run_command_ex
+from hashlib import md5
+from os import makedirs
+from os import path
+from pathlib import Path
+from sublime_lib import ResourcePath
+from typing import final
+import sublime
+
+__all__ = ['PipVenvManager']
+
+
+@final
+class PipVenvManager:
+
+    """
+    Handles installation and update of resources specified in provided pip requirements list.
+    """
+
+    def __init__(self, venv_path: Path, requirements_path: str, python_binary: str) -> None:
+        """
+        :param venv_path:         The path where the resources should be installed.
+        :param requirements_path: The path to the `requirements.txt` file, relative to the `Packages/` directory.
+                                  If the package `LSP-foo` has a `requirements.txt` file at the root then the path
+                                  should be `LSP-foo/requirements.txt`.
+        :param python_binary:     The file name or a full path to the python binary. Defaults to py, python or python3
+                                  depending on the platform.
+        """
+        self._venv_path = venv_path
+        self._requirements_resource_path = f'Packages/{requirements_path}'
+        self._python_binary = python_binary
+
+    @property
+    def venv_path(self) -> Path:
+        return self._venv_path
+
+    @property
+    def venv_bin_path(self) -> Path:
+        bin_dir = 'Scripts' if sublime.platform() == 'windows' else 'bin'
+        return self.venv_path.joinpath(bin_dir)
+
+    @property
+    def _venv_pip_binary(self) -> Path:
+        return self.venv_bin_path.joinpath('pip' + platform_program_file_extension())
+
+    @property
+    def _python_version_path(self) -> Path:
+        return self.venv_path.joinpath('python_version')
+
+    def needs_install_or_update(self) -> bool:
+        if not path.exists(self._venv_pip_binary):
+            return True
+        if not path.exists(self._python_version_path):
+            return True
+        with open(self._python_version_path, 'r') as f:
+            if f.readline().strip() != run_command_ex(self._python_binary, '--version').strip():
+                return True
+        src_requirements_resource = ResourcePath(self._requirements_resource_path)
+        if not src_requirements_resource.exists():
+            raise Exception('Missing required "requirements.txt" in {}'.format(self._requirements_resource_path))
+        src_requirements_hash = md5(src_requirements_resource.read_bytes()).hexdigest()
+        try:
+            with open(path.join(self.venv_path, 'requirements.txt'), 'rb') as file:
+                dst_requirements_hash = md5(file.read()).hexdigest()
+            if src_requirements_hash != dst_requirements_hash:
+                return True
+        except FileNotFoundError:
+            # Needs to be re-installed.
+            return True
+        return False
+
+    def install(self) -> None:
+        rmtree_ex(str(self.venv_path), ignore_errors=True)
+        makedirs(self.venv_path, exist_ok=True)
+        run_command_ex(self._python_binary, '-m', 'venv', str(self._venv_path))
+        dest_requirements_txt_path = path.join(self._venv_path, 'requirements.txt')
+        ResourcePath(self._requirements_resource_path).copy(dest_requirements_txt_path)
+        run_command_ex(
+            str(self._venv_pip_binary), 'install', '-r', dest_requirements_txt_path, '--disable-pip-version-check')
+        with open(self._python_version_path, 'w') as f:
+            f.write(run_command_ex(self._python_binary, '--version'))
diff --git a/st4_py38/lsp_utils/server_npm_resource.py b/st4_py38/lsp_utils/server_npm_resource.py
@@ -1,14 +1,15 @@
+from __future__ import annotations
 from .helpers import rmtree_ex
 from .helpers import SemanticVersion
 from .node_runtime import NodeRuntime
 from .server_resource_interface import ServerResourceInterface
 from .server_resource_interface import ServerStatus
 from hashlib import md5
-from LSP.plugin.core.typing import Dict, Optional, TypedDict, Union
 from os import makedirs
 from os import path
 from os import remove
 from sublime_lib import ResourcePath
+from typing import Dict, Optional, TypedDict, Union
 
 __all__ = ['ServerNpmResource']
 
@@ -38,7 +39,7 @@ def create(cls, options: ServerNpmResourceCreateOptions) -> 'ServerNpmResource':
         package_storage = options['package_storage']
         storage_path = options['storage_path']
         minimum_node_version = options['minimum_node_version']
-        required_node_version = options['required_node_version']  # type: Union[str, SemanticVersion]
+        required_node_version: Union[str, SemanticVersion] = options['required_node_version']
         skip_npm_install = options['skip_npm_install']
         # Fallback to "minimum_node_version" if "required_node_version" is 0.0.0 (not overridden).
         if required_node_version == '0.0.0':
diff --git a/st4_py38/lsp_utils/server_pip_resource.py b/st4_py38/lsp_utils/server_pip_resource.py
diff --git a/st4_py38/lsp_utils/server_resource_interface.py b/st4_py38/lsp_utils/server_resource_interface.py
diff --git a/st4_py38/pyproject.toml b/st4_py38/pyproject.toml
diff --git a/tests/setup.py b/tests/setup.py
diff --git a/tests/test_smoketest.py b/tests/test_smoketest.py
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`		`- "pythonVersion": "3.11",`
	`2`	`+ "pythonVersion": "3.8",`
`3`	`3`	`"reportMissingModuleSource": "none",`
	`4`	`+ "reportUnusedCallResult": "none",`
`4`	`5`	`"ignore": ["**/third_party/"],`
`5`		`- "extraPaths": ["..", "../LSP/stubs", "../sublime_lib/st3"]`
	`6`	`+ "extraPaths": ["..", "../LSP/stubs", "../sublime_lib"]`
`6`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+from __future__ import annotations`
`1`	`2`	`from .abstract_plugin import ClientHandler`
`2`	`3`	`from .api_decorator import notification_handler`
`3`	`4`	`from .api_decorator import request_handler`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+from __future__ import annotations`
`1`	`2`	`from .weak_method import weak_method`
`2`	`3`
`3`	`4`	`__all__ = [`