pep257, pep8, docstrings

Author: tony

tmuxp/pane.py

@@ -65,7 +65,7 @@ def tmux(self, cmd, *args, **kwargs):
         Specifying ``('-t', 'custom-target')`` or ``('-tcustom_target')`` in
         ``args`` will override using the object's ``pane_id`` as target.
 
-        :rtype: :class:`util.tmux`
+        :rtype: :class:`Server.tmux`
 
         """
         if not len([arg for arg in args if '-t' in arg]):

tmuxp/server.py

@@ -250,7 +250,6 @@ def __list_panes(self):
 
         panes = self.tmux(
             'list-panes',
-            #'-t%s:%s' % (self.get('session_name'), self.get('window_id')),
             '-a',
             '-F%s' % ''.join(tmux_formats),     # output
         )
@@ -340,7 +339,7 @@ def kill_server(self):
         self.tmux('kill-server')
 
     def kill_session(self, target_session=None):
-        """Kill the tmux session with ``$ tmux kill-session``.
+        """Kill the tmux session with ``$ tmux kill-session``, return ``self``.
 
         :param: target_session: str. note this accepts ``fnmatch(3)``. 'asdf'
             will kill 'asdfasd'.

tmuxp/session.py

@@ -64,16 +64,21 @@ def by(val, *args):
             logger.error(self.server._sessions)
 
     def tmux(self, *args, **kwargs):
-        # if '-t' not in kwargs:
-        #    kwargs['-t'] = self.get['session_id']
+        """Return :meth:`Server.tmux`.
+
+        :rtype: :class:`Server.tmux`
+
+        """
+        if '-t' not in kwargs:
+            kwargs['-t'] = self.get('session_id')
         return self.server.tmux(*args, **kwargs)
 
     def attach_session(self, target_session=None):
-        '''
-        ``$ tmux attach-session`` aka alias: ``$ tmux attach``
+        """ Return ``$ tmux attach-session`` aka alias: ``$ tmux attach``.
 
         :param: target_session: str. name of the session. fnmatch(3) works.
-        '''
+
+        """
         proc = self.tmux('attach-session', '-t%s' % self.get('session_id'))
 
         if proc.stderr:

tmuxp/window.py

@@ -23,9 +23,7 @@
 
 class Window(util.TmuxMappingObject, util.TmuxRelationalObject):
 
-    '''
-    ``tmux(1) window``.
-    '''
+    """:ref:`tmux(1)` window."""
 
     childIdAttribute = 'pane_id'
 
@@ -42,14 +40,12 @@ def __init__(self, session=None, **kwargs):
 
         self._window_id = kwargs['window_id']
 
-        #self.server._update_windows()
-
     def __repr__(self):
         return "%s(%s %s:%s, %s)" % (
             self.__class__.__name__,
             self.get('window_id'),
             self.get('window_index'),
-            self.get('window_name'),  # @todo, bug when window name blank
+            self.get('window_name'),
             self.session
         )
 
@@ -73,11 +69,15 @@ def by(val, *args):
         return list(filter(by, self.server._windows))[0]
 
     def tmux(self, cmd, *args, **kwargs):
-        """Send command to tmux with :attr:`window_id` as ``target-window``.
+        """Return :meth:`Server.tmux` defaulting ``target_window`` as target.
+
+        Send command to tmux with :attr:`window_id` as ``target-window``.
 
         Specifying ``('-t', 'custom-target')`` or ``('-tcustom_target')`` in
         ``args`` will override using the object's ``window_id`` as target.
 
+        :rtype: :class:`Server.tmux`
+
         """
         if not len([arg for arg in args if '-t' in str(arg)]):
             args = ('-t', self.get('window_id')) + args