iterm2 package

Submodules

iterm2.hierarchy module

class iterm2.hierarchy.Hierarchy[source]

Bases: object

create_window(profile=None, command=None)[source]
get_windows()[source]
parse(response)[source]
pretty_str()[source]
class iterm2.hierarchy.Synchronizer[source]

Bases: object

get()[source]

iterm2.notifications module

class iterm2.notifications.KeystrokeSubscription(session_id, handler)[source]

Bases: iterm2.notifications.Subscription

class iterm2.notifications.LayoutChangeSubscription(handler)[source]

Bases: iterm2.notifications.Subscription

class iterm2.notifications.NewSessionSubscription(handler)[source]

Bases: iterm2.notifications.Subscription

class iterm2.notifications.Subscription(notification_type, session_id, handler)[source]

Bases: object

handle(notification)[source]
unsubscribe()[source]
class iterm2.notifications.TerminateSessionSubscription(handler)[source]

Bases: iterm2.notifications.Subscription

iterm2.notifications.quick_wait()[source]
iterm2.notifications.wait(timeout=None)[source]

iterm2.session module

class iterm2.session.AbstractSession[source]

Bases: object

get_session_id()[source]
pretty_str(indent='')[source]
class iterm2.session.FutureSession(future)[source]

Bases: iterm2.session.AbstractSession

get_session_id()[source]
send_text(text)[source]
split_pane(vertical=False, before=False, profile=None)[source]
class iterm2.session.Session(session_id=None)[source]

Bases: iterm2.session.AbstractSession

get_session_id()[source]
read_keystroke()[source]

Blocks until a keystroke is received. Returns a KeystrokeNotification.

send_text(text)[source]
split_pane(vertical=False, before=False, profile=None)[source]
class iterm2.session.TextSender(future)[source]

Bases: object

get_status()[source]
parse(response)[source]

iterm2.tab module

class iterm2.tab.AbstractTab[source]

Bases: object

get_sessions()[source]
get_tab_id()[source]
pretty_str(indent='')[source]
class iterm2.tab.FutureTab(future)[source]

Bases: iterm2.tab.AbstractTab

get_sessions()[source]
get_status()[source]
get_tab_id()[source]
class iterm2.tab.Tab(tab_id, sessions)[source]

Bases: iterm2.tab.AbstractTab

get_sessions()[source]
get_tab_id()[source]

iterm2.window module

class iterm2.window.AbstractWindow[source]

Bases: object

create_tab(profile=None, command=None, index=None)[source]
get_status()[source]
get_tabs()[source]
get_window_id()[source]
pretty_str(indent='')[source]
class iterm2.window.FutureWindow(future)[source]

Bases: iterm2.window.AbstractWindow

create_tab(profile=None, command=None, index=None)[source]
get_status()[source]
get_tabs()[source]
get_window_id()[source]
class iterm2.window.Window(window_id, tabs)[source]

Bases: iterm2.window.AbstractWindow

create_tab(profile=None, command=None, index=None)[source]
get_tabs()[source]
get_window_id()[source]

Module contents

iterm2.run(function)[source]