refactor!(options): Move handle_options_error -> options

Author: tony

src/libtmux/common.py

@@ -446,43 +446,6 @@ def session_check_name(session_name: t.Optional[str]) -> None:
         raise exc.BadSessionName(reason="contains colons", session_name=session_name)
 
 
-def handle_option_error(error: str) -> t.Type[exc.OptionError]:
-    """Raise exception if error in option command found.
-
-    In tmux 3.0, show-option and show-window-option return invalid option instead of
-    unknown option. See https://github.com/tmux/tmux/blob/3.0/cmd-show-options.c.
-
-    In tmux >2.4, there are 3 different types of option errors:
-
-    - unknown option
-    - invalid option
-    - ambiguous option
-
-    In tmux <2.4, unknown option was the only option.
-
-    All errors raised will have the base error of :exc:`exc.OptionError`. So to
-    catch any option error, use ``except exc.OptionError``.
-
-    Parameters
-    ----------
-    error : str
-        Error response from subprocess call.
-
-    Raises
-    ------
-    :exc:`exc.OptionError`, :exc:`exc.UnknownOption`, :exc:`exc.InvalidOption`,
-    :exc:`exc.AmbiguousOption`
-    """
-    if "unknown option" in error:
-        raise exc.UnknownOption(error)
-    elif "invalid option" in error:
-        raise exc.InvalidOption(error)
-    elif "ambiguous option" in error:
-        raise exc.AmbiguousOption(error)
-    else:
-        raise exc.OptionError(error)  # Raise generic option error
-
-
 def get_libtmux_version() -> LooseVersion:
     """Return libtmux version is a PEP386 compliant format.
 

src/libtmux/options.py

@@ -0,0 +1,44 @@
+"""Helpers for tmux options."""
+import logging
+import typing as t
+
+from . import exc
+
+logger = logging.getLogger(__name__)
+
+
+def handle_option_error(error: str) -> t.Type[exc.OptionError]:
+    """Raise exception if error in option command found.
+
+    In tmux 3.0, show-option and show-window-option return invalid option instead of
+    unknown option. See https://github.com/tmux/tmux/blob/3.0/cmd-show-options.c.
+
+    In tmux >2.4, there are 3 different types of option errors:
+
+    - unknown option
+    - invalid option
+    - ambiguous option
+
+    In tmux <2.4, unknown option was the only option.
+
+    All errors raised will have the base error of :exc:`exc.OptionError`. So to
+    catch any option error, use ``except exc.OptionError``.
+
+    Parameters
+    ----------
+    error : str
+        Error response from subprocess call.
+
+    Raises
+    ------
+    :exc:`exc.OptionError`, :exc:`exc.UnknownOption`, :exc:`exc.InvalidOption`,
+    :exc:`exc.AmbiguousOption`
+    """
+    if "unknown option" in error:
+        raise exc.UnknownOption(error)
+    elif "invalid option" in error:
+        raise exc.InvalidOption(error)
+    elif "ambiguous option" in error:
+        raise exc.AmbiguousOption(error)
+    else:
+        raise exc.OptionError(error)  # Raise generic option error

src/libtmux/session.py

@@ -21,11 +21,11 @@
 from .common import (
     EnvironmentMixin,
     WindowDict,
-    handle_option_error,
     has_gte_version,
     has_version,
     session_check_name,
 )
+from .options import handle_option_error
 
 if t.TYPE_CHECKING:
     from .server import Server

src/libtmux/window.py

@@ -18,8 +18,9 @@
 from libtmux.pane import Pane
 
 from . import exc
-from .common import PaneDict, WindowOptionDict, handle_option_error
+from .common import PaneDict, WindowOptionDict
 from .formats import FORMAT_SEPARATOR
+from .options import handle_option_error
 
 if t.TYPE_CHECKING:
     from .server import Server