convert libtmux.window to numpy docs

Author: tony

libtmux/window.py

@@ -100,11 +100,15 @@ def cmd(self, cmd, *args, **kwargs):
         Specifying ``('-t', 'custom-target')`` or ``('-tcustom_target')`` in
         ``args`` will override using the object's ``window_id`` as target.
 
-        :rtype: :class:`Server.cmd`
+        Returns
+        -------
+        :class:`Server.cmd`
 
+        Notes
+        -----
         .. versionchanged:: 0.8
-            Renamed from ``.tmux`` to ``.cmd``.
 
+            Renamed from ``.tmux`` to ``.cmd``.
         """
         if not any(arg.startswith('-t') for arg in args):
             args = ('-t', self.id) + args
@@ -114,29 +118,31 @@ def cmd(self, cmd, *args, **kwargs):
     def select_layout(self, layout=None):
         """Wrapper for ``$ tmux select-layout <layout>``.
 
-        even-horizontal: Panes are spread out evenly from left to right across
-        the window.
-
-        even-vertical: Panes are spread evenly from top to bottom.
-
-        main-horizontal: A large (main) pane is shown at the top of the window
-        and the remaining panes are spread from left to right in the leftover
-        space at the bottom.
-
-        main-vertical: Similar to main-horizontal but the large pane is placed
-        on the left and the others spread from top to bottom along the right.
-
-        tiled: Panes are spread out as evenly as possible over the window in
-        both rows and columns.
-
-        custom: custom dimensions (see :term:`tmux(1)` manpages).
-
-        :param layout: string of the layout, 'even-horizontal', 'tiled', etc.
-           Entering None (leaving this blank) is same as ``select-layout``
-           with no layout. In recent tmux versions, it picks the most recently
-           set layout.
-        :type layout: str
-
+        Parameters
+        ----------
+        layout : str, optional
+            string of the layout, 'even-horizontal', 'tiled', etc. Entering
+            None (leaving this blank) is same as ``select-layout`` with no
+            layout. In recent tmux versions, it picks the most recently
+            set layout.
+
+            'even-horizontal'
+                Panes are spread out evenly from left to right across the
+                window.
+            'even-vertical'
+                Panes are spread evenly from top to bottom.
+            'main-horizontal'
+                A large (main) pane is shown at the top of the window and the
+                remaining panes are spread from left to right in the leftover
+                space at the bottom.
+            'main-vertical'
+                Similar to main-horizontal but the large pane is placed on the
+                left and the others spread from top to bottom along the right.
+            'tiled'
+                Panes are spread out as evenly as possible over the window in
+                both rows and columns.
+            'custom'
+                custom dimensions (see :term:`tmux(1)` manpages).
         """
         cmd = [
             'select-layout',
@@ -152,15 +158,21 @@ def select_layout(self, layout=None):
             raise exc.LibTmuxException(proc.stderr)
 
     def set_window_option(self, option, value):
-        """Wrapper for ``$ tmux set-window-option <option> <value>``.
-
-        :param option: option to set, e.g. 'aggressive-resize'
-        :type option: str
-        :param value: window value. True/False will turn in 'on' and 'off',
+        """
+        Wrapper for ``$ tmux set-window-option <option> <value>``.
+
+        Parameters
+        ----------
+        option : str
+            option to set, e.g. 'aggressive-resize'
+        value : str
+            window option value. True/False will turn in 'on' and 'off',
             also accepts string of 'on' or 'off' directly.
-        :type value: bool
-        :raises: :exc:`exc.OptionError`, :exc:`exc.UnknownOption`,
-            :exc:`exc.InvalidOption`, :exc:`exc.AmbiguousOption`
+
+        Raises
+        ------
+        :exc:`exc.OptionError`, :exc:`exc.UnknownOption`,
+        :exc:`exc.InvalidOption`, :exc:`exc.AmbiguousOption`
         """
 
         self.server._update_windows()
@@ -181,17 +193,22 @@ def set_window_option(self, option, value):
             handle_option_error(cmd.stderr[0])
 
     def show_window_options(self, option=None, g=False):
-        """Return a dict of options for the window.
+        """
+        Return a dict of options for the window.
 
-        For familiarity with tmux, the option ``option`` param forwards to pick
-        a single option, forwarding to :meth:`Window.show_window_option`.
+        For familiarity with tmux, the option ``option`` param forwards to
+        pick a single option, forwarding to :meth:`Window.show_window_option`.
 
-        :param option: optional. show a single option.
-        :type option: str
-        :param g: Pass ``-g`` flag for global variable
-        :type g: bool
-        :rtype: :py:obj:`dict`
+        Parameters
+        ----------
+        option : str, optional
+            show a single option.
+        g : str, optional
+            Pass ``-g`` flag for global variable, default False.
 
+        Returns
+        -------
+        dict
         """
 
         tmux_args = tuple()
@@ -221,18 +238,25 @@ def show_window_options(self, option=None, g=False):
         return window_options
 
     def show_window_option(self, option, g=False):
-        """Return a list of options for the window.
+        """
+        Return a list of options for the window.
 
         todo: test and return True/False for on/off string
 
-        :param option: option to return.
-        :type option: str
-        :param g: Pass ``-g`` flag, global.
-        :type g: bool
-        :rtype: str, int
-        :raises: :exc:`exc.OptionError`, :exc:`exc.UnknownOption`,
-            :exc:`exc.InvalidOption`, :exc:`exc.AmbiguousOption`
+        Parameters
+        ----------
+        option : str
+        g : bool, optional
+            Pass ``-g`` flag, global. Default False.
 
+        Returns
+        -------
+        str, int
+
+        Raises
+        ------
+        :exc:`exc.OptionError`, :exc:`exc.UnknownOption`,
+        :exc:`exc.InvalidOption`, :exc:`exc.AmbiguousOption`
         """
 
         tmux_args = tuple()
@@ -260,11 +284,13 @@ def show_window_option(self, option, g=False):
         return option[1]
 
     def rename_window(self, new_name):
-        """Return :class:`Window` object ``$ tmux rename-window <new_name>``.
-
-        :param new_name: name of the window
-        :type new_name: str
+        """
+        Return :class:`Window` object ``$ tmux rename-window <new_name>``.
 
+        Parameters
+        ----------
+        new_name : str
+            name of the window
         """
 
         import shlex
@@ -300,15 +326,17 @@ def kill_window(self):
         self.server._update_windows()
 
     def move_window(self, destination="", session=None):
-        """Move the current :class:`Window` object ``$ tmux move-window``.
-
-        :param destination: the ``target window`` or index to move the window
-            to, default: empty string
-        :type destination: str
-        :param session: the ``target session`` or index to move the
-            window to, default: current session.
-        :type session: str
-
+        """
+        Move the current :class:`Window` object ``$ tmux move-window``.
+
+        Parameters
+        ----------
+        destination : str, optional
+            the ``target window`` or index to move the window to, default:
+            empty string
+        session : str, optional
+            the ``target session`` or index to move the window to, default:
+            current session.
         """
         session = session or self.get('session_id')
         proc = self.cmd(
@@ -323,26 +351,32 @@ def move_window(self, destination="", session=None):
         self.server._update_windows()
 
     def select_window(self):
-        """Select window. Return ``self``.
+        """
+        Select window. Return ``self``.
 
         To select a window object asynchrously. If a ``window`` object exists
         and is no longer longer the current window, ``w.select_window()``
         will make ``w`` the current window.
 
-        :rtype: :class:`Window`
-
+        Returns
+        -------
+        :class:`Window`
         """
         target = '%s:%s' % (self.get('session_id'), self.index),
         return self.session.select_window(target)
 
     def select_pane(self, target_pane):
-        """Return selected :class:`Pane` through ``$ tmux select-pane``.
+        """
+        Return selected :class:`Pane` through ``$ tmux select-pane``.
 
-        :param target_pane: ``target_pane``, or ``-U``,``-D``, ``-L``, ``-R``
-            or ``-l``.
-        :type target_pane: str
-        :rtype: :class:`Pane`
+        Parameters
+        ----------
+        target_pane : str
+            'target_pane', '-U' ,'-D', '-L', '-R', or '-l'.
 
+        Return
+        ------
+        :class:`Pane`
         """
 
         if target_pane in ['-l', '-U', '-D', '-L', '-R']:
@@ -371,43 +405,46 @@ def split_window(
         vertical=True,
         shell=None
     ):
-        """Split window and return the created :class:`Pane`.
-
-        .. note::
-
-            :term:`tmux(1)` will move window to the new pane if the
-            ``split-window`` target is off screen. tmux handles the ``-d`` the
-            same way as ``new-window`` and ``attach`` in
-            :class:`Session.new_window`.
-
-            By default, this will make the window the pane is created in
-            active. To remain on the same window and split the pane in another
-            target window, pass in ``attach=False``.
-
+        """
+        Split window and return the created :class:`Pane`.
 
         Used for splitting window and holding in a python object.
 
-        :param attach: make new window the current window after creating it,
-                       default True.
-        :type attach: bool
-        :param start_directory: specifies the working directory in which the
-            new window is created.
-        :type start_directory: str
-        :param target: ``target_pane`` to split.
-        :type target: bool
-        :param vertical: split vertically
-        :type vertical: bool
-        :param shell: execute a command on splitting the window.  The
-            pane will close when the command exits.
+        Parameters
+        ----------
+        attach : bool, optional
+            make new window the current window after creating it, default
+            True.
+        start_directory : str, optional
+            specifies the working directory in which the new window is created.
+        target : str
+            ``target_pane`` to split.
+        vertical : str
+            split vertically
+        shell : str, optional
+            execute a command on splitting the window.  The pane will close
+            when the command exits.
+
             NOTE: When this command exits the pane will close.  This feature
             is useful for long-running processes where the closing of the
             window upon completion is desired.
-        :type shell: str
 
-        :rtype: :class:`Pane`
+        Returns
+        -------
+        :class:`Pane`
 
-        """
+        Notes
+        -----
 
+        :term:`tmux(1)` will move window to the new pane if the
+        ``split-window`` target is off screen. tmux handles the ``-d`` the
+        same way as ``new-window`` and ``attach`` in
+        :class:`Session.new_window`.
+
+        By default, this will make the window the pane is created in
+        active. To remain on the same window and split the pane in another
+        target window, pass in ``attach=False``.
+        """
         pformats = ['session_name', 'session_id',
                     'window_index', 'window_id'] + formats.PANE_FORMATS
         tmux_formats = ['#{%s}\t' % f for f in pformats]
@@ -465,10 +502,12 @@ def split_window(
 
     @property
     def attached_pane(self):
-        """Return the attached :class:`Pane`.
-
-        :rtype: :class:`Pane`
+        """
+        Return the attached :class:`Pane`.
 
+        Returns
+        -------
+        :class:`Pane`
         """
         for pane in self._panes:
             if 'pane_active' in pane:
@@ -498,10 +537,12 @@ def _panes(self):
         return self._list_panes()
 
     def list_panes(self):
-        """Return list of :class:`Pane` for the window.
-
-        :rtype: list of :class:`Pane`
+        """
+        Return list of :class:`Pane` for the window.
 
+        Returns
+        -------
+        list of :class:`Pane`
         """
 
         return [Pane(window=self, **pane) for pane in self._panes]