generate session

Author: zzhaolei

kitty/boss.py

@@ -477,15 +477,14 @@ def add_os_panel(self, cfg: LayerShellConfig, wclass: str | None = appname, wnam
     def list_os_windows(
         self, self_window: Window | None = None,
         tab_filter: Callable[[Tab], bool] | None = None,
-        window_filter: Callable[[Window], bool] | None = None,
-        output_session: bool | None = None,
+        window_filter: Callable[[Window], bool] | None = None
     ) -> Iterator[OSWindowDict]:
         with cached_process_data():
             active_tab_manager = self.active_tab_manager
             focused_wid = current_focused_os_window_id()
             last_focused = last_focused_os_window_id()
             for os_window_id, tm in self.os_window_map.items():
-                tabs = list(tm.list_tabs(self_window, tab_filter, window_filter, output_session))
+                tabs = list(tm.list_tabs(self_window, tab_filter, window_filter))
                 if tabs:
                     bo = background_opacity_of(os_window_id)
                     if bo is None:

kitty/rc/ls.py

@@ -2,12 +2,15 @@
 # License: GPLv3 Copyright: 2020, Kovid Goyal <kovid at kovidgoyal.net>
 
 import json
+import os
 from collections.abc import Callable
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Sequence
 
 from kitty.constants import appname
 
 from .base import MATCH_TAB_OPTION, MATCH_WINDOW_OPTION, ArgsType, Boss, PayloadGetType, PayloadType, RCOptions, RemoteCommand, ResponseType, Tab, Window
+from ..boss import OSWindowDict
+from ..child import ProcessDesc
 
 if TYPE_CHECKING:
     from kitty.cli_stub import LSRCOptions as CLIOptions
@@ -19,7 +22,7 @@ class LS(RemoteCommand):
     match/str: Window to change colors in
     match_tab/str: Tab to change colors in
     self/bool: Boolean indicating whether to list only the window the command is run in
-    output_session/bool: Output session
+    output_format/str: Output in json or session format
     '''
 
     short_desc = 'List tabs/windows'
@@ -44,9 +47,11 @@ class LS(RemoteCommand):
 Only list the window this command is run in.
 
 
---output-session
-type=bool-set
-Output session
+--output-format
+type=choices
+choices=json,session
+default=json
+Output in json or session format
 ''' + '\n\n' + MATCH_WINDOW_OPTION + '\n\n' + MATCH_TAB_OPTION.replace('--match -m', '--match-tab -t', 1)
 
     def message_to_kitty(self, global_opts: RCOptions, opts: 'CLIOptions', args: ArgsType) -> PayloadType:
@@ -55,7 +60,7 @@ def message_to_kitty(self, global_opts: RCOptions, opts: 'CLIOptions', args: Arg
     def response_from_kitty(self, boss: Boss, window: Window | None, payload_get: PayloadGetType) -> ResponseType:
         tab_filter: Callable[[Tab], bool] | None = None
         window_filter: Callable[[Window], bool] | None = None
-        output_session: bool | None = None
+        output_session: bool = False
 
         if payload_get('self'):
             def wf(w: Window) -> bool:
@@ -66,9 +71,9 @@ def wf(w: Window) -> bool:
             def wf(w: Window) -> bool:
                 return w.id in window_ids
             window_filter = wf
-        elif payload_get('output_session'):
+        elif payload_get('output_format') == 'session':
             output_session = True
-        data = list(boss.list_os_windows(window, tab_filter, window_filter, output_session))
+        data = list(boss.list_os_windows(window, tab_filter, window_filter))
         if not payload_get('all_env_vars'):
             all_env_blocks: list[dict[str, str]] = []
             common_env_vars: set[tuple[str, str]] = set()
@@ -87,7 +92,51 @@ def wf(w: Window) -> bool:
                 for env in all_env_blocks:
                     for r in remove_env_vars:
                         env.pop(r, None)
-        return json.dumps(data, indent=2, sort_keys=True)
+        if not output_session:
+            return json.dumps(data, indent=2, sort_keys=True)
+        return self.convert_to_session(data)
+
+    def convert_to_session(self, data: list[OSWindowDict]) -> str:
+        '''Convert a kitty session dict, into a kitty session file and output it.'''
+        session = []
+        first = True
+        for osw in data:
+            if first:
+                first = False
+            else:
+                session.append('\nnew_os_window\n')
+
+            for tab in osw['tabs']:
+                session.append(f'new_tab {tab["title"]}\n')
+                session.append(f'layout {tab["layout"]}\n')
+                session.append('\n')
+
+                for w in tab['windows']:
+                    session.append(f'cd {w["cwd"]}\n')
+                    session.append(f'launch --var=kitty_serialize_window_id={w["id"]} {self.env_to_str(w["env"])}\n')
+                    if w['is_focused']:
+                        session.append('focus\n')
+                    session.append('\n')
+                layout_state = json.dumps(tab['layout_state'])
+                session.append(f'set_layout_state {layout_state}\n')
+        return ''.join(session)
+
+    def env_to_str(self, env: dict[str, str]):
+        '''Convert an env list to a series of '--env key=value' parameters and return as a string.'''
+        s = ''
+        for key in env:
+            s += f'--env "{key}={env[key]}" '
+
+        return s.strip()
+
+    def cmdline_to_str(self, cmdline: Sequence[str] | None):
+        '''Convert a cmdline list to a space separated string.'''
+        s = ''
+        if cmdline:
+            for e in cmdline:
+                s += f'{e} '
+
+        return s.strip()
 
 
 ls = LS()

kitty/tabs.py

@@ -1120,8 +1120,7 @@ def __len__(self) -> int:
     def list_tabs(
         self, self_window: Window | None = None,
         tab_filter: Callable[[Tab], bool] | None = None,
-        window_filter: Callable[[Window], bool] | None = None,
-        output_session: bool | None = None,
+        window_filter: Callable[[Window], bool] | None = None
     ) -> Generator[TabDict, None, None]:
         active_tab = self.active_tab
         for tab in self:
@@ -1134,7 +1133,7 @@ def list_tabs(
                         'is_active': tab is active_tab,
                         'title': tab.name or tab.title,
                         'layout': str(tab.current_layout.name),
-                        'layout_state': tab.current_layout.serialize(tab.windows) if output_session else tab.current_layout.layout_state(),
+                        'layout_state': tab.current_layout.serialize(tab.windows),
                         'layout_opts': tab.current_layout.layout_opts.serialized(),
                         'enabled_layouts': tab.enabled_layouts,
                         'windows': windows,