tmux-python / libtmux Goto Github PK

Python 3.6.1 (default, Aug 23 2017, 20:07:59) 
[GCC 5.4.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import libtmux
>>> server = libtmux.Server()
>>> server.new_session(session_name="pa")
Session($0 pa)
>>> session = server.find_where({"session_name":"pa"})
>>> session
Session($0 pa)
>>> session.new_window(window_name="telegram")
Window(@1 1:telegram, Session($0 pa))
>>> window = session.find_where({"window_name":"telegram"})
>>> window
>>> window is None
True

>>> session.windows[1].rename_window("telegram")
Window(@1 1:telegram, Session($0 pa))
>>> session.find_where({"window_name":"telegram"})
Window(@1 1:telegram, Session($0 pa))

>>> window=session.new_window(); window.rename_window("test")
Window(@2 2:aragaer@netbook:~/Projects/pa/router, Session($0 pa))
>>> session.find_where({"window_name":"test"})

/usr/bin/tmux new-window -P -c/home/aragaer/Projects/pa/tg -F"#{session_name}#{session_id}#{window_id}#{window_name}#{window_width}#{window_height}#{window_layout}#{window_panes}#{window_index}#{window_flags}#{window_active}#{window_bell_flag}#{window_activity_flag}#{window_silence_flag}" -ntelegram -t$0:
can't find session bash

In [20]: import libtmux

In [21]: server = libtmux.Server()

In [22]: server.attached_sessions
---------------------------------------------------------------------------
AttributeError                            Traceback (most recent call last)
<ipython-input-22-aee9c49879f2> in <module>()
----> 1 server.attached_sessions

/dccstor/faceid/code/anaconda3/x86_64/envs/mxnet/lib/python2.7/site-packages/libtmux/server.pyc in attached_sessions(self)
    336             if 'session_attached' in session:
    337                 # for now session_active is a unicode
--> 338                 if session.attached == '1':
    339                     logger.debug('session %s attached', session.name)
    340                     attached_sessions.append(session)

AttributeError: 'dict' object has no attribute 'attached'

tmux new-session -d -s cool_session
tmux new-window -t cool_session -n fun_window "echo kills fun_window after 5s && sleep 5"

>>> import libtmux; s = libtmux.Server(); s.children[0].children[0].children[1].cmd("capture-pane", '-p', '-J', '-e', '-E-', '-S-').stdout 
<omitted command noise>
DEBUG: ['/etc/profiles/per-user/myuser/bin/tmux', 'capture-pane', '-t', '%4', '-p', '-J', '-e', '-E-', '-S-']
<no output till ^C>

$ tmux list-panes -t 0:
0: [135x17] [history 1952/2000, 939964 bytes] %0
1: [135x17] [history 928/2000, 431099 bytes] %4
2: [135x21] [history 1869/2000, 1194568 bytes] %5
3: [135x21] [history 0/2000, 0 bytes] %7
4: [271x13] [history 1816/2000, 269415 bytes] %1 (active)
5: [271x12] [history 6/2000, 1537 bytes] %132

user@host$
user@host$

>>> import libtmux
>>> pane = libtmux.Server().get_by_id('$1').attached_pane
>>> pane
Pane(%5 Window(@4 2:a, Session($1 foo)))
>>> pane.send_keys('Enter')

user@host$  Enter
Enter: command not found

find . -iname '*.py' | grep -v example | xargs -P4 -I{} python3.8 -Wall -m py_compile {}
./libtmux/pane.py:156: DeprecationWarning: invalid escape sequence \;
  self.cmd('send-keys', '-R \; clear-history')
./libtmux/common.py:236: DeprecationWarning: invalid escape sequence \_
  """Base: :py:class:`collections.MutableMapping`.

#!/usr/bin/env python3
# coding=utf-8
# author: thinkycx
# date: 2018-01-11
# Usage:
#    run several commands in tmux panel, every window have 4 panes
#    $ pip3 install libtmux
#    $ python tmux.py


import libtmux
import math
import os
import logging

def create_session(session_name, commands):
    '''
        create session with 2*2 panes and run commands
    :param session_name: tmux session name
    :param commands: bash commands
    :return:
    '''
    logging.info(commands)
    # pane_NUM = 3
    # WINDOW_NUM = int(math.ceil(len(commands)/4.0))  # in python3, we can use 4 also

    server = libtmux.Server()
    session = server.new_session(session_name)

    # create windows
    windows = []
    panes = []

    for i in range(len(commands)):
        # create window to store 4 panes
        if i % 4 == 0:
            win = session.new_window(attach=False, window_name="win"+str(int(i/4)))
            windows.append(win)

            # tmux_args = ('-h',)
            win.cmd('split-window', '-h')
            win.cmd('split-window', '-f')
            win.cmd('split-window', '-h')

            panes.extend(win.list_panes())

        panes[i].send_keys(commands[i])

    logging.info(panes)
    logging.info(windows)


if __name__ == '__main__':
    commands = []
    for i in range(10):
        commands.append("echo " + str(i))

    os.system("tmux kill-session -t session")
    create_session("session", commands)

# Reach tmux_cmd() with args and kwargs
> /usr/local/var/pyenv/versions/2.7.11/lib/python2.7/site-packages/libtmux/server.py(99)cmd()
     97                 raise ValueError('Server.colors must equal 88 or 256')
     98
---> 99         return tmux_cmd(*args, **kwargs)
    100
    101     def _list_sessions(self):

ipdb> args
self = <libtmux.server.Server object at 0x10fd11350>
args = [u'-2', 'set-environment', 'FOO', 'bar']
kwargs = {u'-t': u'$8'}

# Reach cmd and kwargs not included
ipdb>
> /usr/local/var/pyenv/versions/2.7.11/lib/python2.7/site-packages/libtmux/common.py(179)__init__()
    177         cmd = [str(c) for c in cmd]
    178
--> 179         self.cmd = cmd
    180
    181         try:

ipdb> cmd
['/usr/local/bin/tmux', '-2', 'set-environment', 'FOO', 'bar']

 This section contains a list of the commands supported by tmux.  Most
 commands accept the optional -t argument with one of target-client,
 target-session target-window, or target-pane.  These specify the
 client, session, window or pane which a command should affect.
 target-client is the name of the pty(7) file to which the client is
 connected, for example either of /dev/ttyp1 or ttyp1 for the client
 attached to /dev/ttyp1.  If no client is specified, the current client
 is chosen, if possible, or an error is reported.  Clients may be listed
 with the list-clients command.

 target-session is the session id prefixed with a $, the name of a ses‐
 sion (as listed by the list-sessions command), or the name of a client
 with the same syntax as target-client, in which case the session
 attached to the client is used.  When looking for the session name,
 tmux initially searches for an exact match; if none is found, the ses‐
 sion names are checked for any for which target-session is a prefix or
 for which it matches as an fnmatch(3) pattern.  If a single match is
 found, it is used as the target session; multiple matches produce an
 error.  If a session is omitted, the current session is used if avail‐
 able; if no current session is available, the most recently used is
 chosen.

 target-window specifies a window in the form session:window.  session
 follows the same rules as for target-session, and window is looked for
 in order: as a window index, for example mysession:1; as a window ID,
 such as @1; as an exact window name, such as mysession:mywindow; then
 as an fnmatch(3) pattern or the start of a window name, such as myses‐
 sion:mywin* or mysession:mywin.  An empty window name specifies the
 next unused index if appropriate (for example the new-window and
 link-window commands) otherwise the current window in session is cho‐
 sen.  The special character ‘!’ uses the last (previously current) win‐
 dow, ‘^’ selects the highest numbered window, ‘$’ selects the lowest
 numbered window, and ‘+’ and ‘-’ select the next window or the previous
 window by number.  When the argument does not contain a colon, tmux
 first attempts to parse it as window; if that fails, an attempt is made
 to match a session.

 target-pane takes a similar form to target-window but with the optional
 addition of a period followed by a pane index, for example: myses‐
 sion:mywindow.1.  If the pane index is omitted, the currently active
 pane in the specified window is used.  If neither a colon nor period
 appears, tmux first attempts to use the argument as a pane index; if
 that fails, it is looked up as for target-window.  A ‘+’, ‘-’ or ‘!’
 indicate the next, previous or last pane.  One of the strings top,
 bottom, left, right, top-left, top-right, bottom-left or bottom-right
 may be used instead of a pane index.

 The special characters ‘+’ and ‘-’ may be followed by an offset, for
 example:

       select-window -t:+2

 When dealing with a session that doesn't contain sequential window
 indexes, they will be correctly skipped.

>>> import libtmux
>>> libtmux.__version__
'0.8.2'
>>> tmux = libtmux.Server()
>>> tmux.find_where({'session_name': '0'}).find_where({'window_name': 'python'}).attached_pane
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/maienm/.asdf/installs/python/utils/lib/python3.8/site-packages/libtmux/window.py", line 490, in attached_pane
    for pane in self._panes:
  File "/home/maienm/.asdf/installs/python/utils/lib/python3.8/site-packages/libtmux/window.py", line 514, in _panes
    return self._list_panes()
  File "/home/maienm/.asdf/installs/python/utils/lib/python3.8/site-packages/libtmux/window.py", line 506, in _list_panes
    panes = [p for p in panes if p['session_id'] == self.get('session_id')]
  File "/home/maienm/.asdf/installs/python/utils/lib/python3.8/site-packages/libtmux/window.py", line 506, in <listcomp>
    panes = [p for p in panes if p['session_id'] == self.get('session_id')]
KeyError: 'session_id'
>>> tmux._update_panes()._panes
[{'session_name': '0', 'session_id': '$0', 'window_index': '1', 'window_id': '@0', 'window_name': 'python', 'history_size': '137', 'history_limit': '100000', 'history_bytes': '100636', 'pane_index': '1', 'pane_width': '240', 'pane_height': '66', 'pane_title': 'HOSTNAME', 'pane_id': '%0', 'pane_active': '1', 'pane_dead': '0', 'pane_in_mode': '0', 'pane_synchronized': '0', 'pane_tty': '/dev/pts/41', 'pane_pid': '337481', 'pane_current_path': '/home/maienm', 'pane_current_command': 'python', 'cursor_x': '0', 'cursor_y': '65', 'scroll_region_upper': '0', 'scroll_region_lower': '65', 'alternate_on': '0', 'alternate_saved_x': '0', 'alternate_saved_y': '0', 'cursor_flag': '1', 'insert_flag': '0', 'keypad_cursor_flag': '0', 'keypad_flag': '0', 'wrap_flag': '1', 'mouse_standard_flag': '0', 'mouse_button_flag': '0', 'mouse_any_flag': '0'}, {'session_name': '0', 'session_id': '$0', 'window_index': '2', 'window_id': '@2', 'window_name': 'zsh', 'history_size': '0', 'history_limit': '100000', 'history_bytes': '0', 'pane_index': '1', 'pane_width': '240', 'pane_height': '66', 'pane_title': 'HOSTNAME', 'pane_id': '%2', 'pane_active': '1', 'pane_dead': '0', 'pane_in_mode': '0', 'pane_synchronized': '0', 'pane_tty': '/dev/pts/42', 'pane_pid': '338918', 'pane_start_command': 'echo foo'}, {'session_name': 'read', 'window_index': '/home/maienm', 'window_id': 'zsh', 'window_name': '0', 'history_size': '1', 'history_limit': '0', 'history_bytes': '65', 'pane_height': '0', 'pane_title': '0', 'pane_id': '0', 'pane_active': '1', 'pane_dead': '0', 'pane_in_mode': '0', 'pane_synchronized': '0', 'pane_tty': '1', 'pane_pid': '0', 'pane_start_command': '0', 'pane_start_path': '0', 'pane_current_path': ''}]

[{'session_name': '0', 'session_id': '$0', 'window_index': '1', 'window_id': '@0', 'window_name': 'python', 'history_size': '3', 'history_limit': '100000', 'history_bytes': '2832', 'pane_index': '1', 'pane_width': '240', 'pane_height': '66', 'pane_title': 'HOSTNAME', 'pane_id': '%0', 'pane_active': '1', 'pane_dead': '0', 'pane_in_mode': '0', 'pane_synchronized': '0', 'pane_tty': '/dev/pts/41', 'pane_pid': '18834', 'pane_current_path': '/home/maienm/foo'}, {'session_name': 'bar', 'session_id': 'python', 'window_index': '0', 'window_id': '10', 'window_name': '0', 'history_size': '65', 'pane_index': '0', 'pane_width': '0', 'pane_height': '0', 'pane_title': '1', 'pane_id': '0', 'pane_active': '0', 'pane_dead': '0', 'pane_in_mode': '1', 'pane_synchronized': '0', 'pane_tty': '0', 'pane_pid': '0'}]

  File "/home/gabriel/.local/lib/python3.5/site-packages/libtmux/server.py", line 426, in new_session
    if self.has_session(session_name):
  File "/home/gabriel/.local/lib/python3.5/site-packages/libtmux/server.py", line 326, in has_session
    proc = self.cmd('has-session', '-t%s' % target_session)
  File "/home/gabriel/.local/lib/python3.5/site-packages/libtmux/server.py", line 100, in cmd
    return tmux_cmd(*args, **kwargs)
  File "/home/gabriel/.local/lib/python3.5/site-packages/libtmux/common.py", line 153, in __init__
    cmd = [which('tmux')]
  File "/home/gabriel/.local/lib/python3.5/site-packages/libtmux/common.py", line 398, in which
    logger.trace(
AttributeError: 'Logger' object has no attribute 'trace'

import libtmux
import pytest


@pytest.fixture
def server():
    server = libtmux.Server()
    return server


def test_can_start_tmux_session(server):
    server.new_session("test")
    assert server.has_session("test")
    server.kill_session("test")

FROM ubuntu:18.04

RUN apt-get update && apt install -y tmux python-pip
RUN pip install libtmux pytest

COPY test_tmux.py .
RUN pytest test_tmux.py

        if 'session_id' not in kwargs:
>           raise ValueError('Session requires a `session_id`')
E           ValueError: Session requires a `session_id`

def test_show_option_unknown(session):
    """Session.show_option raises UnknownOption for invalid option."""
    with pytest.raises(exc.UnknownOption):
        session.show_option('moooz')

if does_window_contain_pane(window-number) == False:
    tmux kill-window -t window-number
if session_contains_windows(sesh) == False:
    tmux kill-session -t sesh

import libtmux as tmux
t       = tmux.Server()
sess    = t.new_session('uut')
win0    = sess.select_window(0)

bash-4.4$ cat test.py
import libtmux

tmux_session_name = 'test'

server = libtmux.Server()
session = server.new_session(tmux_session_name)
window = session.attached_window
pane = window.split_window(shell='PROMPT_COMMAND= bash --norc --noprofile')
pane.send_keys('cowsay hello')
print('\n'.join(pane.cmd('capture-pane', '-p').stdout))
bash-4.4$ 
bash-4.4$ python test.py
bash-4.4$  cowsay hello
bash-4.4$ 
bash-4.4$ pkill tmux
bash-4.4$ 
bash-4.4$ python
Python 2.7.15rc1 (default, Nov 12 2018, 14:31:15) 
[GCC 7.3.0] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import libtmux
>>> tmux_session_name = 'test'
>>> server = libtmux.Server()
>>> session = server.new_session(tmux_session_name)
>>> window = session.attached_window
>>> pane = window.split_window(shell='PROMPT_COMMAND= bash --norc --noprofile')
>>> pane.send_keys('cowsay hello')
>>> print('\n'.join(pane.cmd('capture-pane', '-p').stdout))
bash-4.4$  cowsay hello
 _______
< hello >
 -------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||
bash-4.4$
>>> 
bash-4.4$ 

  import libtmux
  File "env/lib/python3.8/site-packages/libtmux/__init__.py", line 16, in <module>
    from .pane import Pane
  File "env/lib/python3.8/site-packages/libtmux/pane.py", line 13, in <module>
    from .common import TmuxMappingObject, TmuxRelationalObject
  File "env/lib/python3.8/site-packages/libtmux/common.py", line 221, in <module>
    class TmuxMappingObject(collections.MutableMapping):
  File "/usr/lib/python3.8/collections/__init__.py", line 49, in __getattr__
    warnings.warn("Using or importing the ABCs from 'collections' instead "
DeprecationWarning: Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated since Python 3.3, and in 3.9 it will stop working