Internals

Warning

Be careful with these! Internal APIs are not covered by version policies. They can break or be removed between minor versions!

If you need an internal API stabilized please file an issue.

• Dataclass helpers - libtmux._internal.dataclasses
  • SkipDefaultFieldsReprMixin
    • __repr__()
    • __weakref__
• List querying - libtmux._internal.query_list
  • MultipleObjectsReturned
  • ObjectDoesNotExist
  • keygetter()
  • parse_lookup()
  • PKRequiredException
    • __init__()
  • OpNotFound
    • __init__()
  • QueryList
    • __init__()
    • filter()
    • get()
• Waiters - libtmux._internal.waiter
  • Key Features
  • Basic Concepts
  • Quick Start Examples
    • Simple Waiting
    • Advanced Matching
    • Timeout Handling
    • Waiting for Shell Readiness
  • Fluent API (Playwright-inspired)
  • Multiple Conditions
  • Implementation Notes
    • Error Handling
    • Type Safety
    • Example Usage in Documentation
  • API Reference
    • ContentMatchType
      • EXACT
      • CONTAINS
      • REGEX
      • PREDICATE
    • WaitResult
      • success
      • content
      • matched_content
      • match_line
      • elapsed_time
      • error
      • matched_pattern_index
      • success
      • content
      • matched_content
      • match_line
      • elapsed_time
      • error
      • matched_pattern_index
      • __init__()
    • PaneContentWaiter
      • __init__()
      • with_timeout()
      • with_interval()
      • without_raising()
      • with_line_range()
      • wait_for_text()
      • wait_for_exact_text()
      • wait_for_regex()
      • wait_for_predicate()
      • wait_until_ready()
    • expect()
    • wait_for_pane_content()
    • wait_until_pane_ready()
    • wait_for_server_condition()
    • wait_for_session_condition()
    • wait_for_window_condition()
    • wait_for_window_panes()
    • wait_for_any_content()
    • wait_for_all_content()
  • Extended Retry Functionality

Environmental variables

tmux format separator

Added in version 0.11.0b0.

LIBTMUX_TMUX_FORMAT_SEPARATOR can be used to override the default string used to split tmux(1)’s formatting information.

If you find any compatibility problems with the default, or better yet find a string copacetic many environments and tmux releases, note it at https://github.com/tmux-python/libtmux/discussions/355.