overhaul option commands and errorbacks, tests

Author: tony

libtmux/common.py

@@ -9,8 +9,8 @@
 import logging
 import os
 import re
-import sys
 import subprocess
+import sys
 from distutils.version import LooseVersion
 
 from . import exc

libtmux/session.py

@@ -12,7 +12,7 @@
 
 from . import exc, formats
 from .common import EnvironmentMixin, TmuxMappingObject, \
-    TmuxRelationalObject, session_check_name
+    TmuxRelationalObject, session_check_name, handle_option_error
 from .window import Window
 
 logger = logging.getLogger(__name__)
@@ -132,17 +132,10 @@ def new_window(self,
                    window_shell=None):
         """Return :class:`Window` from ``$ tmux new-window``.
 
-        .. note::
-
-            By default, this will make the window active. For the new window
-            to be created and not set to current, pass in ``attach=False``.
+        By default, this will make the window active. For the new window
+        to be created and not set to current, pass in ``attach=False``.
 
         :param window_name: window name.
-
-        .. code-block:: bash
-
-            $ tmux new-window -n <window_name> -c <start_directory>
-
         :type window_name: string
         :param start_directory: specifies the working directory in which the
             new window is created.
@@ -335,6 +328,8 @@ def set_option(self, option, value, g=False):
         :type value: bool
         :param global: check for option globally across all servers (-g)
         :type global: bool
+        :raises: :exc:`exc.OptionError`, :exc:`exc.UnknownOption`,
+            :exc:`exc.InvalidOption`, :exc:`exc.AmbiguousOption`
 
         """
 
@@ -355,13 +350,7 @@ def set_option(self, option, value, g=False):
         )
 
         if isinstance(proc.stderr, list) and len(proc.stderr):
-            error = proc.stderr[0]
-            if 'unknown option' in error:
-                raise exc.UnknownOption(error)
-            elif 'invalid option' in error:
-                raise exc.InvalidOption(error)
-
-            raise ValueError('tmux set-option stderr: %s' % error)
+            handle_option_error(proc.stderr[0])
 
     def show_options(self, option=None, g=False):
         """Return a dict of options for the window.
@@ -425,11 +414,7 @@ def show_option(self, option, g=False):
         )
 
         if isinstance(cmd.stderr, list) and len(cmd.stderr):
-            error = cmd.stderr[0]
-            if 'unknown option' in error:
-                raise exc.UnknownOption(error)
-            else:
-                raise exc.LibTmuxException(error)
+            handle_option_error(cmd.stderr[0])
 
         if not len(cmd.stdout):
             return None

libtmux/window.py

@@ -11,7 +11,9 @@
 import os
 
 from . import exc, formats
-from .common import TmuxMappingObject, TmuxRelationalObject
+from .common import (
+    TmuxMappingObject, TmuxRelationalObject, handle_option_error
+)
 from .pane import Pane
 
 logger = logging.getLogger(__name__)
@@ -149,22 +151,7 @@ def set_window_option(self, option, value):
         )
 
         if isinstance(cmd.stderr, list) and len(cmd.stderr):
-            error = cmd.stderr[0]
-            if any(
-                x in error
-                for x in ['unknown option', 'invalid option']
-            ):
-                raise exc.UnknownOption(error)
-
-            raise ValueError(
-                'tmux set-window-option -t%s:%s %s %s\n%s' % (
-                    self.get('session_id'),
-                    self.index,
-                    option,
-                    value,
-                    error
-                )
-            )
+            handle_option_error(cmd.stderr[0])
 
     def show_window_options(self, option=None, g=False):
         """Return a dict of options for the window.
@@ -228,10 +215,7 @@ def show_window_option(self, option, g=False):
         )
 
         if len(cmd.stderr):
-            if 'unknown option' in cmd.stderr:
-                raise exc.UnknownOption(cmd.stderr[0])
-            elif 'invalid option' in cmd.stderr:
-                raise exc.InvalidOption(cmd.stderr[0])
+            handle_option_error(cmd.stderr[0])
 
         if not len(cmd.stdout):
             return None

tests/test_session.py

@@ -7,6 +7,7 @@
 import pytest
 
 from libtmux import Pane, Session, Window, exc
+from libtmux.common import has_gte_version
 from libtmux.test import TEST_SESSION_PREFIX, namer
 
 logger = logging.getLogger(__name__)
@@ -133,15 +134,31 @@ def test_empty_session_option_returns_None(session):
 
 
 def test_show_option_unknown(session):
-    """Session.show_option raises UnknownOption for bad option key."""
+    """Session.show_option raises UnknownOption for invalid option."""
     with pytest.raises(exc.UnknownOption):
         session.show_option('moooz')
 
 
-def test_set_option_bad(session):
-    """Session.set_option raises UnknownOption for bad option key."""
-    with pytest.raises(exc.UnknownOption):
-        session.set_option('afewewfew', 43)
+def test_show_option_ambiguous(session):
+    """Session.show_option raises AmbiguousOption for ambiguous option."""
+    with pytest.raises(exc.AmbiguousOption):
+        session.show_option('bell-')
+
+
+def test_set_option_ambigous(session):
+    """Session.set_option raises AmbiguousOption for invalid option."""
+    with pytest.raises(exc.AmbiguousOption):
+        session.set_option('bell-', 43)
+
+
+def test_set_option_invalid(session):
+    """Session.set_option raises UnknownOption for invalid option."""
+    if has_gte_version('2.4'):
+        with pytest.raises(exc.InvalidOption):
+            session.set_option('afewewfew', 43)
+    else:
+        with pytest.raises(exc.UnknownOption):
+            session.set_option('afewewfew', 43)
 
 
 def test_show_environment(session):

tests/test_window.py

@@ -6,6 +6,7 @@
 import pytest
 
 from libtmux import Pane, Server, Window, exc
+from libtmux.common import has_gte_version
 
 
 logger = logging.getLogger(__name__)
@@ -198,17 +199,38 @@ def test_show_window_option(session):
 def test_show_window_option_unknown(session):
     """Window.show_window_option raises UnknownOption for bad option key."""
     window = session.new_window(window_name='test_window')
+
     with pytest.raises(exc.UnknownOption):
         window.show_window_option('moooz')
 
 
-def test_set_window_option_bad(session):
-    """Window.set_window_option raises ValueError for bad option key."""
+def test_show_window_option_ambiguous(session):
+    """show_window_option raises AmbiguousOption for ambiguous option."""
+    window = session.new_window(window_name='test_window')
+
+    with pytest.raises(exc.AmbiguousOption):
+        window.show_window_option('clock-mode')
 
+
+def test_set_window_option_ambiguous(session):
+    """set_window_option raises AmbiguousOption for ambiguous option."""
     window = session.new_window(window_name='test_window')
 
-    with pytest.raises(exc.UnknownOption):
-        window.set_window_option('afewewfew', 43)
+    with pytest.raises(exc.AmbiguousOption):
+        window.set_window_option('clock-mode', 12)
+
+
+def test_set_window_option_invalid(session):
+    """Window.set_window_option raises ValueError for invalid option key."""
+
+    window = session.new_window(window_name='test_window')
+
+    if has_gte_version('2.4'):
+        with pytest.raises(exc.InvalidOption):
+            window.set_window_option('afewewfew', 43)
+    else:
+        with pytest.raises(exc.UnknownOption):
+            window.set_window_option('afewewfew', 43)
 
 
 def test_move_window(session):