refactor: Add reason to BadSessionName

Author: tony

src/libtmux/common.py

@@ -453,15 +453,11 @@ def session_check_name(session_name: t.Optional[str]) -> None:
         Invalid session name.
     """
     if session_name is None or len(session_name) == 0:
-        raise exc.BadSessionName("tmux session names may not be empty.")
+        raise exc.BadSessionName(reason="empty", session_name=session_name)
     elif "." in session_name:
-        raise exc.BadSessionName(
-            'tmux session name "%s" may not contain periods.', session_name
-        )
+        raise exc.BadSessionName(reason="contains periods", session_name=session_name)
     elif ":" in session_name:
-        raise exc.BadSessionName(
-            'tmux session name "%s" may not contain colons.', session_name
-        )
+        raise exc.BadSessionName(reason="contains colons", session_name=session_name)
 
 
 def handle_option_error(error: str) -> t.Type[exc.OptionError]:

src/libtmux/exc.py

@@ -31,6 +31,14 @@ class BadSessionName(LibTmuxException):
 
     """Disallowed session name for tmux (empty, contains periods or colons)."""
 
+    def __init__(
+        self, reason: str, session_name: t.Optional[str] = None, *args: object
+    ):
+        msg = f"Bad session name: {reason}"
+        if session_name is not None:
+            msg += f" (session name: {session_name})"
+        return super().__init__(msg)
+
 
 class OptionError(LibTmuxException):
 

tests/legacy_api/test_common.py

@@ -184,10 +184,10 @@ def test_tmux_cmd_unicode(session: Session) -> None:
 @pytest.mark.parametrize(
     "session_name,raises,exc_msg_regex",
     [
-        ("", True, "may not be empty"),
-        (None, True, "may not be empty"),
-        ("my great session.", True, "may not contain periods"),
-        ("name: great session", True, "may not contain colons"),
+        ("", True, "empty"),
+        (None, True, "empty"),
+        ("my great session.", True, "contains periods"),
+        ("name: great session", True, "contains colons"),
         ("new great session", False, None),
         ("ajf8a3fa83fads,,,a", False, None),
     ],

tests/test_common.py

@@ -189,10 +189,10 @@ class SessionCheckName(t.NamedTuple):
 @pytest.mark.parametrize(
     SessionCheckName._fields,
     [
-        SessionCheckName("", True, "may not be empty"),
-        SessionCheckName(None, True, "may not be empty"),
-        SessionCheckName("my great session.", True, "may not contain periods"),
-        SessionCheckName("name: great session", True, "may not contain colons"),
+        SessionCheckName("", True, "empty"),
+        SessionCheckName(None, True, "empty"),
+        SessionCheckName("my great session.", True, "contains periods"),
+        SessionCheckName("name: great session", True, "contains colons"),
         SessionCheckName("new great session", False, None),
         SessionCheckName("ajf8a3fa83fads,,,a", False, None),
     ],