/usr/lib/python3/dist-packages/libtmux/pane.py is in python3-libtmux 0.7.7-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 | # -*- coding: utf-8 -*-
"""Pythonization of the :ref:`tmux(1)` pane.
libtmux.pane
~~~~~~~~~~~~
"""
from __future__ import absolute_import, unicode_literals, with_statement
import logging
from . import exc
from .common import TmuxMappingObject, TmuxRelationalObject
logger = logging.getLogger(__name__)
class Pane(TmuxMappingObject, TmuxRelationalObject):
""":term:`tmux(1)` :term:`pane`.
:param window: :class:`Window`
.. versionchanged:: 0.8
Renamed from ``.tmux`` to ``.cmd``.
"""
#: namespace used :class:`~libtmux.common.TmuxMappingObject`
formatter_prefix = 'pane_'
def __init__(self, window=None, **kwargs):
if not window:
raise ValueError('Pane must have ``Window`` object')
self.window = window
self.session = self.window.session
self.server = self.session.server
self._pane_id = kwargs['pane_id']
self.server._update_panes()
@property
def _info(self, *args):
attrs = {
'pane_id': self._pane_id
}
# from https://github.com/serkanyersen/underscore.py
def by(val, *args):
for key, value in attrs.items():
try:
if attrs[key] != val[key]:
return False
except KeyError:
return False
return True
return list(filter(by, self.server._panes))[0]
def cmd(self, cmd, *args, **kwargs):
"""Return :meth:`Server.cmd` defaulting to ``target_pane`` as target.
Send command to tmux with :attr:`pane_id` as ``target-pane``.
Specifying ``('-t', 'custom-target')`` or ``('-tcustom_target')`` in
``args`` will override using the object's ``pane_id`` as target.
:rtype: :class:`Server.cmd`
"""
if not any(arg.startswith('-t') for arg in args):
args = ('-t', self.get('pane_id')) + args
return self.server.cmd(cmd, *args, **kwargs)
def send_keys(self, cmd, enter=True, suppress_history=True):
"""``$ tmux send-keys`` to the pane.
A leading space character is added to cmd to avoid polluting the
user's history.
:param cmd: Text or input into pane
:type cmd: str
:param enter: Send enter after sending the input.
:type enter: bool
:param suppress_history: Don't add these keys to the shell history
:type suppress_history: bool
"""
prefix = ' ' if suppress_history else ''
self.cmd('send-keys', prefix + cmd)
if enter:
self.enter()
def clear(self):
"""Clear pane."""
self.send_keys('reset')
def reset(self):
"""Reset and clear pane history. """
self.cmd('send-keys', '-R \; clear-history')
def split_window(self, attach=False, vertical=True, start_directory=None):
"""Split window at pane and return newly created :class:`Pane`.
:param attach: Attach / select pane after creation.
:type attach: bool
:param vertical: split vertically
:type vertical: bool
:rtype: :class:`Pane`.
:param start_directory: specifies the working directory in which the
new pane is created.
:type start_directory: str
"""
return self.window.split_window(
target=self.get('pane_id'),
start_directory=start_directory,
attach=attach,
vertical=vertical
)
def set_width(self, width):
"""Set width of pane.
:param width: pane width, in cells.
:type width: int
"""
self.resize_pane(width=width)
def set_height(self, height):
"""Set height of pane.
:param height: pane height, in cells.
:type height: int
"""
self.resize_pane(height=height)
def resize_pane(self, *args, **kwargs):
"""``$ tmux resize-pane`` of pane and return ``self``.
:param target_pane: ``target_pane``, or ``-U``,``-D``, ``-L``, ``-R``.
:type target_pane: str
:rtype: :class:`Pane`
"""
if 'height' in kwargs:
proc = self.cmd('resize-pane', '-y%s' % int(kwargs['height']))
elif 'width' in kwargs:
proc = self.cmd('resize-pane', '-x%s' % int(kwargs['width']))
else:
proc = self.cmd('resize-pane', args[0])
if proc.stderr:
raise exc.LibTmuxException(proc.stderr)
self.server._update_panes()
return self
def enter(self):
"""Send carriage return to pane.
``$ tmux send-keys`` send Enter to the pane.
"""
self.cmd('send-keys', 'Enter')
def select_pane(self):
"""Select pane. Return ``self``.
To select a window object asynchrously. If a ``pane`` object exists
and is no longer longer the current window, ``w.select_pane()``
will make ``p`` the current pane.
:rtype: :class:`pane`
"""
return self.window.select_pane(self.get('pane_id'))
def __repr__(self):
return "%s(%s %s)" % (
self.__class__.__name__,
self.get('pane_id'),
self.window
)
|