Proof of concept for changing the title with a yaml file on each directory

Author: jorgeecardona

Pipfile

@@ -35,6 +35,7 @@ black = "==21.8b0"
 flakehell = "*"
 toml = "*"
 dataclasses = "*"
+pyyaml = "*"
 
 [packages]
 pbr = "*"

docs/source/user/features.rst

@@ -114,3 +114,11 @@ Tab UUID
 Tabs are uniquely identified with a UUID. Each terminal receives this UUID in the following
 environment varialbe: ``GUAKE_TAB_UUID``. It can be used to rename the tab from the command line
 using ``--tab-index 3c542bc1-7c99-4e73-8d37-e08281bd592c``.
+
+
+Per-directory `.guake.yml` file
+=============================
+
+If there is a file named `.guake.yml` in the current working directory of the shell associated with a tab, Guake will try to read the title from there. The current format is very simple and it will probably change in the future::
+
+    title: "My Great Project"

guake/guake_app.py

@@ -19,6 +19,7 @@
 Boston, MA 02110-1301 USA
 """
 import json
+import yaml
 import logging
 import os
 import shutil
@@ -1102,8 +1103,30 @@ def recompute_tabs_titles(self):
             page_num = self.get_notebook().page_num(terminal.get_parent())
             self.get_notebook().rename_page(page_num, self.compute_tab_title(terminal), False)
 
+    def load_cwd_guake_yaml(self, vte) -> dict:
+        # Read the content of .guake.yml in cwd
+        cwd = Path(vte.get_current_directory())
+        guake_yaml = cwd.joinpath(".guake.yml")
+        content = {}
+        try:
+            if guake_yaml.is_file():
+                with guake_yaml.open(encoding="utf-8") as fd:
+                    content = yaml.safe_load(fd)
+        except PermissionError:
+            log.debug("PermissionError on accessing .guake.yml")
+
+        if not isinstance(content, dict):
+            conent = {}
+        return content
+
     def compute_tab_title(self, vte):
         """Compute the tab title"""
+
+        guake_yml = self.load_cwd_guake_yaml(vte)
+
+        if "title" in guake_yml:
+            return guake_yml["title"]
+
         vte_title = vte.get_window_title() or _("Terminal")
         try:
             current_directory = vte.get_current_directory()
@@ -1117,6 +1140,7 @@ def compute_tab_title(self, vte):
                     vte_title = "(root)"
         except OSError:
             pass
+
         return TabNameUtils.shorten(vte_title, self.settings)
 
     def check_if_terminal_directory_changed(self, term):
@@ -1151,6 +1175,7 @@ def on_terminal_title_changed(self, vte, term):
             page_num = nb.page_num(box)
             if page_num != -1:
                 break
+
         # if tab has been renamed by user, don't override.
         if not getattr(box, "custom_label_set", False):
             title = self.compute_tab_title(vte)

releasenotes/notes/per-directory-yaml-e3be0e86170cd71d.yaml

@@ -0,0 +1,10 @@
+release_summary: >
+    Add a per-directory .guake.yml to configure how guake behaves in that directory
+
+features:
+  - |
+    Check for a file .guake.yml on the CWD to extract the label to put in the tab #1758
+
+upgrade:
+  - |
+    Users should expect guake.yml files in current directory to override global settings