A Script to change sway workspace name.

This script automatically changes the workspace name when an application
gets closed, moved or openend.

1 files changed, 130 insertions, 0 deletions

diff --git a/contrib/autoname-workspaces.py b/contrib/autoname-workspaces.py
new file mode 100755
index 00000000..297d91b2
--- /dev/null
+++ b/contrib/autoname-workspaces.py
@@ -0,0 +1,130 @@
+#!/usr/bin/python
+
+# This script requires i3ipc-python package (install it from a system package manager
+# or pip).
+# It adds icons to the workspace name for each open window.
+# Set your keybindings like this: set $workspace1 workspace number 1
+# Add your icons to WINDOW_ICONS.
+# Based on https://github.com/maximbaz/dotfiles/blob/master/bin/i3-autoname-workspaces
+
+import argparse
+import i3ipc
+import logging
+import re
+import signal
+import sys
+
+WINDOW_ICONS = {
+    "firefox": "",
+}
+
+DEFAULT_ICON = "󰀏"
+
+
+def icon_for_window(window):
+    app_id = window.app_id
+    if app_id is not None and len(app_id) > 0:
+        app_id = app_id.lower()
+        if app_id in WINDOW_ICONS:
+            return WINDOW_ICONS[app_id]
+        logging.info("No icon available for window with app_id: %s" % str(app_id))
+    else:
+        # xwayland support
+        class_name = window.window_class
+        if len(class_name) > 0:
+            class_name = class_name.lower()
+            if class_name in WINDOW_ICONS:
+                return WINDOW_ICONS[class_name]
+            logging.info(
+                "No icon available for window with class_name: %s" % str(class_name)
+            )
+    return DEFAULT_ICON
+
+
+def rename_workspaces(ipc):
+    for workspace in ipc.get_tree().workspaces():
+        name_parts = parse_workspace_name(workspace.name)
+        icon_tuple = ()
+        for w in workspace:
+            if w.app_id is not None or w.window_class is not None:
+                icon = icon_for_window(w)
+                if not ARGUMENTS.duplicates and icon in icon_tuple:
+                    continue
+                icon_tuple += (icon,)
+        name_parts["icons"] = "  ".join(icon_tuple) + " "
+        new_name = construct_workspace_name(name_parts)
+        ipc.command('rename workspace "%s" to "%s"' % (workspace.name, new_name))
+
+
+def undo_window_renaming(ipc):
+    for workspace in ipc.get_tree().workspaces():
+        name_parts = parse_workspace_name(workspace.name)
+        name_parts["icons"] = None
+        new_name = construct_workspace_name(name_parts)
+        ipc.command('rename workspace "%s" to "%s"' % (workspace.name, new_name))
+    ipc.main_quit()
+    sys.exit(0)
+
+
+def parse_workspace_name(name):
+    return re.match(
+        "(?P<num>[0-9]+):?(?P<shortname>\w+)? ?(?P<icons>.+)?", name
+    ).groupdict()
+
+
+def construct_workspace_name(parts):
+    new_name = str(parts["num"])
+    if parts["shortname"] or parts["icons"]:
+        new_name += ":"
+
+        if parts["shortname"]:
+            new_name += parts["shortname"]
+
+        if parts["icons"]:
+            new_name += " " + parts["icons"]
+
+    return new_name
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description="This script automatically changes the workspace name in sway depending on your open applications."
+    )
+    parser.add_argument(
+        "--duplicates",
+        "-d",
+        action="store_true",
+        help="Set it when you want an icon for each instance of the same application per workspace.",
+    )
+    parser.add_argument(
+        "--logfile",
+        "-l",
+        type=str,
+        default="/tmp/sway-autoname-workspaces.log",
+        help="Path for the logfile.",
+    )
+    args = parser.parse_args()
+    global ARGUMENTS
+    ARGUMENTS = args
+
+    logging.basicConfig(
+        level=logging.INFO,
+        filename=ARGUMENTS.logfile,
+        filemode="w",
+        format="%(message)s",
+    )
+
+    ipc = i3ipc.Connection()
+
+    for sig in [signal.SIGINT, signal.SIGTERM]:
+        signal.signal(sig, lambda signal, frame: undo_window_renaming(ipc))
+
+    def window_event_handler(ipc, e):
+        if e.change in ["new", "close", "move"]:
+            rename_workspaces(ipc)
+
+    ipc.on("window", window_event_handler)
+
+    rename_workspaces(ipc)
+
+    ipc.main()