Merge branch 'fix/remove-generators' into fix/global-listener

* fix/remove-generators:
  Use orjson to de-/serialize json-rpc messages (#2513)
  remove unnecessary use of generators for session retrieval

.github/workflows/main.yml

@@ -41,7 +41,7 @@ jobs:
           python-version: '3.8'
       - run: sudo apt update
       - run: sudo apt install --no-install-recommends -y x11-xserver-utils
-      - run: pip3 install mypy==1.7.1 flake8==5.0.4 pyright==1.1.381 --user
+      - run: pip3 install mypy==1.7.1 flake8==5.0.4 pyright==1.1.381 orjson==3.10.7 --user
       - run: echo "$HOME/.local/bin" >> $GITHUB_PATH
       - run: mypy stubs
       - run: flake8 plugin tests

dependencies.json

@@ -3,6 +3,7 @@
         ">=4096": [
             "bracex",
             "mdpopups",
+            "orjson",
             "typing_extensions",
             "wcmatch"
         ]

plugin/core/registry.py

@@ -12,7 +12,7 @@
 from .windows import WindowManager
 from .windows import WindowRegistry
 from functools import partial
-from typing import Any, Generator, Iterable
+from typing import Any, Generator
 import operator
 import sublime
 import sublime_plugin
@@ -21,14 +21,14 @@
 windows = WindowRegistry()
 
 
-def best_session(view: sublime.View, sessions: Iterable[Session], point: int | None = None) -> Session | None:
+def best_session(view: sublime.View, sessions: list[Session], point: int | None = None) -> Session | None:
     if point is None:
         try:
             point = view.sel()[0].b
         except IndexError:
             return None
     try:
-        return max(sessions, key=lambda s: view.score_selector(point, s.config.priority_selector))  # type: ignore
+        return max(sessions, key=lambda s: view.score_selector(point, s.config.priority_selector))
     except ValueError:
         return None
 

plugin/core/sessions.py

@@ -701,15 +701,15 @@ def session_async(self, capability: str, point: int | None = None) -> Session |
         raise NotImplementedError()
 
     @abstractmethod
-    def sessions_async(self, capability: str | None = None) -> Generator[Session, None, None]:
+    def sessions_async(self, capability: str | None = None) -> list[Session]:
         raise NotImplementedError()
 
     @abstractmethod
-    def session_buffers_async(self, capability: str | None = None) -> Generator[SessionBufferProtocol, None, None]:
+    def session_buffers_async(self, capability: str | None = None) -> list[SessionBufferProtocol]:
         raise NotImplementedError()
 
     @abstractmethod
-    def session_views_async(self) -> Generator[SessionViewProtocol, None, None]:
+    def session_views_async(self) -> list[SessionViewProtocol]:
         raise NotImplementedError()
 
     @abstractmethod

plugin/core/transports.py

@@ -17,6 +17,10 @@
 import time
 import weakref
 
+try:
+    import orjson
+except ImportError:
+    orjson = None
 
 T = TypeVar('T')
 T_contra = TypeVar('T_contra', contravariant=True)
@@ -80,6 +84,8 @@ def read_data(self, reader: IO[bytes]) -> dict[str, Any] | None:
 
     @staticmethod
     def _encode(data: dict[str, Any]) -> bytes:
+        if orjson:
+            return orjson.dumps(data)
         return json.dumps(
             data,
             ensure_ascii=False,
@@ -90,6 +96,8 @@ def _encode(data: dict[str, Any]) -> bytes:
 
     @staticmethod
     def _decode(message: bytes) -> dict[str, Any]:
+        if orjson:
+            return orjson.loads(message)
         return json.loads(message.decode('utf-8'))
 
 

plugin/documents.py

@@ -319,13 +319,14 @@ def _update_diagnostic_in_status_bar_async(self) -> None:
                             return
         self.view.erase_status(self.ACTIVE_DIAGNOSTIC)
 
-    def session_buffers_async(self, capability: str | None = None) -> Generator[SessionBuffer, None, None]:
-        for sv in self.session_views_async():
-            if capability is None or sv.has_capability_async(capability):
-                yield sv.session_buffer
+    def session_buffers_async(self, capability: str | None = None) -> list[SessionBuffer]:
+        return [
+            sv.session_buffer for sv in self.session_views_async()
+            if capability is None or sv.has_capability_async(capability)
+        ]
 
-    def session_views_async(self) -> Generator[SessionView, None, None]:
-        yield from self._session_views.values()
+    def session_views_async(self) -> list[SessionView]:
+        return list(self._session_views.values())
 
     def on_text_changed_async(self, change_count: int, changes: Iterable[sublime.TextChange]) -> None:
         if self.view.is_primary():
@@ -857,10 +858,11 @@ def _on_initial_folding_ranges(self, kinds: list[str], response: list[FoldingRan
     def session_async(self, capability: str, point: int | None = None) -> Session | None:
         return best_session(self.view, self.sessions_async(capability), point)
 
-    def sessions_async(self, capability: str | None = None) -> Generator[Session, None, None]:
-        for sb in self.session_buffers_async():
-            if capability is None or sb.has_capability(capability):
-                yield sb.session
+    def sessions_async(self, capability: str | None = None) -> list[Session]:
+        return [
+            sb.session for sb in self.session_buffers_async()
+            if capability is None or sb.has_capability(capability)
+        ]
 
     def session_by_name(self, name: str | None = None) -> Session | None:
         for sb in self.session_buffers_async():

tox.ini

@@ -23,6 +23,7 @@ deps =
     mypy==1.7.1
     flake8==5.0.4
     pyright==1.1.381
+    orjson==3.10.7
 commands =
     # mypy disabled for main code as it doesn't currently support cyclic definitions - https://github.com/python/mypy/issues/731
     mypy stubs