Obj
Dataclass of generic tmux object.
Source and package
- Qualified name
-
libtmux.neo .Obj - Module
- libtmux.neo
- Package
- libtmux
- Source
- src/libtmux/neo.py
-
Description#
Notes
tmux may return fields from an object's active children along with the object itself. The practical consequence:
- On a
Sessionrow (list-sessions), everypane_*andwindow_*field resolves to the session's current window's active pane — not "the session's pane" (no such thing).session.active_window.window_idandsession.active_window.active_pane.pane_idare the canonical accessors for the same values. - On a
Windowrow (list-windows), everypane_*field resolves to that window's active pane. - On a
Clientrow (list-clients), everysession_*,window_*, andpane_*field reflects the client's attached session, current window, and active pane.
A reader who treats
session.pane_idas the literal session's pane id (rather than "active pane of this session's current window") will be surprised when the active window changes.Discussed in Architecture
- On a
Members180#
- active_window_index: str | None attribute
- alternate_saved_x: str | None attribute
- alternate_saved_y: str | None attribute
- bracket_paste_flag: str | None attribute
- buffer_name: str | None attribute
- buffer_sample: str | None attribute
- buffer_size: str | None attribute
- client_activity: str | None attribute
- client_cell_height: str | None attribute
- client_cell_width: str | None attribute
- client_control_mode: str | None attribute
- client_created: str | None attribute
- client_discarded: str | None attribute
- client_flags: str | None attribute
- client_height: str | None attribute
- client_key_table: str | None attribute
- client_last_session: str | None attribute
- client_mode_format: str | None attribute
- client_name: str | None attribute
- client_pid: str | None attribute
- client_prefix: str | None attribute
- client_readonly: str | None attribute
- client_session: str | None attribute
- client_termfeatures: str | None attribute
- client_termname: str | None attribute
- client_termtype: str | None attribute
- client_tty: str | None attribute
- client_uid: str | None attribute
- client_user: str | None attribute
- client_utf8: str | None attribute
- client_width: str | None attribute
- client_written: str | None attribute
- command_list_alias: str | None attribute
- command_list_name: str | None attribute
- command_list_usage: str | None attribute
- config_files: str | None attribute
- copy_cursor_line: str | None attribute
- copy_cursor_word: str | None attribute
- copy_cursor_x: str | None attribute
- copy_cursor_y: str | None attribute
- current_file: str | None attribute
- cursor_character: str | None attribute
- cursor_flag: str | None attribute
- cursor_x: str | None attribute
- cursor_y: str | None attribute
- history_bytes: str | None attribute
- history_limit: str | None attribute
- history_size: str | None attribute
- insert_flag: str | None attribute
- keypad_cursor_flag: str | None attribute
- keypad_flag: str | None attribute
- last_window_index: str | None attribute
- line: str | None attribute
- mouse_all_flag: str | None attribute
- mouse_any_flag: str | None attribute
- mouse_button_flag: str | None attribute
- mouse_sgr_flag: str | None attribute
- mouse_standard_flag: str | None attribute
- next_session_id: str | None attribute
- origin_flag: str | None attribute
- pane_active: str | None attribute
- pane_at_bottom: str | None attribute
- pane_at_left: str | None attribute
- pane_at_right: str | None attribute
- pane_at_top: str | None attribute
- pane_bg: str | None attribute
- pane_bottom: str | None attribute
- pane_current_command: str | None attribute
- pane_current_path: str | None attribute
- pane_dead: str | None attribute
- pane_dead_signal: str | None attribute
- pane_dead_status: str | None attribute
- pane_dead_time: str | None attribute
- pane_fg: str | None attribute
- pane_flags: str | None attribute
- pane_floating_flag: str | None attribute
- pane_format: str | None attribute
- pane_height: str | None attribute
- pane_id: str | None attribute
- pane_in_mode: str | None attribute
- pane_index: str | None attribute
- pane_input_off: str | None attribute
- pane_last: str | None attribute
- pane_left: str | None attribute
- pane_marked: str | None attribute
- pane_marked_set: str | None attribute
- pane_mode: str | None attribute
- pane_path: str | None attribute
- pane_pb_progress: str | None attribute
- pane_pb_state: str | None attribute
- pane_pid: str | None attribute
- pane_pipe: str | None attribute
- pane_pipe_pid: str | None attribute
- pane_right: str | None attribute
- pane_search_string: str | None attribute
- pane_start_command: str | None attribute
- pane_start_path: str | None attribute
- pane_synchronized: str | None attribute
- pane_tabs: str | None attribute
- pane_title: str | None attribute
- pane_top: str | None attribute
- pane_tty: str | None attribute
- pane_width: str | None attribute
- pane_x: str | None attribute
- pane_y: str | None attribute
- pane_z: str | None attribute
- pane_zoomed_flag: str | None attribute
- pid: str | None attribute
- scroll_position: str | None attribute
- scroll_region_lower: str | None attribute
- scroll_region_upper: str | None attribute
- search_match: str | None attribute
- selection_end_x: str | None attribute
- selection_end_y: str | None attribute
- selection_start_x: str | None attribute
- selection_start_y: str | None attribute
- server: Server attribute
- session_activity: str | None attribute
- session_alerts: str | None attribute
- session_attached: str | None attribute
- session_attached_list: str | None attribute
- session_created: str | None attribute
- session_format: str | None attribute
- session_group: str | None attribute
- session_group_attached: str | None attribute
- session_group_attached_list: str | None attribute
- session_group_list: str | None attribute
- session_group_many_attached: str | None attribute
- session_group_size: str | None attribute
- session_grouped: str | None attribute
- session_id: str | None attribute
- session_last_attached: str | None attribute
- session_many_attached: str | None attribute
- session_marked: str | None attribute
- session_name: str | None attribute
- session_path: str | None attribute
- session_stack: str | None attribute
- session_windows: str | None attribute
- socket_path: str | None attribute
- start_time: str | None attribute
- synchronized_output_flag: str | None attribute
- uid: str | None attribute
- user: str | None attribute
- version: str | None attribute
- window_active: str | None attribute
- window_active_clients: str | None attribute
- window_active_clients_list: str | None attribute
- window_active_sessions: str | None attribute
- window_active_sessions_list: str | None attribute
- window_activity: str | None attribute
- window_activity_flag: str | None attribute
- window_bell_flag: str | None attribute
- window_bigger: str | None attribute
- window_cell_height: str | None attribute
- window_cell_width: str | None attribute
- window_end_flag: str | None attribute
- window_flags: str | None attribute
- window_format: str | None attribute
- window_height: str | None attribute
- window_id: str | None attribute
- window_index: str | None attribute
- window_last_flag: str | None attribute
- window_layout: str | None attribute
- window_linked: str | None attribute
- window_linked_sessions: str | None attribute
- window_linked_sessions_list: str | None attribute
- window_marked_flag: str | None attribute
- window_name: str | None attribute
- window_offset_x: str | None attribute
- window_offset_y: str | None attribute
- window_panes: str | None attribute
- window_raw_flags: str | None attribute
- window_silence_flag: str | None attribute
- window_stack_index: str | None attribute
- window_start_flag: str | None attribute
- window_visible_layout: str | None attribute
- window_width: str | None attribute
- window_zoomed_flag: str | None attribute
- wrap_flag: str | None attribute
- _refresh method Refresh dataclass fields from a single
list-*row.