pax_global_header00006660000000000000000000000064147566737560014544gustar00rootroot0000000000000052 comment=52bf7c16b8e8b5a9bdfc0a5c7e5be1996e4ac501 libtmux-0.45.0/000077500000000000000000000000001475667375600133165ustar00rootroot00000000000000libtmux-0.45.0/.codecov.yml000066400000000000000000000003361475667375600155430ustar00rootroot00000000000000codecov: notify: require_ci_to_pass: no coverage: precision: 2 round: down range: "70...100" status: project: default: target: auto threshold: 1% base: auto patch: off libtmux-0.45.0/.cursor/000077500000000000000000000000001475667375600147115ustar00rootroot00000000000000libtmux-0.45.0/.cursor/rules/000077500000000000000000000000001475667375600160435ustar00rootroot00000000000000libtmux-0.45.0/.cursor/rules/dev-loop.mdc000066400000000000000000000007341475667375600202610ustar00rootroot00000000000000--- description: QA every edit globs: *.py --- # First: QA Every edit Run these commands between edits: Check typings: ``` uv run mypy ``` Lint: ``` uv run ruff check . --fix; uv run ruff format .; ``` Check tests: ``` uv run py.test ``` Between every edit, rerun: - Type checks - Lint - Tests If there's any failures *due to the edits*, fix them first, then: # When your edit is complete: Commit it Make an atomic commit for the edit, using conventional commits. libtmux-0.45.0/.cursor/rules/git-commits.mdc000066400000000000000000000042101475667375600207610ustar00rootroot00000000000000--- description: git-commits: Git commit message standards and AI assistance globs: git-commits: Git commit message standards and AI assistance | *.git/* .gitignore .github/* CHANGELOG.md CHANGES.md --- # Git Commit Standards ## Format ``` type(scope[component]): concise description why: explanation of necessity/impact what: - technical changes made - keep focused on single topic refs: #issue-number, breaking changes, links ``` ## Commit Types - `feat`: New features/enhancements - `fix`: Bug fixes - `refactor`: Code restructuring - `docs`: Documentation changes - `chore`: Maintenance tasks (deps, tooling) - `test`: Test-related changes - `style`: Code style/formatting ## Guidelines - Subject line: max 50 chars - Body lines: max 72 chars - Use imperative mood ("Add" not "Added") - Single topic per commit - Blank line between subject and body - Mark breaking changes with "BREAKING:" - Use "See also:" for external links ## AI Assistance in Cursor - Stage changes with `git add` - Use `@commit` to generate initial message - Review and adjust the generated message - Ensure it follows format above ## Examples Good commit: ``` feat(subprocess[run]): Switch to unicode-only text handling why: Improve consistency and type safety in subprocess handling what: - BREAKING: Changed run() to use text=True by default - Removed console_to_str() helper and encoding logic - Simplified output handling - Updated type hints for better safety refs: #485 See also: https://docs.python.org/3/library/subprocess.html ``` Bad commit: ``` updated some stuff and fixed bugs ``` Cursor Rules: Add development QA and git commit standards (#cursor-rules) - Add dev-loop.mdc: QA process for code edits - Type checking with mypy - Linting with ruff - Test validation with pytest - Ensures edits are validated before commits - Add git-commits.mdc: Commit message standards - Structured format with why/what sections - Defined commit types and guidelines - Examples of good/bad commits - AI assistance instructions Note: These rules help maintain code quality and commit history consistency across the project. See also: https://docs.cursor.com/context/rules-for-ailibtmux-0.45.0/.github/000077500000000000000000000000001475667375600146565ustar00rootroot00000000000000libtmux-0.45.0/.github/contributing.md000066400000000000000000000037701475667375600177160ustar00rootroot00000000000000# Contributing When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the maintainers of this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project. ## Pull Request Process 1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. 2. This project uses flake8 to conform with common Python standards. Make sure to run your code through linter using latest version of flake8, before pull request. 3. Bad documnentation is a Bug. If your change demands documentation update, please do so. If you find an issue with documentation, take the time to improve or fix it. 4. pytest is used for automated testing. Please make sure to update tests that are needed, and to run `make test` before submitting your pull request. This should prevent issues with CI and make the review and merging process easier and faster. 5. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters. 6. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). 7. You may merge the Pull Request in once you have the sign-off of one other developer. If you do not have permission to do that, you may request reviewer to merge it for you. ## Decorum - Participants will be tolerant of opposing views. - Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks. - When interpreting the words and actions of others, participants should always assume good intentions. - Behaviour which can be reasonably considered harassment will not be tolerated. Based on [Ruby's Community Conduct Guideline](https://www.ruby-lang.org/en/conduct/) libtmux-0.45.0/.github/dependabot.yml000066400000000000000000000002551475667375600175100ustar00rootroot00000000000000version: 2 updates: - package-ecosystem: "github-actions" directory: "/" schedule: # Check for updates to GitHub Actions every week interval: "weekly" libtmux-0.45.0/.github/stale.yml000066400000000000000000000022001475667375600165030ustar00rootroot00000000000000# Number of days of inactivity before an issue becomes stale daysUntilStale: 60 # Number of days of inactivity before a stale issue is closed daysUntilClose: 7 # Issues with these labels will never be considered stale exemptLabels: - pinned - security # Label to use when marking an issue as stale staleLabel: stale # Comment to post when marking an issue as stale. Set to `false` to disable markComment: | This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. This bot is used to handle issues where the issue hasn't been discussed or has gone out of date. If an issue isn't resolved and handled in a certain period of time, it may be closed. If you would like your issue re-opened, please create a fresh issue with the latest, up to date information and mention this issue in it. unmarkComment: | Thank you for updating this issue. It is no longer marked as stale. # Comment to post when closing a stale issue. Set to `false` to disable closeComment: false # limit to only 'issues' or 'pulls' only: issues libtmux-0.45.0/.github/workflows/000077500000000000000000000000001475667375600167135ustar00rootroot00000000000000libtmux-0.45.0/.github/workflows/docs.yml000066400000000000000000000044511475667375600203720ustar00rootroot00000000000000name: docs on: push: branches: - master jobs: build: runs-on: ubuntu-latest strategy: matrix: python-version: ['3.13'] steps: - uses: actions/checkout@v4 - name: Filter changed file paths to outputs uses: dorny/paths-filter@v3.0.2 id: changes with: filters: | root_docs: - CHANGES - README.* docs: - 'docs/**' - 'examples/**' python_files: - 'src/libtmux/**' - uv.lock - pyproject.toml - name: Should publish if: steps.changes.outputs.docs == 'true' || steps.changes.outputs.root_docs == 'true' || steps.changes.outputs.python_files == 'true' run: echo "PUBLISH=$(echo true)" >> $GITHUB_ENV - name: Install uv if: env.PUBLISH == 'true' uses: astral-sh/setup-uv@v5 with: enable-cache: true - name: Set up Python ${{ matrix.python-version }} if: env.PUBLISH == 'true' run: uv python install ${{ matrix.python-version }} - name: Install dependencies [w/ docs] if: env.PUBLISH == 'true' run: uv sync --all-extras --dev - name: Print python versions if: env.PUBLISH == 'true' run: | python -V uv run python -V - name: Build documentation if: env.PUBLISH == 'true' run: | pushd docs; make SPHINXBUILD='uv run sphinx-build' html; popd - name: Push documentation to S3 uses: jakejarvis/s3-sync-action@v0.5.1 if: env.PUBLISH == 'true' with: args: --acl public-read --follow-symlinks --delete env: AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }} AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} AWS_REGION: 'us-west-1' # optional: defaults to us-east-1 SOURCE_DIR: 'docs/_build/html' # optional: defaults to entire repository - name: Purge cache on Cloudflare if: env.PUBLISH == 'true' uses: jakejarvis/cloudflare-purge-action@v0.3.0 env: CLOUDFLARE_TOKEN: ${{ secrets.CLOUDFLARE_TOKEN }} CLOUDFLARE_ZONE: ${{ secrets.CLOUDFLARE_ZONE }} libtmux-0.45.0/.github/workflows/tests.yml000066400000000000000000000076531475667375600206130ustar00rootroot00000000000000name: tests on: [push, pull_request] jobs: build: # Don't run twice for internal PRs from our own repo if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository runs-on: ubuntu-latest strategy: matrix: python-version: ['3.9', '3.13'] tmux-version: ['2.6', '2.7', '2.8', '3.0a', '3.1b', '3.2a', '3.3a', '3.4', '3.5', 'master'] steps: - uses: actions/checkout@v4 - name: Install uv uses: astral-sh/setup-uv@v5 with: enable-cache: true - name: Set up Python ${{ matrix.python-version }} run: uv python install ${{ matrix.python-version }} - name: Test runtime dependencies run: | uv run --no-dev -p python${{ matrix.python-version }} -- python -c ' from libtmux import common, constants, exc, formats, neo, pane, server, session, window, __version__ server = server.Server() print("libtmux version:", __version__) print("libtmux Server:", server) ' - name: Install dependencies run: uv sync --all-extras --dev - name: Setup tmux build cache for tmux ${{ matrix.tmux-version }} id: tmux-build-cache uses: actions/cache@v4 with: path: ~/tmux-builds/tmux-${{ matrix.tmux-version }} key: tmux-${{ matrix.tmux-version }} - name: Build tmux ${{ matrix.tmux-version }} if: steps.tmux-build-cache.outputs.cache-hit != 'true' run: | sudo apt install libevent-dev libncurses5-dev libtinfo-dev libutempter-dev bison mkdir ~/tmux-builds mkdir ~/tmux-src git clone https://github.com/tmux/tmux.git ~/tmux-src/tmux-${{ matrix.tmux-version }} cd ~/tmux-src/tmux-${{ matrix.tmux-version }} git checkout ${{ matrix.tmux-version }} sh autogen.sh ./configure --prefix=$HOME/tmux-builds/tmux-${{ matrix.tmux-version }} && make && make install export PATH=$HOME/tmux-builds/tmux-${{ matrix.tmux-version }}/bin:$PATH cd ~ tmux -V - name: Lint with ruff check run: uv run ruff check . - name: Format with ruff format run: uv run ruff format . --check - name: Lint with mypy run: uv run mypy . - name: Print python versions run: | python -V uv run python -V - name: Test with pytest continue-on-error: ${{ matrix.tmux-version == 'master' }} run: | sudo apt install libevent-2.1-7 export PATH=$HOME/tmux-builds/tmux-${{ matrix.tmux-version }}/bin:$PATH ls $HOME/tmux-builds/tmux-${{ matrix.tmux-version }}/bin tmux -V uv run py.test --cov=./ --cov-append --cov-report=xml -n auto --verbose env: COV_CORE_SOURCE: . COV_CORE_CONFIG: .coveragerc COV_CORE_DATAFILE: .coverage.eager - uses: codecov/codecov-action@v5 with: token: ${{ secrets.CODECOV_TOKEN }} release: runs-on: ubuntu-latest needs: build if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') strategy: matrix: python-version: ['3.13'] steps: - uses: actions/checkout@v4 - name: Install uv uses: astral-sh/setup-uv@v5 with: enable-cache: true - name: Set up Python ${{ matrix.python-version }} run: uv python install ${{ matrix.python-version }} - name: Install dependencies run: uv sync --all-extras --dev - name: Build package if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') run: uv build - name: Publish package if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') uses: pypa/gh-action-pypi-publish@release/v1 with: user: __token__ password: ${{ secrets.PYPI_API_TOKEN }} skip_existing: true libtmux-0.45.0/.gitignore000066400000000000000000000016031475667375600153060ustar00rootroot00000000000000# Mac stuff .DS_Store # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class # C extensions *.so # Distribution / packaging .Python *env*/ build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ *.egg-info/ .installed.cfg *.egg # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover .hypothesis/ .pytest_cache/ # Translations *.mo *.pot # Django stuff *.log # Sphinx documentation docs/_build/ # PyBuilder target/ # ipython Notebook .ipynb_checkpoints # mypy .mypy_cache/ # editors .idea .ropeproject *.swp .vim # Monkeytype monkeytype.sqlite3 libtmux-0.45.0/.prettierrc000066400000000000000000000000301475667375600154730ustar00rootroot00000000000000{ "printWidth": 100 } libtmux-0.45.0/.python-version000066400000000000000000000000071475667375600163200ustar00rootroot000000000000003.13.0 libtmux-0.45.0/.tmuxp.yaml000066400000000000000000000010131475667375600154300ustar00rootroot00000000000000session_name: libtmux start_directory: ./ # load session relative to config location (project root). shell_command_before: - uv virtualenv --quiet > /dev/null 2>&1 && clear windows: - window_name: libtmux focus: True layout: main-horizontal options: main-pane-height: 67% panes: - focus: true - pane - make watch_mypy - make watch_test - window_name: docs layout: main-horizontal options: main-pane-height: 67% start_directory: docs/ panes: - focus: true - pane - pane - make start libtmux-0.45.0/.tool-versions000066400000000000000000000001031475667375600161340ustar00rootroot00000000000000uv 0.6.1 python 3.13.2 3.12.9 3.11.11 3.10.16 3.9.21 3.8.20 3.7.17 libtmux-0.45.0/.vim/000077500000000000000000000000001475667375600141675ustar00rootroot00000000000000libtmux-0.45.0/.vim/coc-settings.json000066400000000000000000000012371475667375600174670ustar00rootroot00000000000000{ "[markdown][python]": { "coc.preferences.formatOnSave": true }, "python.analysis.autoSearchPaths": true, "python.analysis.typeCheckingMode": "basic", "python.analysis.useLibraryCodeForTypes": true, "python.formatting.provider": "ruff", "python.linting.ruffEnabled": true, "python.linting.mypyEnabled": true, "python.linting.flake8Enabled": false, "python.linting.pyflakesEnabled": false, "python.linting.pycodestyleEnabled": false, "python.linting.banditEnabled": false, "python.linting.pylamaEnabled": false, "python.linting.pylintEnabled": false, "pyright.organizeimports.provider": "ruff", "pyright.testing.provider": "pytest", } libtmux-0.45.0/CHANGES000066400000000000000000001203461475667375600143170ustar00rootroot00000000000000# Changelog For instructions on installing the development version of libtmux, refer to [development releases](https://libtmux.git-pull.com/quickstart.html#developmental-releases). To install via [pip](https://pip.pypa.io/en/stable/), use: ```console $ pip install --user --upgrade --pre libtmux ``` ## libtmux 0.46.x (Yet to be released) - _Future release notes will be placed here_ ## libtmux 0.45.0 (2025-02-23) ### Breaking Changes #### Test helpers: Refactor Test helper functionality has been split into focused modules (#578): - `libtmux.test` module split into: - `libtmux.test.constants`: Test-related constants (`TEST_SESSION_PREFIX`, etc.) - `libtmux.test.environment`: Environment variable mocking - `libtmux.test.random`: Random string generation utilities - `libtmux.test.temporary`: Temporary session/window management **Breaking**: Import paths have changed. Update imports: ```python # Old (0.44.x and earlier) from libtmux.test import ( TEST_SESSION_PREFIX, get_test_session_name, get_test_window_name, namer, temp_session, temp_window, EnvironmentVarGuard, ) ``` ```python # New (0.45.0+) from libtmux.test.constants import TEST_SESSION_PREFIX from libtmux.test.environment import EnvironmentVarGuard from libtmux.test.random import get_test_session_name, get_test_window_name, namer from libtmux.test.temporary import temp_session, temp_window ``` ### Development - CI: Check for runtime dependencies (#574) Kudos @ppentchev for inspiration on the command ([comment](https://github.com/tmux-python/libtmux/pull/572#issuecomment-2663642923)). ## libtmux 0.44.2 (2025-02-17) ### Bug fix - Fix `typing_extensions` issue by wrapping it in `TYPE_CHECKING`, continuation of #564, via #572. ### Development - Improved test organization and coverage in `test_common.py` (#570): - Consolidated version-related tests into parametrized fixtures using NamedTuples - Added comprehensive test cases for various version formats (master, next, OpenBSD, dev, rc) - Improved test readability with clear test IDs and logical grouping - Consistent use of pytest parametrize convention across test suite - Fix broken test for `test_window_rename` (#570) ## libtmux 0.44.1 (2025-02-17) ### Packaging - Types: Only import `typing_extensions` when necessary, via #563, @ppentchev! ## libtmux 0.44.0 (2025-02-16) ### New Features #### Context Managers support (#566) Added context manager support for all major object types: - `Server`: Automatically kills the server when exiting the context - `Session`: Automatically kills the session when exiting the context - `Window`: Automatically kills the window when exiting the context - `Pane`: Automatically kills the pane when exiting the context Example usage: ```python with Server() as server: with server.new_session() as session: with session.new_window() as window: with window.split() as pane: pane.send_keys('echo "Hello"') # Do work with the pane # Everything is cleaned up automatically when exiting contexts ``` This makes it easier to write clean, safe code that properly cleans up tmux resources. ## libtmux 0.43.0 (2025-02-15) ### New Features #### Server Initialization Callbacks Server now accepts 2 new optional params, `socket_name_factory` and `on_init` callbacks (#565): - `socket_name_factory`: Callable that generates unique socket names for new servers - `on_init`: Callback that runs after server initialization - Useful for creating multiple servers with unique names and tracking server instances - Socket name factory is tried after socket_name, maintaining backward compatibility #### New test fixture: `TestServer` Add `TestServer` pytest fixture for creating temporary tmux servers (#565): - Creates servers with unique socket names that clean up after themselves - Useful for testing interactions between multiple tmux servers - Includes comprehensive test coverage and documentation - Available in doctest namespace ### Documentation - Fix links to the "Topics" section - More docs for "Traversal" Topic (#567) ## libtmux 0.42.1 (2024-02-15) ### Bug fixes - tests: Import `Self` in a `TYPE_CHECKING` guard to prevent dependency issues. Via #562, Thank you @ppentchev! ### Development - dev dependencies: Include `typing-extensions` for Python version < 3.11 via the `testing` and `lint` groups, via #564. ## libtmux 0.42.0 (2025-02-02) ### Bug fixes - `tmux_cmd`: Migrate to to `text=True` This deprecates usage of `console_to_str()` and `str_from_console()`. Resolves #558 via #560. - compat: Remove `console_to_str()` and `str_from_console()` These are both deprecated artifacts of libtmux' Python 2.x compatiblity layer. ## libtmux 0.41.0 (2025-02-02) ### Fixes - {meth}`Server.__repr__()`: Use {meth}`os.geteuid()` for default `socket_path`. Thank you @lazysegtree! (#557, resolves #556) ### Documentation - `Server`: Fix `colors` docstring to note it accepts `88` or `256`, Thank you @TravisDart! (via #544) ### Development #### chore: Implement PEP 563 deferred annotation resolution (#555) - Add `from __future__ import annotations` to defer annotation resolution and reduce unnecessary runtime computations during type checking. - Enable Ruff checks for PEP-compliant annotations: - [non-pep585-annotation (UP006)](https://docs.astral.sh/ruff/rules/non-pep585-annotation/) - [non-pep604-annotation (UP007)](https://docs.astral.sh/ruff/rules/non-pep604-annotation/) For more details on PEP 563, see: https://peps.python.org/pep-0563/ ## libtmux 0.40.1 (2024-12-24) ### Bug fix - `Server.new_session`: Fix handling of environmental variables passed to new sessions. Thank you @ppentchev! (#553) ## libtmux 0.40.0 (2024-12-20) _Maintenance only, no bug fixes or new features_ ### Breaking - `_global` renamed to `global_` ### Development - Aggressive automated lint fixes via `ruff` (#550) via ruff v0.8.4, all automated lint fixes, including unsafe and previews were applied for Python 3.9: ```sh ruff check --select ALL . --fix --unsafe-fixes --preview --show-fixes; ruff format . ``` - Tests: Stability fixes for legacy `test_select_pane` test (#552) ## libtmux 0.39.0 (2024-11-26) _Maintenance only, no bug fixes or new features_ ### Breaking changes - Drop Python 3.8. end of life was October 7th, 2024 (#548) tmuxp 1.48.0 was the last release for Python 3.8. The minimum python for tmuxp as of 1.49.0 is Python 3.9 ## libtmux 0.38.1 (2024-11-26) - Keep minimum Python version at 3.8 for now. ## libtmux 0.38.0 (2024-11-26) ### Breaking changes #### Project and package management: poetry to uv (#547) [uv] is the new package and project manager for the project, replacing Poetry. [uv]: https://github.com/astral-sh/uv #### Build system: poetry to hatchling (#547) [Build system] moved from [poetry] to [hatchling]. [Build system]: https://packaging.python.org/en/latest/tutorials/packaging-projects/#choosing-a-build-backend [poetry]: https://github.com/python-poetry/poetry [hatchling]: https://hatch.pypa.io/latest/ ### Development - Code quality: Use f-strings in more places (#540) via [ruff 0.4.2](https://github.com/astral-sh/ruff/blob/v0.4.2/CHANGELOG.md). [uv]: https://github.com/astral-sh/uv ### Documentation - Fix docstrings in `query_list` for `MultipleObjectsReturned` and `ObjectDoesNotExist`. ## libtmux 0.37.0 (04-21-2024) _Maintenance only, no bug fixes or new features_ ### Testing - Add `pytest-xdist` ([PyPI](https://pypi.org/project/pytest-xdist/), [GitHub](https://github.com/pytest-dev/pytest-xdist)) for parallel testing (#522). pytest: ```console py.test -n auto ``` pytest-watcher: ```console env PYTEST_ADDOPTS='-n auto' make start ``` entr(1): ```console make watch_test test="-n auto" ``` - Improve flakey tests: - `retry_until()` tests: Relax clock in `assert` (#522). - `tests/test_pane.py::test_capture_pane_start`: Use `retry_until()` to poll, improve correctness of test (#522). ### Documentation - Automatically linkify links that were previously only text. ### Development - poetry: 1.8.1 -> 1.8.2 See also: https://github.com/python-poetry/poetry/blob/1.8.2/CHANGELOG.md ## libtmux 0.36.0 (2024-03-24) _Maintenance only, no bug fixes or new features_ ### Development - Aggressive automated lint fixes via `ruff` (#539) via ruff v0.3.4, all automated lint fixes, including unsafe and previews were applied: ```sh ruff check --select ALL . --fix --unsafe-fixes --preview --show-fixes; ruff format . ``` Branches were treated with: ```sh git rebase \ --strategy-option=theirs \ --exec 'poetry run ruff check --select ALL . --fix --unsafe-fixes --preview --show-fixes; poetry run ruff format .; git add src tests; git commit --amend --no-edit' \ origin/master ``` ## libtmux 0.35.1 (2024-03-23) ### Bug fix - {attr}`Server.attached_sessions` fix for when multiple clients attached, thank you @patrislav1 (#537) - #538 fix to `QueryList`. ## libtmux 0.35.0 (2024-03-17) ### Breaking changes - Eliminate redundant targets / `window_index`'s across codebase (#536). ## libtmux 0.34.0 (2024-03-17) ### Breaking changes #### Command target change (#535) Commands: All `cmd()` methods using custom or overridden targets must use the keyword argument `target`. This avoids entanglement with inner shell values that include `-t` for other purposes. These methods include: - {meth}`Server.cmd()` - {meth}`Session.cmd()` - {meth}`Window.cmd()` - {meth}`Pane.cmd()` ## libtmux 0.33.0 (2024-03-17) ### Breaking changes #### Improved new sessions (#532) - `Session.new_window()`: - Learned `direction`, via {class}`~libtmux.constants.WindowDirection`). - [PEP 3102] keyword-only arguments after window name (#534). - Added {meth}`Window.new_window()` shorthand to create window based on that window's position. [PEP 3102]: https://www.python.org/dev/peps/pep-3102/ #### Improved window splitting (#532) - `Window.split_window()` to {meth}`Window.split()` - Deprecate `Window.split_window()` - `Pane.split_window()` to {meth}`Pane.split()` - Deprecate `Pane.split_window()` - Learned `direction`, via {class}`~libtmux.constants.PaneDirection`). - Deprecate `vertical` and `horizontal` in favor of `direction`. - Learned `zoom` #### Tweak: Pane position (#532) It's now possible to retrieve the position of a pane in a window via a `bool` helper:: - {attr}`Pane.at_left` - {attr}`Pane.at_right` - {attr}`Pane.at_bottom` - {attr}`Pane.at_right` ### Development - poetry: 1.7.1 -> 1.8.1 See also: https://github.com/python-poetry/poetry/blob/1.8.1/CHANGELOG.md ## libtmux 0.32.0 (2024-03-01) _Maintenance only, no bug fixes or new features_ ### Packaging - Add implicit imports to `__init__.py` (#531), thank you @ssbarnea. ### Development - ruff 0.2.2 -> 0.3.0 ## libtmux 0.31.0 (2024-02-17) ### Cleanups (#527) - Streamline `{Server,Session,Window,Pane}.cmd()`, across all usages to: - Use `cmd: str` as first positional - Removed unused keyword arguments `**kwargs` ### Renamings (#527) - `Session.attached_window` renamed to {meth}`Session.active_window` - `Session.attached_window` deprecated - `Session.attached_pane` renamed to {meth}`Session.active_pane` - `Session.attached_pane` deprecated - `Window.attached_pane` renamed to {meth}`Window.active_pane` - `Window.attached_pane` deprecated ### Improvements (#527) - `Server.attached_windows` now uses `QueryList`'s `.filter()` ### Documentation (#527) - Document `.cmd` in README and quickstart - Add doctests and improve docstrings to `cmd()` methods across: - {meth}`Server.cmd()` - {meth}`Session.cmd()` - {meth}`Window.cmd()` - {meth}`Pane.cmd()` ### Post-release: v0.31.0post0 (2024-02-17) - Documentation updates ## libtmux 0.30.2 (2024-02-16) ### Development - Updated `TMUX_MAX_VERSION` from 3.3 to 3.4 ## libtmux 0.30.1 (2024-02-16) ### Fixes - Adjusted pytest plugin and test module: Updated to use renamed methods from version 0.30.0. ## libtmux 0.30.0 (2024-02-16) ### Additions - Introduced {meth}`Pane.kill()` method ### Modifications - `Window.select_window()` renamed to {meth}`Window.select()` - Deprecated `Window.select_window()` - `Pane.select_pane()` renamed to {meth}`Pane.select()` - Deprecated `Pane.pane_select()` - `Session.attach_session()` renamed to {meth}`Session.attach()` - Deprecated `Session.attach_session()` - `Server.kill_server()` renamed to {meth}`Server.kill()` - Deprecated `Server.kill_server()` - `Session.kill_session()` renamed to {meth}`Session.kill()` - Deprecated `Session.kill_session()` - `Window.kill_window()` renamed to {meth}`Window.kill()` - Deprecated `Window.kill_window()` ### Enhancements - {meth}`Server.new_session()`: Support environment variables - {meth}`Window.split_window()`: Support `size` via `-l` Supports columns/rows (`size=10`) and percentage (`size='10%'`) ## libtmux 0.29.0 (2024-02-16) #### Fixes - Use {exc}`DeprecationWarning` for APIs set to be deprecated (#526) #### Testing - pytest: Ignore {exc}`DeprecationWarning` by default (#526) ## libtmux 0.28.1 (2024-02-15) _Maintenance only, no bug fixes or new features_ #### Testing - CI: Bump actions to node 20+ versions #### Documentation - Refine docs and add migration for v0.28.0 ## libtmux 0.28.0 (2024-02-14) ### Breaking changes #### Detached / unselected by default (#523) To ensure consistency and principle of least surprise, keep these set to not use `-a` unless explicitly specified. Breaking: {meth}`Session.new_window()` + {meth}`Window.split_window()` no longer attaches by default. - 0.28.0 and greater: Defaults to `attach=False`. - 0.27.1 and below: Defaults to `attach=True`. To keep the old behavior in 0.28.0 and beyond, pass `attach=True` explicitly. ### Improved resizing (#523) - Breaking: `Pane.resize_pane()` renamed to {meth}`Pane.resize()` (#523) This convention will be more consistent with {meth}`Window.resize()`. - Breaking: {meth}`Pane.resize()`'s params changed (#523) - No longer accepts `-U`, `-D`, `-L`, `-R` directly, instead accepts {class}`~libtmux.constants.ResizeAdjustmentDirection`). - {meth}`Pane.resize()`: - Accept adjustments via `adjustment_direction` w/ {class}`~libtmux.constants.ResizeAdjustmentDirection` + `adjustment`. - Learned to accept manual `height` and / or `width` (columns/rows or percentage) - Zoom (and unzoom) - {meth}`Window.resize()`: Newly added Tip: If {meth}`Pane.resize()` was not taking affect <= 0.27.1, try to resize with {meth}`Window.resize()` first. ### Fixes - {meth}`Window.refresh()` and {meth}`Pane.refresh()`: Refresh more underlying state (#523) - {meth}`Obj._refresh`: Allow passing args (#523) e.g. `-a` (all) to `list-panes` and `list-windows` - `Server.panes`: Fix listing of panes (#523) Would list only panes in attached session, rather than all in a server. ### Improvement - Pane, Window: Improve parsing of option values that return numbers (#520) - `Obj._refresh`: Allow passing `list_extra_args` to ensure `list-windows` and `list-panes` can return more than the target (#523) ### Tests - pytest: Fix `usefixture` warning (#519) - ci: Add tmux 3.4 to test matrix (#909) ## libtmux 0.27.1 (2024-02-07) ### Packaging - Include `MIGRATION` in source distribution tarball (#517, for #508) ## libtmux 0.27.0 (2024-02-07) ### Improvement - QueryList typings (#515) - This improves the annotations in descendant objects such as: - `Server.sessions` - `Session.windows` - `Window.panes` - Bolster tests (ported from `libvcs`): doctests and pytests ## libtmux 0.26.0 (2024-02-06) ### Breaking changes - `get_by_id()` (already deprecated) keyword argument renamed from `id` to `Server.get_by_id(session_id)`, `Session.get_by_id(window_id)`, and `Window.get_by_id(pane_id)` (#514) ### Documentation - Various docstring fixes and tweaks (#514) ### Development - Strengthen linting (#514) - Add flake8-commas (COM) - https://docs.astral.sh/ruff/rules/#flake8-commas-com - https://pypi.org/project/flake8-commas/ - Add flake8-builtins (A) - https://docs.astral.sh/ruff/rules/#flake8-builtins-a - https://pypi.org/project/flake8-builtins/ - Add flake8-errmsg (EM) - https://docs.astral.sh/ruff/rules/#flake8-errmsg-em - https://pypi.org/project/flake8-errmsg/ ### CI - Move CodeQL from advanced configuration file to GitHub's default ## libtmux 0.25.0 (2023-11-25) ### Improvement - `Server.__eq__`, `Session.__eq__`, `Window.__eq__`, `Pane.__eq__` now returns `False` instead of raising `AssertionError` when type mismatches (#505, #510) Thank you @m1guelperez for `Window.__eq__`! (#505) ### Development - ci: Add pydocstyle rule to ruff (#509) ### Documentation - Add docstrings to functions, methods, classes, and packages (#509) ## libtmux 0.24.1 (2023-11-23) ### Packaging - Remove `requirements/` folder, which was unused and deprecated by pyproject.toml (#507) - pyproject: Add `gp-libs` to `test` dependency group ## libtmux 0.24.0 (2023-11-19) _Maintenance only, no bug fixes or new features_ ### Breaking changes - Python 3.7 Dropped (#497) ### Packaging - Move pytest configuration to `pyproject.toml` (#499) - Poetry: 1.5.1 -> 1.6.1 (#497), 1.6.1 -> 1.7.0 (direct to trunk) See also: https://github.com/python-poetry/poetry/blob/1.7.0/CHANGELOG.md - Packaging (poetry): Fix development dependencies Per [Poetry's docs on managing dependencies] and `poetry check`, we had it wrong: Instead of using extras, we should create these: ```toml [tool.poetry.group.group-name.dependencies] dev-dependency = "1.0.0" ``` Which we now do. [Poetry's docs on managing dependencies]: https://python-poetry.org/docs/master/managing-dependencies/ ### Development - Move formatting from `black` to [`ruff format`] (#506) This retains the same formatting style of `black` while eliminating a dev dependency by using our existing rust-based `ruff` linter. [`ruff format`]: https://docs.astral.sh/ruff/formatter/ - CI: Update action packages to fix warnings - [dorny/paths-filter]: 2.7.0 -> 2.11.1 - [codecov/codecov-action]: 2 -> 3 [dorny/paths-filter]: https://github.com/dorny/paths-filter [codecov/codecov-action]: https://github.com/codecov/codecov-action ## libtmux 0.23.2 (2023-09-09) _Maintenance only, no bug fixes or new features_ ### Breaking changes - Cut last python 3.7 release (EOL was June 27th, 2023) For security updates, a 0.23.x branch can be maintained for a limited time, if necessary. ## libtmux 0.23.1 (2023-09-02) _Maintenance only, no bug fixes or new features_ ### Development - Automated typo fixes from [typos-cli]: ```console typos --format brief --write-changes ``` [typos-cli]: https://github.com/crate-ci/typos - ruff: Remove ERA / `eradicate` plugin This rule had too many false positives to trust. Other ruff rules have been beneficial. ## libtmux 0.23.0 (2023-08-20) _Maintenance only, no bug fixes or new features_ ### Development - Code quality improved via [ruff] rules (#488) This includes fixes made by hand, and with ruff's automated fixes. Despite selecting additional rules, which include import sorting, ruff runs nearly instantaneously when checking the whole codebase. ### Post-release: v0.23.0post0 (2023-08-20) - Fixes code comments cleaned up by `ruff`, but missed in QA. In the future, even when using an automated tool, we will review more thoroughly. ### Post-release: v0.23.0post1 (2023-08-26) - Fixes for more `ERA001` issues. ### Post-release: v0.23.0post2 (2023-08-28) - Yet more `ERA001` fixes. ## libtmux 0.22.2 (2023-08-20) ### Development - build system: Remove `setuptools` requirement (#495, in related to #493, #494) ## libtmux 0.22.1 (2023-05-28) _Maintenance only, no bug fixes or new features_ ### Development - Add back `black` for formatting This is still necessary to accompany `ruff`, until it replaces black. ## libtmux 0.22.0 (2023-05-27) _Maintenance only, no bug fixes or new features_ ### Internal improvements - Move formatting, import sorting, and linting to [ruff]. This rust-based checker has dramatically improved performance. Linting and formatting can be done almost instantly. This change replaces black, isort, flake8 and flake8 plugins. - poetry: 1.4.0 -> 1.5.0 See also: https://github.com/python-poetry/poetry/releases/tag/1.5.0 [ruff]: https://ruff.rs ## libtmux 0.21.1 (2023-04-07) ### Development - Update mypy to 1.2.0 ### Fixes - SkipDefaultFieldsReprMixin: Fix typing for mypy 1.2.0 ## libtmux 0.21.0 (2023-01-29) ### Breaking internal change - Default format separator (`LIBTMUX_TMUX_FORMAT_SEPARATOR`): `|` -> `␞` (#475, in re: #471, #472) Fixes `buffer_sample` with pipes causing `fetch_objs()`-powered listings to fail unexpectedly. ## libtmux 0.20.0 (2023-01-15) ### What's new - Server.new_session: Accept `x` and `y`, thanks @rockandska (#469) - New test fixture: `session_params`. The dict is used directly in the `session` pytest fixture (#470) ## libtmux 0.19.1 (2022-01-07) ### Fixes - `Window.set_window_option()`: Remove `.refresh()` (#467) See also: https://github.com/tmux-python/tmuxp/issues/860 ## libtmux 0.19.0 (2022-01-07) ### New features - `pane.capture_pane()` learned to accept `start` and `end` line numbers (#465) ## libtmux 0.18.3 (2023-01-07) ### Improvement - `fetch_objs` now raises `ObjectDoesNotExist` with detailed information on lookup that failed (#466) ## libtmux 0.18.2 (2022-12-30) ### Fixes - Server: Launching of new session with default socket (#857) ## libtmux 0.18.1 (2022-12-28) ### Fixes - Window.panes: Fix docstring - Remove unused code documentation ## libtmux 0.18.0 (2022-12-27) ### Breaking - Server: Add `__repr__` and set `socket_path` if none set. Before (0.17 and below): ```python ``` New `__repr__` (0.18+): ```python Server(socket_name=test) ``` ```python Server(socket_path=/tmp/tmux-1000/default) ``` ## libtmux 0.17.2 (2022-12-27) - Server: Move `_list_panes` and `_update_panes` to deprecated ## libtmux 0.17.1 (2022-12-27) ### Fixes - Documentation fixes - Add deprecation warning to `Server.children`, `Session.children`, `Window.children`. ## libtmux 0.17.0 (2022-12-26) ### Breaking changes (#426) - Finding objects / relations - 0.16 and below: `session._windows()`, `session.list_windows()`, etc. 0.17 and after: {attr}`session.windows ` - 0.16 and below: `session.find_where({'window_name': my_window})` 0.17 and after: {meth}`session.windows.get(window_name=my_window, default=None) ` - If not found and not `default`, raises {exc}`~libtmux._internal.query_list.ObjectDoesNotExist` - If multiple objects found, raises {exc}`~libtmux._internal.query_list.MultipleObjectsReturned` - 0.16 and below: `session.where({'window_name': my_window})` 0.17 and after: {meth}`session.windows.filter(window_name=my_window) ` - Accessing attributes - 0.16 and below: `window['id']` 0.17 and after: `window.id` - 0.16 and below: `window.get('id')` 0.17 and after: `window.id` - 0.16 and below: `window.get('id', None)` 0.17 and after: `getattr(window, 'id', None)` ### New features #### Detect if server active (#448) - `Server.is_alive()` - `Server.raise_if_dead()` ### Internal - Remove unused `sphinx-click` development dependency ## libtmux 0.16.1 (2022-12-12) ### Fixes - Remove reliance on `packaging.version.Version` (#461) This is too critical of a package to pin a dependency as it may interfere with other packages the user relies on. In addition, libtmux doesn't need strict compatibility with `packaging`. ## libtmux 0.16.0 (2022-12-10) ### Breaking changes - Fix `distutils` warning, vendorize `LegacyVersion` (#351) Removal of reliancy on `distutils.version.LooseVersion`, which does not support `tmux(1)` versions like `3.1a`. Fixes warning: > DeprecationWarning: distutils Version classes are deprecated. Use > packaging.version instead. The temporary workaround, before 0.16.0 (assuming _setup.cfg_): ```ini [tool:pytest] filterwarnings = ignore:.* Use packaging.version.*:DeprecationWarning:: ignore:The frontend.Option(Parser)? class.*:DeprecationWarning:: ``` ### Features - `Window.split_window()` and `Session.new_window()` now support an optional dictionary of environmental variables, via (#453), credit @zappolowski. ## libtmux 0.15.10 (2022-11-05) _There will be more improvements over the coming weeks and months to shore up flakiness across shells and environments._ ### Tests - Compatibility improvement for `test_capture_pane` and `env` (#452), credit: @zappolowski! - Remove more BASHisms from tests (#455) ## libtmux 0.15.9 (2022-10-30) ### Bug fix - `tmux_cmd()`: Fix raise of TmuxCommandNotFound (#450) ### CI - Use python 3.11 (#451) ### Packaging - Add python 3.11 to trove classifiers (#451) ### Development - Add python 3.11 to asdf and pyenv configurations (#451) ## libtmux 0.15.8 (2022-10-02) ### Bug fix - `Session.new_window()`: Improve support for `window_name: ''` downstream in tmuxp (#444, credit: @trankchung) ## libtmux 0.15.7 (2022-09-23) - Move `.coveragerc` -> `pyproject.toml` (#443) ## libtmux 0.15.6 (2022-09-23) _Maintenance only, no bug fixes or new features_ ### Packaging - Remove `MANIFEST.in` This is handled by poetry's `include` in pyproject.toml. ## libtmux 0.15.5 (2022-09-23) _Maintenance only, no bug fixes or new features_ ### Packaging - Remove `.tmuxp-before-script.sh` from `.tmuxp.yaml` ## libtmux 0.15.4 (2022-09-21) ### Fixes - Use stable `pytest` API imports where possible to fix issues in downstream packaging on Arch (#441, via #442) ### Packaging - Add `.tmuxp-before-script.sh` (used by `.tmuxp.yaml`) and `conftest.py` to source distributoins (#441, via #442) ## libtmux 0.15.3 (2022-09-20) ### Tests / docs - Examples for pytest plugin (#439) - Move conftest.py to root level (#440) - https://docs.pytest.org/en/stable/deprecations.html#pytest-plugins-in-non-top-level-conftest-files - Less conftest.py files - We can now run py.test for `README.md` without needing to proxy through `docs/index.md` ## libtmux 0.15.2 (2022-09-17) **Maintenance release, no features or fixes** ### Tests - pytest plugin: Initial tests (for testing the plugin itself, #423) ### Packaging - pyproject.toml: Note pytest framework in trove classifiers ### Infrastructure - CI speedups (#428) - Avoid fetching unused apt package - Split out release to separate job so the PyPI Upload docker image isn't pulled on normal runs ## libtmux 0.15.1 (2022-09-11) ### Packaging - pyproject.toml: Drop old issues package, remove anther package from grouping ### Documentation - Cleanup quickstart page ## libtmux 0.15.0 (2022-09-10) ### New features - Added a [pytest plugin](https://libtmux.git-pull.com/pytest-plugin.html), #411. ### Breaking changes - Remove `common.which()` in favor of {func}`shutil.which`, Credit: @rocksandska, via #407 - Fixes #402: {func}`common.tmux_cmd` will only strip _trailing_ empty lines. Before this change, all empty lines were filtered out. This will lead to a more accurate behavior when using {meth}`Pane.capture_pane`. Credit: @rockandska, via #405. - Source files for `libtmux` modules moved to `src/`, via #414. ### Development - Add [flake8-bugbear](https://github.com/PyCQA/flake8-bugbear) (#408) - Add [flake8-comprehensions](https://github.com/adamchainz/flake8-comprehensions) (#409) ### Tests - Test doctests in documentation via [pytest-doctest-docutils](https://gp-libs.git-pull.com/doctest/pytest.html) (#410) ### Documentation - Examples updated for correctness, #412 (cherry-picked from #410) - Render changelog in [linkify_issues](https://gp-libs.git-pull.com/linkify_issues/) (#410) - Fix Table of contents rendering with sphinx autodoc with [sphinx_toctree_autodoc_fix](https://gp-libs.git-pull.com/sphinx_toctree_autodoc_fix/) (#410) ## libtmux 0.14.2 (2022-08-17) ### Fixes - {meth}`Server.new_session` _really_ works without `session_name`, #401 fixes #399. Improved tests and doctests added. ## libtmux 0.14.1 (2022-08-17) ### Fixes - {meth}`Server.new_session` works without `session_name`, #400 fixes #399 _This still passed `None` to the session name, this was fixed in v0.14.2._ ## libtmux 0.14.0 (2022-08-05) ### Breaking changes - {meth}`Pane.send_keys`: `suppress_history` default value changed from `True` to `False`, #395 ### Tests and docs - Initial [doctests] examples stubbed out #394 [doctests]: https://docs.python.org/3/library/doctest.html - Fix bug in `temp_window()` context manager, #394 - Pytest configuration `conftest.py` moved to `libtmux/conftest.py`, so doctest can detect the fixtures #394 ## libtmux 0.13.0 (2022-08-05) ### What's new - **Improved typings** Now [`mypy --strict`] compliant (#383) Smaller touchups from #392 [`mypy --strict`]: https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-strict ### Breaking changes - Deprecated individual item lookups (#390) - Removed key lookups from {meth}`libtmux.common.EnvironmentMixin.show_environment` Only `EnvironmentMixin.show_environment()` (without an argument) exists, and it still returns a `dict`. - Add key lookups via {meth}`libtmux.common.EnvironmentMixin.getenv` ```python # Before server.show_environment('DISPLAY') # After server.getenv('DISPLAY') # Before session.show_environment('DISPLAY') # After session.getenv('DISPLAY') ``` - Removed key lookups from {meth}`Session.show_options` ```python session.show_options() # still returns dict, without an argument # Old session.show_options('DISPLAY') # Now session.show_option('DISPLAY') ``` - Removed key lookups from {meth}`Window.show_window_options` ```python window.show_window_options() # still returns dict, without an argument # Old window.show_window_options('DISPLAY') # Now window.show_window_option('DISPLAY') ``` - Remove `libtmux.test.retry()`, deprecated since 0.12.x (#393) ### Development - Fix incorrect function name `findWhere()` (#391) ## libtmux 0.12.0 (2022-07-13) ### Compatibility - Brought back python 3.7 and 3.8 support (#375) - Support for tmux 3.3a - Add to CI - Bump `TMUX_MAX_VERSION` from 2.4 -> 3.3 _2.4 to 3.3a already worked, this is just the constant being updated._ ### Development - Remove tox and tox-poetry-installer This created issues with running poetry while inside the virtualenv. - Typings: Core relations, e.g. `Pane.window`, `Pane.session`, `Pane.server`, `Window.server` #385 ### Documentation - Renewed logo - Try out sphinx-autoapi for its table of contents generation (#367) - Break up API documentations for utilities, exception, and test helpers and remove duplicate docs from API page. Server, session, window, and pane docs are in the Reference section now. ### Testing - `retry()`: Add deprecation warning. This will be removed in 0.13.x (#368, #372) - New function `retry_until()`: Polls a callback function for a set period of time until it returns `True` or times out. By default it will raise {exc}`libtmux.exc.WaitTimeout`, with `raises=False` it will return `False`. Thank you @categulario! (#368, #372) - #384 Chore: Use absolute modules rather than root-level to avoid cyclic imports. ```python # Bad / Old from libtmux import Server # Good / New from libtmux.server import Server ``` ### Internals - #382 [mypy] support added: - Basic mypy tests now pass ## libtmux 0.11.0 (2022-03-10) ### Compatibility - Python 3.7 and 3.8 returns in 0.12.0 ~~Final python 3.7 and 3.8 release~~ ~~Fixes and security updates will go to [`v0.11.x`](https://github.com/tmux-python/libtmux/tree/v0.11.x)~~ - Internal: Use new separator to split `tmux(1)` formatting information (#289, #343) The separator is configurable via `LIBTMUX_TMUX_FORMAT_SEPARATOR`. If you ever have compatibility issues in the future let us know which default works best across versions. Credit: @JonathanRaiman and @jagguli - Basic type annotations (#359, #361) via @otherJL0 ### Development - Code cleanup (#362) from @otherJL0 - Format with black w/ string normalization. This is a one-time diff (#354) ### Documentation - Sidebar reorganized into sections - Added documentation on fetching developmental releases of libtmux ## libtmux 0.10.3 (2022-01-10) ### Packaging First experimental release using `poetry build` (#347). If you are packaging and run across any difficulty please see #346. ### Compatibility - Drop python 3.6 (#344) - Add python 3.10, though still `packaging.version` issues remain (#344) A compat module and version constraints will need to be added for this ### Development - poetry: 1.1.7 -> 1.1.12 (#344) - Add `.pre-commit-config.yaml` (#344) ## libtmux 0.10.2 (2021-10-30) - #324: Update poetry to 1.1 - CI: Use poetry 1.1.7 and `install-poetry.py` installer - Relock poetry.lock at 1.1 (w/ 1.1.7's fix) - #339 (CI): Lock python at 3.9 to avoid poetry issue with `dataclasses` - ci: Fix publishing docs (similar to #339) - #341 #342: `Server.attached_sessions()` now supports multiple attached sessions. Remove attached sessions limitation to not detect multiple attached clients, thank you @timoses ## libtmux 0.10.1 (2021-06-16) - Update `Window.select_window()` for #271 ## libtmux 0.10.0 (2021-06-16) - #321: Convert to markdown - #271: Fix `select_window()` by providing the session ID as argument to `-t`. Thanks @Flowdalic - Drop python 3.5 support ## libtmux 0.9.0 (2021-06-14) Python 2.7 support dropped. - #306: chore: Remove python 2.7 support - #314: chore: Python 3.x syntax tweaks - #312: ci: Add tmux 3.2a to CI - chore: Update black to [21.6b0](https://github.com/psf/black/blob/21.6b0/CHANGES.md#216b0) - #271: Fix select_window() by providing the session ID as argument to -t. ## libtmux 0.8.5 (2020-10-25) - #297: Enchance subprocess interaction std[in|out|err]. Needed for interact with big buffer, fixes #251, thank you @gil-obradors! - #303 Add `common.get_libtmux_version` which gives the tmux version as a loose constraint. Fix linking to terms inside docs, and duplicate description of module which sphinx warned about in api.rst. - #266 Fix issue on local tests where env variables would cause show-environment to pause tests indefinitely. ## libtmux 0.8.4 (2020-10-25) - #234: `Window.split_window`: Allow passing `percent`, Thank you @jinankjain! - #289: Fix warning due to invalid escape sequences, Thank you @tirkarthi! - #295: Publish docs via our own action - #295: Move more packaging over to poetry, though we'll keep setup.py for the moment to ensure compatibility package maintainers. - #295: New development instructions - #295: Move doc/ to docs/ - #296: CI: Test python 2.7, cache python packages, prevent running internal PRs twice ## libtmux 0.8.3 (2020-08-16) - #278: Fix Python deprecation warnings, thanks @d1618033 Also thanks Flowdalic for a similar PR at #294 - Add `project_urls` to setup.py - #293 Move from Pipfile to poetry - Fix show_option test in tmux 3.0 - Clean up handle_option_error comments - Move CI to a GitHub action ## libtmux 0.8.2 (2019-06-02) - CHANGES updated to plain reStructuredText - Add `project_urls` to setup.py for pypi. - Looser Pipfile versions, add Pipfile.lock ## libtmux 0.8.1 (2019-01-26) - #117 Fix issue with renaming clients with tmux 2.7 on BSD/macOS machines. - #121 Support `literal=True` (`-l`) in `Pane.send_keys` from @ritiek - #131 Fix for unicode commands in Python 2, thanks @myw - #172 Support for next-X.Y versions from @sloria - #120 `capture_pane` support for `Pane` - #119 `display_message` support for `Pane` - Sort imports with isort - Add sphinxcontrib-napoleon package for documentation - Move docstrings over to numpy's style ## libtmux 0.8.0 (2018-03-11) - #46 Change license from BSD to MIT - Move to new organization, tmux-python - Support package updates to pytest, sphinx, etc. - Travis/CI: Limit tests to Python 2.7 and 3.6 (removed 3.3 to 3.5) - Travis/CI: Update pypy veersions - #103 `Server.new_session` learned how to run commands in window on session start, thanks @grimpy! - #68 Make Server.has_session() use returncode, thanks @jlargentaye! This should make `has_session` more robust. ## libtmux 0.7.8 (2018-03-04) - Port `retry` function from tmuxp () ## libtmux 0.7.7 (2017-11-10) - Don't add -x/-y in tmux >= 2.6 if running tmuxp from inside client. ## libtmux 0.7.6 (2017-11-09) - Allow `Window.select_layout` with no args - Fix test where `bell-` was no longer ambiguous as of tmux 2.6 ## libtmux 0.7.5 (2017-10-07) - Hotfix to support tmux 2.6 session creation ## libtmux 0.7.4 (2017-08-19) - #65 Add session id to commands, thanks [@askedrelic] ## libtmux 0.7.3 (2017-05-29) - Exact matches only supported on 2.1 and up ## libtmux 0.7.2 (2017-05-29) - Support exact matching in `Server.has_session` ## libtmux 0.7.1 (2017-04-28) - #37 Improve support for formatted options like `pane-border-status`. Thanks @kaushalmodi. ## libtmux 0.7.0 (2017-04-27) - Support for python 2.6 dropped. New minimum version is 2.7 - Add support for tmux 2.4, pypy and pypy3 - Overhaul error handling when setting and showing options - Added `handle_option_error` for handling option errors - Added {exc}`libtmux.exc.OptionError` base exception - Added {exc}`libtmux.exc.InvalidOption` and `libtmux.exc.AmbiguousOption` - {exc}`libtmux.exc.UnknownOption` now extends {exc}`libtmux.exc.OptionError` - Overhaul version checking - `has_version` has been renamed to `get_version` - `get_version` will return tmux built from git master as the latest version supported by the libtmux version with `-master` at the end, e.g. `2.4-master` - `get_version` will return tmux on openbsd base system as the latest version supported by the libtmux version with `-openbsd` at the end, e.g. `2.4-openbsd` - `has_required_tmux_version` has been renamed to `has_minimum_version` - added `has_gt_version`, `has_gte_version`, `has_lt_version`, `has_lte_version`, - Fixed up documentation in some session methods - Added pydoc exception info to option methods in window and sessions. - Added `TMUX_MIN_VERSION` and `TMUX_MAX_VERSION` ## libtmux 0.6.5 (2017-04-02) - Fix `which` command - Add `TmuxCommandNotFound` exception - Add `tmux_search_paths` and `append_env_path` kwargs to `tmux_cmd`. ## libtmux 0.6.4 (2017-03-25) - #32 support for OpenBSD's tmux ## libtmux 0.6.3 (2017-02-08) - #25 support for working with tmux `master`, thanks @sloria. ## libtmux 0.6.2 (2017-01-19) - #197 use `LooseVersion` instead of `StrictVersion` for version checks. Thanks @minijackson. - Pin packages with pyup.io - #21 Readme fix from @huwenchao. ## libtmux 0.6.1 (2016-12-20) - #18 Fix logger, courtesy of @geekli - #19 Add support for `start_directory` in new sessions and panes, courtesy of @gandelman-a. - Fix tests and add official support for 2.3 ## libtmux 0.6.0 (2016-09-16) - Raise exception for invalid session names. tmux does not allow names that are empty, contain periods or colons. - Remove unused `target_session` param in `Server.attach_session` and `Server.switch_client`. ## libtmux 0.5.1 (2016-08-18) - #12 - fix logger message when tmux doesn't exist in `PATH` ## libtmux 0.5 (2016-06-15) - #8 new exception `UnknownOption` - #8 return `None` for options that are valid tmux options, but unset at that scope. - #6 major documentation overhaul ## libtmux 0.4.1 (2016-05-23) - update `which()` to find tmux via `os.environ['PATH']`. ## libtmux 0.4.0 (2016-05-23) - attributes for formatters are now accessible via `Session`, `Window` and `Pane` objects. `session.name` is equivalent to `session.get('session_name')`, you can do the same with other properties in `_info`. `window.name`, `pane.current_path`, `session.id`, `window.id`, `pane.id`, `session.index`, `window.index`, `pane.index`, etc. - `attached_sessions`, `attached_window` and `attached_pane` are now properties. - `_TMUX` metadata object changed to `_info`. - `.findWhere()` is now `find_where`. - README and usage fixes ## libtmux 0.3.0 (2016-05-23) - switch to pytest ## libtmux 0.1.0 (2016-05-22) - libtmux forked from [tmuxp]. [tmuxp]: https://github.com/tmux-python/tmuxp [@askedrelic]: https://github.com/askedrelic libtmux-0.45.0/CITATION.cff000066400000000000000000000006141475667375600152110ustar00rootroot00000000000000cff-version: 1.2.0 message: >- If you use this software, please cite it as below. NOTE: Change "x.y" by the version you use. If you are unsure about which version you are using run: `pip show libtmux`." authors: - family-names: "Narlock" given-names: "Tony" orcid: "https://orcid.org/0000-0002-2568-415X" title: "libtmux" type: software version: x.y url: "https://libtmux.git-pull.com" libtmux-0.45.0/LICENSE000066400000000000000000000020661475667375600143270ustar00rootroot00000000000000MIT License Copyright (c) 2016- libtmux contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. libtmux-0.45.0/MIGRATION000066400000000000000000000124571475667375600146030ustar00rootroot00000000000000# Migration notes Migration and deprecation notes for libtmux are here, see {ref}`changelog` as well. ```{admonition} Welcome on board! 👋 1. 📌 For safety, **always** pin the package 2. 📖 Check the migration notes _(You are here)_ 3. 📣 If you feel something got deprecated and it interrupted you - past, present, or future - voice your opinion on the [tracker]. We want to make libtmux fun, reliable, and useful for users. API changes can be painful. If we can do something to draw the sting, we'll do it. We're taking a balanced approach. That's why these notes are here! (Please pin the package. 🙏) [tracker]: https://github.com/tmux-python/libtmux/discussions ``` ## Upcoming Release _Detailed migration steps for the next version will be posted here._ ## libtmux 0.45.0 (2025-02-23) ### Test helpers: Module moves Test helper functionality has been split into focused modules (#578): - `libtmux.test` module split into: - `libtmux.test.constants`: Test-related constants (`TEST_SESSION_PREFIX`, etc.) - `libtmux.test.environment`: Environment variable mocking - `libtmux.test.random`: Random string generation utilities - `libtmux.test.temporary`: Temporary session/window management **Breaking**: Import paths have changed. Update imports: ```python # Old (0.44.x and earlier) from libtmux.test import ( TEST_SESSION_PREFIX, get_test_session_name, get_test_window_name, namer, temp_session, temp_window, EnvironmentVarGuard, ) ``` ```python # New (0.45.0+) from libtmux.test.constants import TEST_SESSION_PREFIX from libtmux.test.environment import EnvironmentVarGuard from libtmux.test.random import get_test_session_name, get_test_window_name, namer from libtmux.test.temporary import temp_session, temp_window ``` ## 0.35.0: Commands require explicit targets (2024-03-17) ### Commands require explicit targets (#535) - {meth}`Server.cmd()`, {meth}`Session.cmd()`, {meth}`Window.cmd()`, {meth}`Pane.cmd()` require passing `target` instead of `['-t', target]`, `['-tTargetName']`, etc. This change is to avoid issues mistakenly interpreting `-t` in other shell values as targets. Before: ```python session.cmd('send-keys', 'echo hello', '-t', '0') ``` With 0.35.0 and after: ```python session.cmd('send-keys', 'echo hello', target='0') ``` ## 0.33.0: Deprecations for splitting (2024-03-03) ### Deprecations (#532) - `Window.split_window()` to {meth}`Window.split()` - `Pane.split_window()` to {meth}`Pane.split()` ## 0.31.0: Renaming and command cleanup (2024-02-17) ### Cleanups (#527) - Commands: Param change {meth}`Server.cmd()`, {meth}`Session.cmd()`, {meth}`Window.cmd()`, {meth}`Pane.cmd()` - Use `cmd: str` as first positional - Removed unused keyword arguments `**kwargs` ### Renamings (#527) - `Session.attached_window` renamed to {meth}`Session.active_window` - `Session.attached_window` deprecated - `Session.attached_pane` renamed to {meth}`Session.active_pane` - `Session.attached_pane` deprecated - `Window.attached_pane` renamed to {meth}`Window.active_pane` - `Window.attached_pane` deprecated ## 0.28.0: Resizing and detached by default (2024-02-15) #### Detach by default - {meth}`Session.new_window()` + {meth}`Window.split_window()` no longer attaches by default (#523) - 0.28.0 and greater: Defaults to `attach=False`. - 0.27.1 and below: Defaults to `attach=True`. For the old behavior in 0.28.0 and beyond, pass `attach=True` explicitly. #### Resizing panes - `Pane.resize_pane()` renamed to {meth}`Pane.resize()` (via #523) This convention will be more consistent with {meth}`Window.resize()`. - {meth}`Pane.resize_pane()`'s params changed (#523) - No longer accepts `-U`, `-D`, `-L`, `-R` directly, instead accepts {class}`~libtmux.constants.ResizeAdjustmentDirection` (see below). - 0.27.1 and below: `pane.resize_pane("-D", 20)`, `pane.resize_pane("-R", 20)` - 0.28.0 and beyond: ```python from libtmux.constants import ResizeAdjustmentDirection pane.resize_pane(adjustment_direction=ResizeAdjustmentDirection.Down, adjustment=25) pane.resize_pane( adjustment_direction=ResizeAdjustmentDirection.Right, adjustment=25 ) ``` ## 0.17.0: Simplified attributes (2022-12-26) ### Finding objects / relations - 0.16 and below: `session._windows()`, `session.list_windows()`, etc. 0.17 and after: {attr}`session.windows ` - 0.16 and below: `session.find_where({'window_name': my_window})` 0.17 and after: {meth}`session.windows.get(window_name=my_window, default=None) ` - If not found and not `default`, raises {exc}`~libtmux._internal.query_list.ObjectDoesNotExist` - If multiple objects found, raises {exc}`~libtmux._internal.query_list.MultipleObjectsReturned` - 0.16 and below: `session.where({'window_name': my_window})` 0.17 and after: {meth}`session.windows.filter(window_name=my_window) ` ### Accessing attributes - 0.16 and below: `window['id']` 0.17 and after: `window.id` - 0.16 and below: `window.get('id')` 0.17 and after: `window.id` - 0.16 and below: `window.get('id', None)` 0.17 and after: `getattr(window, 'id', None)` libtmux-0.45.0/Makefile000066400000000000000000000036011475667375600147560ustar00rootroot00000000000000PY_FILES= find . -type f -not -path '*/\.*' | grep -i '.*[.]py$$' 2> /dev/null DOC_FILES= find . -type f -not -path '*/\.*' | grep -i '.*[.]rst\$\|.*[.]md\$\|.*[.]css\$\|.*[.]py\$\|mkdocs\.yml\|CHANGES\|TODO\|.*conf\.py' 2> /dev/null ALL_FILES= find . -type f -not -path '*/\.*' | grep -i '.*[.]py\$\|.*[.]rst\$\|.*[.]md\$\|.*[.]css\$\|.*[.]py\$\|mkdocs\.yml\|CHANGES\|TODO\|.*conf\.py' 2> /dev/null entr_warn: @echo "----------------------------------------------------------" @echo " ! File watching functionality non-operational ! " @echo " " @echo "Install entr(1) to automatically run tasks on file change." @echo "See https://eradman.com/entrproject/ " @echo "----------------------------------------------------------" test: uv run py.test $(test) start: $(MAKE) test; uv run ptw . watch_test: if command -v entr > /dev/null; then ${ALL_FILES} | entr -c $(MAKE) test; else $(MAKE) test entr_warn; fi build_docs: $(MAKE) -C docs html start_docs: $(MAKE) -C docs design design_docs: $(MAKE) -C docs design watch_docs: if command -v entr > /dev/null; then ${DOC_FILES} | entr -c $(MAKE) build_docs; else $(MAKE) build_docs entr_warn; fi serve_docs: $(MAKE) -C docs serve dev_docs: $(MAKE) -j watch_docs serve_docs ruff_format: uv run ruff format . ruff: uv run ruff check . watch_ruff: if command -v entr > /dev/null; then ${PY_FILES} | entr -c $(MAKE) ruff; else $(MAKE) ruff entr_warn; fi mypy: uv run mypy `${PY_FILES}` watch_mypy: if command -v entr > /dev/null; then ${PY_FILES} | entr -c $(MAKE) mypy; else $(MAKE) mypy entr_warn; fi format_markdown: prettier --parser=markdown -w *.md docs/*.md docs/**/*.md CHANGES monkeytype_create: uv run monkeytype run `uv run which py.test` monkeytype_apply: uv run monkeytype list-modules | xargs -n1 -I{} sh -c 'uv run monkeytype apply {}' libtmux-0.45.0/README.md000066400000000000000000000153661475667375600146100ustar00rootroot00000000000000# libtmux `libtmux` is a [typed](https://docs.python.org/3/library/typing.html) Python library that provides a wrapper for interacting programmatically with tmux, a terminal multiplexer. You can use it to manage tmux servers, sessions, windows, and panes. Additionally, `libtmux` powers [tmuxp], a tmux workspace manager. [![Python Package](https://img.shields.io/pypi/v/libtmux.svg)](https://pypi.org/project/libtmux/) [![Docs](https://github.com/tmux-python/libtmux/workflows/docs/badge.svg)](https://libtmux.git-pull.com/) [![Build Status](https://github.com/tmux-python/libtmux/workflows/tests/badge.svg)](https://github.com/tmux-python/libtmux/actions?query=workflow%3A%22tests%22) [![Code Coverage](https://codecov.io/gh/tmux-python/libtmux/branch/master/graph/badge.svg)](https://codecov.io/gh/tmux-python/libtmux) [![License](https://img.shields.io/github/license/tmux-python/libtmux.svg)](https://github.com/tmux-python/libtmux/blob/master/LICENSE) libtmux builds upon tmux's [target](http://man.openbsd.org/OpenBSD-5.9/man1/tmux.1#COMMANDS) and [formats](http://man.openbsd.org/OpenBSD-5.9/man1/tmux.1#FORMATS) to create an object mapping to traverse, inspect and interact with live tmux sessions. View the [documentation](https://libtmux.git-pull.com/), [API](https://libtmux.git-pull.com/api.html) information and [architectural details](https://libtmux.git-pull.com/about.html). # Install ```console $ pip install --user libtmux ``` # Open a tmux session Session name `foo`, window name `bar` ```console $ tmux new-session -s foo -n bar ``` # Pilot your tmux session via python ```console $ python ``` Use [ptpython], [ipython], etc. for a nice shell with autocompletions: ```console $ pip install --user ptpython ``` ```console $ ptpython ``` Connect to a live tmux session: ```python >>> import libtmux >>> svr = libtmux.Server() >>> svr Server(socket_path=/tmp/tmux-.../default) ``` Tip: You can also use [tmuxp]'s [`tmuxp shell`] to drop straight into your current tmux server / session / window pane. [tmuxp]: https://tmuxp.git-pull.com/ [`tmuxp shell`]: https://tmuxp.git-pull.com/cli/shell.html [ptpython]: https://github.com/prompt-toolkit/ptpython [ipython]: https://ipython.org/ Run any tmux command, respective of context: Honors tmux socket name and path: ```python >>> server = Server(socket_name='libtmux_doctest') >>> server.cmd('display-message', 'hello world') ``` New session: ```python >>> server.cmd('new-session', '-d', '-P', '-F#{session_id}').stdout[0] '$2' ``` ```python >>> session.cmd('new-window', '-P').stdout[0] 'libtmux...:2.0' ``` From raw command output, to a rich `Window` object (in practice and as shown later, you'd use `Session.new_window()`): ```python >>> Window.from_window_id(window_id=session.cmd('new-window', '-P', '-F#{window_id}').stdout[0], server=session.server) Window(@2 2:..., Session($1 libtmux_...)) ``` Create a pane from a window: ```python >>> window.cmd('split-window', '-P', '-F#{pane_id}').stdout[0] '%2' ``` Raw output directly to a `Pane`: ```python >>> Pane.from_pane_id(pane_id=window.cmd('split-window', '-P', '-F#{pane_id}').stdout[0], server=window.server) Pane(%... Window(@1 1:..., Session($1 libtmux_...))) ``` List sessions: ```python >>> server.sessions [Session($1 ...), Session($0 ...)] ``` Filter sessions by attribute: ```python >>> server.sessions.filter(history_limit='2000') [Session($1 ...), Session($0 ...)] ``` Direct lookup: ```python >>> server.sessions.get(session_id="$1") Session($1 ...) ``` Filter sessions: ```python >>> server.sessions[0].rename_session('foo') Session($1 foo) >>> server.sessions.filter(session_name="foo") [Session($1 foo)] >>> server.sessions.get(session_name="foo") Session($1 foo) ``` Control your session: ```python >>> session Session($1 ...) >>> session.rename_session('my-session') Session($1 my-session) ``` Create new window in the background (don't switch to it): ```python >>> bg_window = session.new_window(attach=False, window_name="ha in the bg") >>> bg_window Window(@... 2:ha in the bg, Session($1 ...)) # Session can search the window >>> session.windows.filter(window_name__startswith="ha") [Window(@... 2:ha in the bg, Session($1 ...))] # Directly >>> session.windows.get(window_name__startswith="ha") Window(@... 2:ha in the bg, Session($1 ...)) # Clean up >>> bg_window.kill() ``` Close window: ```python >>> w = session.active_window >>> w.kill() ``` Grab remaining tmux window: ```python >>> window = session.active_window >>> window.split(attach=False) Pane(%2 Window(@1 1:... Session($1 ...))) ``` Rename window: ```python >>> window.rename_window('libtmuxower') Window(@1 1:libtmuxower, Session($1 ...)) ``` Split window (create a new pane): ```python >>> pane = window.split() >>> pane = window.split(attach=False) >>> pane.select() Pane(%3 Window(@1 1:..., Session($1 ...))) >>> window = session.new_window(attach=False, window_name="test") >>> window Window(@2 2:test, Session($1 ...)) >>> pane = window.split(attach=False) >>> pane Pane(%5 Window(@2 2:test, Session($1 ...))) ``` Type inside the pane (send key strokes): ```python >>> pane.send_keys('echo hey send now') >>> pane.send_keys('echo hey', enter=False) >>> pane.enter() Pane(%1 ...) ``` Grab the output of pane: ```python >>> pane.clear() # clear the pane Pane(%1 ...) >>> pane.send_keys("cowsay 'hello'", enter=True) >>> print('\n'.join(pane.cmd('capture-pane', '-p').stdout)) # doctest: +SKIP $ cowsay 'hello' _______ < hello > ------- \ ^__^ \ (oo)\_______ (__)\ )\/\ ||----w | || || ... ``` Traverse and navigate: ```python >>> pane.window Window(@1 1:..., Session($1 ...)) >>> pane.window.session Session($1 ...) ``` # Python support Unsupported / no security releases or bug fixes: - Python 2.x: The backports branch is [`v0.8.x`](https://github.com/tmux-python/libtmux/tree/v0.8.x). # Donations Your donations fund development of new features, testing and support. Your money will go directly to maintenance and development of the project. If you are an individual, feel free to give whatever feels right for the value you get out of the project. See donation options at . # Project details - tmux support: 1.8+ - python support: >= 3.9, pypy, pypy3 - Source: - Docs: - API: - Changelog: - Issues: - Test Coverage: - pypi: - Open Hub: - Repology: - License: [MIT](http://opensource.org/licenses/MIT). libtmux-0.45.0/TODO000066400000000000000000000003751475667375600140130ustar00rootroot00000000000000==== TODO ==== - Remove duplicate between ``_list_panes``, ``_panes``, etc. - Retrieve active windows and window count from formatter command - tmux PR to get count of sessions in a server - Allow select_layout with noargs .. # vim: set filetype=rst: libtmux-0.45.0/conftest.py000066400000000000000000000043751475667375600155260ustar00rootroot00000000000000"""Conftest.py (root-level). We keep this in root pytest fixtures in pytest's doctest plugin to be available, as well as avoiding conftest.py from being included in the wheel, in addition to pytest_plugin for pytester only being available via the root directory. See "pytest_plugins in non-top-level conftest files" in https://docs.pytest.org/en/stable/deprecations.html """ from __future__ import annotations import shutil import typing as t import pytest from _pytest.doctest import DoctestItem from libtmux.pane import Pane from libtmux.pytest_plugin import USING_ZSH from libtmux.server import Server from libtmux.session import Session from libtmux.window import Window if t.TYPE_CHECKING: import pathlib pytest_plugins = ["pytester"] @pytest.fixture(autouse=True) def add_doctest_fixtures( request: pytest.FixtureRequest, doctest_namespace: dict[str, t.Any], ) -> None: """Configure doctest fixtures for pytest-doctest.""" if isinstance(request._pyfuncitem, DoctestItem) and shutil.which("tmux"): request.getfixturevalue("set_home") doctest_namespace["Server"] = Server doctest_namespace["Session"] = Session doctest_namespace["Window"] = Window doctest_namespace["Pane"] = Pane doctest_namespace["server"] = request.getfixturevalue("server") doctest_namespace["Server"] = request.getfixturevalue("TestServer") session: Session = request.getfixturevalue("session") doctest_namespace["session"] = session doctest_namespace["window"] = session.active_window doctest_namespace["pane"] = session.active_pane doctest_namespace["request"] = request @pytest.fixture(autouse=True) def set_home( monkeypatch: pytest.MonkeyPatch, user_path: pathlib.Path, ) -> None: """Configure home directory for pytest tests.""" monkeypatch.setenv("HOME", str(user_path)) @pytest.fixture(autouse=True) def setup_fn( clear_env: None, ) -> None: """Function-level test configuration fixtures for pytest.""" @pytest.fixture(autouse=True, scope="session") def setup_session( request: pytest.FixtureRequest, config_file: pathlib.Path, ) -> None: """Session-level test configuration for pytest.""" if USING_ZSH: request.getfixturevalue("zshrc") libtmux-0.45.0/docs/000077500000000000000000000000001475667375600142465ustar00rootroot00000000000000libtmux-0.45.0/docs/Makefile000066400000000000000000000151401475667375600157070ustar00rootroot00000000000000# Makefile for Sphinx documentation SHELL := /bin/bash HTTP_PORT = 8023 WATCH_FILES= find .. -type f -not -path '*/\.*' | grep -i '.*[.]\(rst\|md\)\$\|.*[.]py\$\|CHANGES\|TODO\|.*conf\.py' 2> /dev/null # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = uv run sphinx-build PAPER = BUILDDIR = _build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: -rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/libtmux.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/libtmux.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/libtmux" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/libtmux" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." redirects: $(SPHINXBUILD) -b rediraffewritediff $(ALLSPHINXOPTS) $(BUILDDIR)/redirects @echo @echo "Build finished. The redirects are in rediraffe_redirects." checkbuild: rm -rf $(BUILDDIR) $(SPHINXBUILD) -n -q ./ $(BUILDDIR) watch: if command -v entr > /dev/null; then ${WATCH_FILES} | entr -c $(MAKE) html; else $(MAKE) html; fi serve: @echo '==============================================================' @echo @echo 'docs server running at http://localhost:${HTTP_PORT}/' @echo @echo '==============================================================' @$(MAKE) serve_py3 serve_py3: python -m http.server ${HTTP_PORT} --directory _build/html dev: $(MAKE) -j watch serve start: uv run sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) --port ${HTTP_PORT} $(O) design: # This adds additional watch directories (for _static file changes) and disable incremental builds uv run sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) --port ${HTTP_PORT} --watch "." -a $(O) libtmux-0.45.0/docs/__init__.py000066400000000000000000000000551475667375600163570ustar00rootroot00000000000000"""Documentation for the libtmux package.""" libtmux-0.45.0/docs/_static/000077500000000000000000000000001475667375600156745ustar00rootroot00000000000000libtmux-0.45.0/docs/_static/css/000077500000000000000000000000001475667375600164645ustar00rootroot00000000000000libtmux-0.45.0/docs/_static/css/custom.css000066400000000000000000000010341475667375600205060ustar00rootroot00000000000000.sidebar-tree p.indented-block { padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0 var(--sidebar-item-spacing-horizontal); margin-bottom: 0; } .sidebar-tree p.indented-block span.indent { margin-left: var(--sidebar-item-spacing-horizontal); display: block; } .sidebar-tree p.indented-block .project-name { font-size: var(--sidebar-item-font-size); font-weight: bold; margin-right: calc(var(--sidebar-item-spacing-horizontal) / 2.5); } .sidebar-tree .active { font-weight: bold; } libtmux-0.45.0/docs/_static/favicon.ico000066400000000000000000000443761475667375600200330ustar00rootroot00000000000000 hV   F00 % hD(    ddeddeddedde""""mmommommommommommommommommommoddeu9u9u9u9ť~ť~ť~$$$$$$pu9u9u9u9u9ť~ť~$$$$$$$u9u9u9u9u9ť~u9$$$$$$$u9u9u9ť~ť~ť~u9$$$$$$$u9u9u9ť~ť~ť~u9$$$$$$$u9u9u9ť~ť~ť~u9$$$$$$$u9u9u9u9u9ť~u9u9u9u9u9u9ť~ť~u9u9u9u9ť~ť~ť~ѱѱѱѱѱѱ̵u9u9u9u9u9ť~ť~̵̵̵̵̵̵̵u9u9u9u9u9u9ť~ѱ̵̵̵ѱѱѱu9u9u9u9u9u9u9ѱ̵̵̵ѱѱѱ{u9u9u9u9u9u9ѱѱѱѱѱѱǓ{{{{{{ǓǓǓǓǓǓǓ(0   { VVW==> VVWggheefdde::;{ z%&)BCF_`cPQS88:88:;89GAAd^^lgfkeekeeUPP@::?::LFEd\[z*"0'6.&6.&6-&6.(:40\WS}wr|wr~}ta~a}a}a}a}a}a~a~d{gxd2e4g5g5e3m?ex{{0/000101Qox:x:x:x:w9|@Xpȧ~ɨ !!!!!!7Ku9u9u9u9u9t8t8[ģ{tθ#"$$$$$$$$u9u9u9u9u9t8t8]sNԽ#"$$$$$$$#u9u9u9u9J[\oq{Bѷ#"$$$$$$$$u9u9u8u9\ŦŦƧq|CѸ#"$$$$$$$$u9u9u8u9\ŦŦƧq|CѸ#"$$$$$$$$u9u9u8u9]ƧƧǧq|CѸu9u9u9u9Vssã{q|CѸHGIIIIIIIIu9u9u9u9y?}D}Ddq|CѸu9u9u9u9t8s6r4Z waŬu9u9u9u9u9v;|Cbť}ť~ҿu9u9u9u9t7|CiãzŤ}ť~ҿؽؽپپپپپپʱu9u9u9u9t8y?WqƦť~Ҿؼ׻׼׼׼ؼؽؽĩ˴u9u9u9u9u9u8t8UtĤ|ҿȯ˴̵̵̵ʲȯȯȮǮu9u9u9u9u9u9u8w=MtֹȯͶ̶̶ԶԶԶԶs7t8u9u9u9u9u9s7w>VRSebbjggjffheejffjggebbVRSB>>3//-)*.**0--722D??[SSZldbG  &'*9:=JKNWX[`addeh^_bTTVKKMHHJHHJJIKKIJMIJQLLZTTc^^keemhhmhhlggmhhmhhkeec^^YTTRLLOJJOJJQLLUPP\VVb\\e`_"%""&##&##&#"&#"&#"&##%""%##+)*><=<@N_lqo7o7p7p7p8p8p8p8o6o6s;~Karz|}{yçҽk4!#(((((((((('&,?Vgnx:x:x:x:x:x:x:x:w9w8zu9u9u9u9u9u9u9u9u9u9u9u9u9z@RiâzĤ|áyǨk0$$$$$$$$$$$$$%'((u9u9u9u9u9u9u9u9u9t8t7r5q3u9Mgáyvlqѷk0$$$$$$$$$$$$$#""!u9u9u9u9u9u9u9u9u8t8s7r5q3u9Nh wmZ\ɫk0$$$$$$$$$$$$$##""u9u9u9u9u9u9u9u9v:w~FQ]mȪīкٿپū̴ͷͷͶͷͷ̴ǭ׻ֺֺ׺ֺֺֺֺu9u9u9u9u9u9u9u9u9u9u9u9u9u9u9u:z@Nbť~§ʲոո¦˳ͶͶ̵ͶͶ˳ĩ׻ӴѲҲҳҳҳҳҳs7t8t8t8u9u9u9u9u9u9u9u9u9u9t7s6u:|CSmҹɰԶԷ¦˴ηͷͶͷη˴èֹѲЯЯаааааs7s7t8t8u9u9u9u9u9u9u9u9u9u9t8t7u9v;{BXʭɰԶշ¦˴θηͶηθ˴ĩֺҲЯаѰаааϰy=x A[IDATxgUUo3USSa> $n ( 9)HAAQ0"b@0(E1 ߿m>wX}꩹Oa_Ƙ0 bA$IQ8O:tqa' $E{VzuOE?nvx8@x:Aw఍±HB "+;,q8P9Q *WA:~/ gKA_9d@* -79sr Z9gLğN%vƙ ',#}Q+d3$ !:D@Ho\8ATY7"b6d9DgQy('rı3-T"Ⱋ9Fz/DK8d]9?ڂ"k9|ʤ@>[l&#Ϥ"$q 5L4$5 "u_&ʹq L0 ˭ "Kps6sf!XA B(ASl_#nu6yC!D *_2ppٻzSwA BJ=4 :}fLD"Q4hаT6پwuO?l]Z-/EVf̢K̓k17}DUEomoz~;BgƯiIJ[uHJW& n7, j֬KejcW~VACu~_c%buν}j~!5iҌg"b"GrC\yeR9jl{IݕϪd8erG#c"-0[)]^S~ }۲< 7a9qO?ɷO-ӳETN{bz!O떗_t]ꞺD"MzWꡨ:ZR5ץw(y5D 'Cݥ_zeʊSIm~%k2j̸H5QǞpűmA#MْjX,M?^;Ad ş~^7+Wʾ-l&R=S}fiOI Poub,hSi,}QK/krW':0ߨ moEho˓ށڵ?jU)V)^~575FmMejT,ImtHZjvH[(Lǡ1tHUm څƼ8%JDyyTLuu{MyfSQl_-s A W{]LyK^RcR G317?fnҸ#!aACCQT30MBϭ6Xy{m=J;~WA {k -I8 P?f*ȫʝMAd.]EDauYg~W9;6qO}j""'^ ߡ O/2tD7Ys.KW82*GHۚ|Y$ALn(E? Rz:2>.H8(8Ŝm*iZl,2*G_ES{ RLV Zvb: "T(ؼe"(&͉x{5`W;ia(i5Jgﾴo9kze끏㒪b! r۱ PcX,TLnC`L5>D7^a՗A B|K*LMdډ>T:L+ρpc[s^Q#Քqv>xꙍǑS&AߗH 2ylAY]cAϵ=:^kxҢ٫W_(hڌ<D efcǬI3bhχj_rgUv*L]vxSYy:1uj_ATPxs%k6 )+otH8"yToNBaa{W@xu^X؟VxfbSUbzmk&]|ZTL D"e7[7;uyD7{e|+8g@[%>+F^A^i1[TRH4iLf}{&cnfk޼eN=[WLEhԨ;/A~ ]̪4|^2#FpͲ>fF!G>z8ymۛp1hhHIת?j:QکSc]ڽίrnNky-9Q5y Z!ٍVxA[pd+{Ӧ2 UO%g,8߶UC{0%J ¼My礷ez=pP'll# psk)_kr.9r_(f;A ow[l])e+bZvZF%w(*mڞS^-`q#y8lkWvWVms6I =+wy+&6M^(U6QҶmW!DQr[ TP[:MMD45Eiҫx[*A K0I<6mh,]QV&l?7T˪f Wq[K/T%͞zf#k2(wԪY ajdc랴1A`SwҮ]{kcPS[Š)>m6mЭCϪ;?9G`EXylzĵ?;߳7u *2T.#rJڵz ֙ A~+^mqQn\o'M^&;˺tJֶ]>J6㪷\7Ї3yt}Ӳ'M(tWՏPBMBT(c(zy,'nJ9H-"V6(0y䨱3;GACBW-xfՃ=8[536TT(GٚlԘqܠxK[Al+[֢+AA4gDD=n}(&ׂHo -1/kz꾱a6ֱ:fGwqE.JHm35QaArm (3=lٔ;6#\M6wk >̘5u +@oğ}iP>gU "2lŽE1}obudaqY kRI\"eEǟ؀ BA4 J TV֪BIDjW qff> "m#UW(i3ܸv۞AVtŵ}ƕZ|gv)KEl{VN"Q<ݴz(MZox*eNvn2,1 "*Km܄If]ܷ]\V$ "#mHUIĶf[Hb,Zx]5AԼsen]"or.aa7AT^}D1A>k!"UE,r䩼^-FmOIH2[YDԳn6m ͥ_׽XyR5gU}AO?UW5M *HmgH)FaVNHuQcRg[$ 6,Ad^Y}H~no\T)Qfԭ^\Ƕ)6?os3V6-/ bmFokJx176( 7 b(3mY({韘 AT@v/;$&)AqT٫O֟U]vz Sl2=D,,[G^< X^v/٘HAjԊEm+Vޗg#V~{mۛ6n$3(&GrlԨZ3A炨-K^l'>Rxۂ(M?n[y?ޮ:C6]nBF#0Z |ekV%&MjzUgr[׫-/MAnQI+[Q]@c =]!A#˖k2u,kR7()٭CY^$AW5i3f%!k5j7[(#A +[_vXhU 'DHckkӦͭ\jfj8qT6߅*d¤)֎X׍Z<"(|q-0uֳ W`)(V`T֔-j2y=x-ա~`>`WR pn=Lc{fnS`t 5qƥ"(H(h¯G I J e ̵u-S JW50>p/ny[6mb.8|+cxq"(iԾʸT֦E J  [22 JR5j[#GN X۸>s+QZ.r!D5=ʎ:&UQls/BAq4$i$YӎѭYv͵ׇ:V۲{V:hkY|2Ah!JDTQ6Im65piC zMJڪGgUJLnKA4QٲDl T [ AAԩSgׄjE6m )3RAL<6 :Pqo8y#D" FiCjH=Q "Z}Ǯ/>.[@1k)?ރq;CY |̸"(W 6"81-< DW50^4RgbAow6#T Ε ;W"D"KZd/6m"UѶg{L_a~6ڔ v O?([ۚ6Ϝ=/Խ B!,n={IeކwM[u<DiP>?M^*Gu&1kyQ`ry2M Y\ {kV)m rm4 B!,aYfISQIp{*y.G-#T)i~hOb+j=l b'Or/U4A~yiغ'Ԓ1ZQ/5#G }/"D2Rng6nvGNӇc J o@׆RչMϻ[jdJ/+" "=c0m}xsk#C!D/6}lQ *gWv5*!(=ɵp c*,l^D!D)/)ALYBDV3Depeyw~cD JgU5LNjD%Ojjn4h =6m=e A BĂEKPJp}wDǞHzCfoX>SAwK$t/*C(fC6l`jVIL_Cb߳}Wʸ:G-/jW{e}+6-ӭ3֡KnKDIt ߌ3Ω4-gY~i߾NL@ݺ=D"Q s3GםpQAl(c(h>Qrb[xicPi p4 ҽw߻n[ԳW3gBWLl/z%Q#sU>D"QL>P.M"2,];@(HHԶAupēONx"e4m~%3rXSf=S.8|ӳw_׋䷖E/t[;wnڋ bMFe1_[ҎKт kq8DzC#Ċ{WzU[z եkY5D"Q͌/Sf-t(9S!;^s9Pʳ Sc:EmB[$Ӕ` jӶ0(R%fZD^UI-H$֮Cű> ܷzp̳%78Ϣ iSJ+%J{5ljw+xw~ "D@J3n[D\Yy<bףVۺq!BPGW~f)n܊B]_],2cNpv-T\+;xmۛH'T_J[n7>W"D" ˖fAOMꛮZ]ۘaۚѽ ([17ula _e. Oө7ЬU[x9䟁9cV=fBS/A,Tdz\Ҭּ;9_ď_>W,V`j]V@53kƵ1,<7V{$OAuo};\Tλ $Pe 3[51ݯiɼ@㜳2WK*Iz9G"53o-,~榕M@yKfߜډB 0C;0ƴ5/S7s *܏_j: fB_Z0_"H8 2f ?B'Ԭ~)s8%?ˆ @A^tǜԠ.lwu4ms ڗWx,_/y[ޜ$Bǝ1Aq9AFϭa^,V֨QJhJrs>\WZ3vϪKƚ%\xW7X! .q֭yZN٨. gjidw @Q_5)iݤV+QsZZ< rcúVAPѨYR7M"iө^]ETބΩcOn夛?!~A}yuӭc 36RLғPJj"%56;skw4s Cl\myXJJnZ}]Z4!ڊ{aj3SȂ *w2o:bL[[f:Pnt֦CƉ-~-A+?(@K.vI:U kTAtIɺ *!*9,v8(rKr&J;sPVK=sA"fs;Z')$Q(EB3s4H2'E̢\;+D" [ͪ5HbIENDB`libtmux-0.45.0/docs/_static/img/books/ibooks-logo.png000066400000000000000000001473361475667375600225350ustar00rootroot00000000000000PNG  IHDR]f pHYs''* O OiCCPPhotoshop ICC profilexڝSgTS=BKKoR RB&*! J!QEEȠQ, !{kּ> H3Q5 B.@ $pd!s#~<<+"x M0B\t8K@zB@F&S`cbP-`'{[! eDh;VEX0fK9-0IWfH  0Q){`##xFW<+*x<$9E[-qWW.(I+6aa@.y24x6_-"bbϫp@t~,/;m%h^ uf@Wp~<5j>{-]cK'Xto(hw?G%fIq^D$.Tʳ?D*A, `6B$BB dr`)B(Ͱ*`/@4Qhp.U=pa( Aa!ڈbX#!H$ ɈQ"K5H1RT UH=r9\F;2G1Q= C7F dt1r=6Ыhڏ>C03l0.B8, c˱" VcϱwE 6wB aAHXLXNH $4 7 Q'"K&b21XH,#/{C7$C2'ITFnR#,4H#dk9, +ȅ3![ b@qS(RjJ4e2AURݨT5ZBRQ4u9̓IKhhitݕNWGw Ljg(gwLӋT071oUX**| J&*/Tު UUT^S}FU3S ԖUPSSg;goT?~YYLOCQ_ cx,!k u5&|v*=9C3J3WRf?qtN (~))4L1e\kXHQG6EYAJ'\'GgSSݧ M=:.kDwn^Loy}/TmG X $ <5qo</QC]@Caaᄑ.ȽJtq]zۯ6iܟ4)Y3sCQ? 0k߬~OCOg#/c/Wװwa>>r><72Y_7ȷOo_C#dz%gA[z|!?:eAAA!h쐭!ΑiP~aa~ 'W?pX15wCsDDDޛg1O9-J5*>.j<74?.fYXXIlK9.*6nl {/]py.,:@LN8A*%w% yg"/6шC\*NH*Mz쑼5y$3,幄'L Lݛ:v m2=:1qB!Mggfvˬen/kY- BTZ(*geWf͉9+̳ې7ᒶKW-X潬j9(xoʿܔĹdff-[n ڴ VE/(ۻCɾUUMfeI?m]Nmq#׹=TR+Gw- 6 U#pDy  :v{vg/jBFS[b[O>zG499?rCd&ˮ/~јѡ򗓿m|x31^VwwO| (hSЧc3-:iTXtXML:com.adobe.xmp Adobe Photoshop CC (Macintosh) 2016-07-04T15:43:49+02:00 2016-07-04T15:43:49+02:00 2016-07-04T15:43:49+02:00 xmp.iid:3fbf99f9-e5df-433a-a946-c75035ecfc06 xmp.did:ed838574-bfda-4020-804c-fb0fbe7874e0 xmp.did:ed838574-bfda-4020-804c-fb0fbe7874e0 created xmp.iid:ed838574-bfda-4020-804c-fb0fbe7874e0 2016-07-04T15:43:49+02:00 Adobe Photoshop CC (Macintosh) saved xmp.iid:3fbf99f9-e5df-433a-a946-c75035ecfc06 2016-07-04T15:43:49+02:00 Adobe Photoshop CC (Macintosh) / image/png 3 sRGB IEC61966-2.1 1 10000/10000 10000/10000 2 1 1280 466 ?j cHRMz%u0`:o_FIDATxwtTU'$: k(]:RDiEEĂ]AENR{ｇs\E̙g+&}\dԢ I$TDR^II߹$ OIWtKR;,;V I1.J$鼤 ;sܜeQ|%UT[R%IB0eIG$tPVI;vh w`d"?I-$@RU>[4I%mDvā:T02jQ^I$uT/]Ւ~4cv20#yJj'_Ē%EJ.鷎ڥs0v+FF--i% :%ISDȨE~߭pu%M4cvf?\s@$)iۤ*p|햚ݑ?v/a)?fHڱCh:0) stYң;[dFV/$ Wb銏Wbbo'vbn'%)#=]$g+))233-e/y{GO~~~S``<<<9O$ұCTk6j`dԢfKjbv:{Ο?.ҥ7ϝ'8Bp" -0-ZTZI;vhwZ ZEYUgffڳg;ǎܑylr*[V1ЊHjױCh*#ZL|IzڻwoXvƍep!!yQ#B6T*U] ԱcvPG%XEG_ӒKz0/$$7k֭(_|j:vh2;dGo$쾚ӧOk_asxxxaҹË[ImSre͙11zjeffr鹹Yf ns%5ءݖ,%+'Fe7̝d \>ٳ:wIZKR5K>}nܸA ܼySǎ3rJ?j~.ҳwM ٳធjH_ecǎ8`CG1zJM uFcǎ= l(>>^׮]3rJy ,=s sg^V#J*lq'ϓ4`/]2rxXd"?wIa:x;tS/\26PK*bׯ4`17 o[]'I7bI8KkѩJ@)==)!XA,)vtM#qlщID#,&0`Gkty%Zm =KTmC p`Iy `Ow.32H$#Kqf.D8LCK DN]gfp",\-c`eo: @`_,\@Q\'RJL*RͫY(y|S6lZ5kv*?8= \V``w^={i&rw7Ӽ!!pzzuWΝv (p3OO=ؽ2DjղJ ?3gia*^8/8%}>rwmF+O\l,a,R驶mڨE*\$ҥKZj/Y4BBE%qjۦMKNN&t)*W\JOO͛7ظ8%$$Ff_dɒwC~Z'OO>k ^>\/|||lo\|<&ɓ'jFDv*]-bEhѢ+W:{>#Gj:~233 6ѻW/M:UyLɒ%tb=ܷfϙCh(phժUITjU}U.`%AAAjղZjF TRjCE V…Uv]LL֮[H]v S+WNS&MkO>uۧ#G)w"<<<+h v)Iҥ@6xyyKu\]B u,jyjyz㭷@ //,=]۶Rjj*!h\?k?~ gU``Ío\$XM"Eo<)\XgΞ%D`38gyFc>aMѣGpB9Y ɝ;wB ;(;///}׷Ì)99YgSXhKnʡǹq&%&&r`5ײQ566ӰؕC$i޽JOOwѾ];m߶lr.>]ٵh>> Vygq{ׯkϞ=\<xyyIz}{uxw{u_>}T|y?q&Lhrέ߯$%%i@6ciANo˖q?4mD˯/R @WƏc]|ihMHH>=KK>_;(0UHHf<=fܹ\4c>PE>ozcG]x@+ s&$$h\4@/#;xZikф8q`'5!!AǎӞ{bJ-_\ׯ$`թ][ 6T*UTxq(QBslZZΞ=Nڴy֯_W\.!!!j߶5j5TT)㘛7oԩSڶ}VZESG(҃N ҹfS'd -d"C\xQ*U۷ ?߯‹r;Zp-[\V/7@V /(H&P$ Qv sQ8s&uA=zӦ5Rr 777=ҧ8w~[yCBLG aòTDˊl=<<ȑڸnԯoxzzjjƍ*jBC5jqqqoxN:.T}WV_삂4g,}Wma777=7t.^+ɟ//\S(_޼6W_7lP%lȓ'.^7FUB]ZujF;j~-[1aDrIxnwOp kתSǎ6QÆZlECZuע]VlܨV-[ڏ3m`yjr5mԱ тHUTl (U~׮]ޣdװNw蜂 hz ~~b25iآ:upXK/^~?>Y_գ>#ԧ&荷۷zljj7kS~`E1v&w ֭[f$M[:t??kz^ERJj׶,\L3d#?latM=;t(%J:0xxx nש۷e6JJJ#i.yi.T9R ^=#FܳoVVuk.cjݪCdRXQ/$ի0q*Wo.K} !i7 e:x_{u;  (`蜳wYS _5j԰.s׮Rt 4KAG  S>9z˯fkjն=jQg/%K'L;+A=~j6[gi6 qF*_ӌw5lAxxsea+֫bqao~rj ÆY|AM>} /5z͟cccչ[73Vj3}z񥗔_zeYjղ%7.glg>C;.1V|`*d'N'V}yDE,:v)Z~]vY4PjҸV\ɍ]YXӾ}Vñc47ɘ1{gYvn޽zjȐ,Сڵ} Z4on9@Y.;;x<,Kk8w[‹3` 7KKw{aԩ|Dڥ @[R /qG/5h@UPsjժjժiϞ=vRrrr9t" }Oq c 0,iղg/hww _R%W& K:uܵk7, 'ʕ+sRRRrl^= KE &Q`Znx钺a,+3Cڟ|rl^m,q6lh8oXg/]o˖6 })UJ.mܢ_,Dݻ9`" ^ ~kWNt6T X"+|@WP ~U^ݢcWY⪥8aFC8+;믦o6_ Sn]~zSr8p萡M &͛;n߾ݻ3Sݺu9Y9ԪUcF6b)U$7:\^M3]c:xMj֬i,YٳM. kؠÎԥ֬]˅,t+19Eh[jժ6!![gyyyJ*ټeMƶi&}A7:Kgp3nd0@9lϙVBܸq9aaa92*+[|;owz!]@nt%JO>Ͼص{z(kb~ dCԙ`+b`։ǫS.Za 0\Yxq3aD\ ֺukթ]-/>9G1ͣǎllǏ7t|hhܔ$))@b+\Qо}@@ˆ61sW '>'88&@gݥˋ.hq 7 p㽽X.,j!UVu޽[4dW&w5.MOO&K3|4::fcvs|r Cʖ)0c/jڢ_ΤKII&K t-“\>>\TUQ`HxxǐaÇw>=in3omsTFF $-nr5nn4.V#ӧOi0q?p$۶o7|NN+:K.qc˂~n??k%F$ڦNڵ- 3umCԫ[We˖1;O:Ml\6礤rQV.,/{=Z|90IZZVYm:oj9" eddX<ƍb'N&K3Hll3t|JJ ; d7ّ?Dcxf/Ybؿ_??zta5uppYY +W:>,,fc+Uϟ?XKX;W.YRz̝;W ְ1?wc )Mٳg _Ά/(WQ ۲e]ۗgV6v5l}戌(7C?;y/VZ߿?`u]zz~gլSG;tݻ S>O_\>Ç[C͚P\E]7_q^ݺٱc`uX,{9}=)WN맽{2`g .4۶o؊+*ep/$i15kT~~~>g(@,u-::mhߪ}*]y=u8t,;~X5iإٶm{c%oyvg`@v:CwEPކ?sX ݾ}[n2\LؼeFoJEo˖)==P4ouqyyyiάY*_fseCx1 lg=!o޴..\WvLOյKC,^` |<..N~|yF4QHjܴx-Y4|Ĉ,'OZBUVu|",>dɒzOyFve/\Pɒ%]?~\2t &b3(W\y,nR)(0|J VBP!ɗO^>>W֨:vԐg7&i֭JLL$4 -XP##tnyjr<_~2Q?_>x Po&nŊuS ߠ~}Sf)gy9 $*66C(,5R9rD+W|y꧙3ʕ+oݪo$cnnnjղfÏ?*Icx{5tW| 0 @pGW^U6vr ':IxEC?ԫx3}].\0t|Oޜ&&&F&O6tNR46GQ syM6`O"lЎ}ȞPUTI*EUpa !MKt5]~]qn/\gٳghoͷ;o6ʖ-QQZn.Z -҆հAܩ,ZyD/]r}1CǗ)SF}yD~o&9z]:wV:ueVcс;wnyl`PuѳCO&[^xAo)OOc?^Y0@BE h\-7Wmoxb /VL-g,]TK.o˖"ŊUΝվ];5jС?_>uE]t$=wNҺ>t xQ#X]ի[Wu\zעjԨϲFFi߾}ڴy߯g*::Z)) _*YU\9.]m7_ߔ$-_\7t^6L/X]rE>ʝ;+W.9{VmKWm۷.vk̇j̇Ztb_ OOOEFEۃ:gAiz:{njۦ&M?;w… [nznP+q}y>|`: ]}vֵڶi#hX==n߾%Kj/hE.#oѰ0u]ݻu3=+ZTC~ZC~Z7nМsw߹s5t1r$HJNNVݵaz)\8TREUTڸ,Ι;p|suֿS|ϳQ9rD ٳ oF;wf*߸qCPttRRRʩxߤɓ5yn^M 0p6wӧԥsg(tNϜєɓմIq100P~Ӊc8Uɣiڵ:^>\ w{O|P7n ,cΊw1U^]~~~| ?~z7eU%&jqFҹz6[g`B= ܸ!00PO=ܩU+Vw^Y/sV߇~ӱÇȑrjnnnjִ>]ϜoqJ.}WNW_|+&SRDZZt)aHڳgkJW]sxxxvZGz<\_~iv\`fq;x~7O={V ͫQｧ'Nq\GClRtV`Ax%>p1GԞ; 2R)4_:#ٳ9>ݻwAFڶmC~̙ZfufVߍѿ?X1cOdkqk5zz=?QDUP!C?zT_|gӝ9uJc>fZC۵ٳuI;*Yd'[j-7j٪ToR8YgJj6|.]cMJJ2p3gΨi;nZ׫gZۙzGt9s֣͛U/M߯sۼ׮ۃͷf_]PD;wn:z:Ts;oH:TՊeĹTRzuquA:^{Uz5ig}g[}>}rr>p@/3sڧwoܿ__|Q^^^3g}l z񥗴jj.Ν;5nxuIQ=Ì6-}jӮ6o9sdF]믫tٲ?`pAu4Џ3gZ\9fkںmԭkٮ^.,;!!A5k3LyoǙ3U-"B=bT x r*U/Pm'A AAA==z2ki{Oz'eVB8u>0AN@5jPjժhXXב#GtQݻW;v={tMaMڸi ϯ۫sNj԰nFF:۶iݺuZr>yZ/ vmwޭT'|.ڡCglK[^ΩeԱBk=.u! 8Poz={J*Yn/33S;vOfivy?Jҍ7w^C;8L(҃N ^1B27uMȨ(8qp d edd1cިQJNN&8=___-ZTa Up< ?vMNN۷u#6Vqz.^ [mͿlٲbŊ)X1(P@܊9n񊍋h]xQΝӑGu1%%%9k+?ZjuL2 ̾Xܸ˗/ĉڳwmۦ.0QժeKթ][JRBtkt?ݻwk֭9nZհaCխSG%KT%UP!ʥeff*>>^u%8yRǏז[ifflg٣?)UEDDhIlMgϝ5k}v߿_GUl\|y|򊈈Pڵբysfl:~8a@dȔ(777=3d>5YAEiii̪իk-z⩧?.%O>>*_S.]{شi!Bܹsr ,zL疝KvEV]]&8${-M?}4& &.n޽{}0@X܄ELL !!^};vLW^%|Da]>>>ERR!!^Fm\=g& $nTjj7eTLFVOO`YSNs0@X pb111zM z㭷 `c~1CSM3۷oW޺qa9Y*'Ԑ! QN۷գW/mٺժٳNqxb.8U&l` *___B 롇qzǬK`ںm{.[֩2N5匙,Uʕ{#8t yYG\r;6}GDRpwaUC|NeܹX^{uCjɪǞxgv`XUJJ !?~Bӹy>3Fc>X5kTMUB JMKSbb.\Gh֭ڴyRSS 3 4~)$$D233}vm߾0'`X-)T !l *33 ,Y6AVGʖ-K[ҥ `auC `au{Y&!l .%=ϗOŊ%(ꢣ @VwUB,ШaCB KXE0@X˗ @ʕU ~  `OSQ]x uԉ;s !jۦ`O"zLp>>>jۦ aW^ޒtLHPbbRRRȉxyy`_B䑿1oVRRbbbsㆮ] AʕKxOJRjJoVrrn߾MPp*a3OS,S ȟ/ԩJ*B *W`nݺ3gS:}vޭM7رcjGrRDV*W+x -RDy=}kϞ=ڴiEGyxxL2QTbŊ),,LEH"[$&&ڵkv.]SN:v<.4 @S mZVBt tp)^^^jѼh^͚6UNܹUbEUX}֮]_~U -RBB]5kT֭բE ժYSrZ]:wϏ=Vi…ZfYv[R-Ujl?O _tI;wm۴rJm߱C\ @ɓXC}Շ}Dp*TPey†E>u>}ou wwwh\{VvlBH*Ҿh^bccbJEEEi~T{@ȑ#dX[ŊF~O8e69ok͟/U C3TxaCC$ G㏫\r3.}a}a;vLcǏ׏3f< cAsvխkWuUIIIҏ3fhҥOa S<|-ݺ֭['OlW_٥o˗׷Ӧimjy<˛W{OOcoeʔїcG駞u,O<{:u]*z<ۧzJa* 03{YB?5)888nJw'hXeVR%-Z@?~Mt~~~zcH?zT_|ԥV@;VkձÇ5T/UƏǎSܼySΟ'?L W\\)fX`A͙5K "#z؟z<ޭmp#G>#G*wN:/_VBrĵVo٢1~ ~-zwuaעoLX@Yq1FwU{vR*)r\7lpeT`AyyyڵWt?P` Mi735Oӌ nOSg.u%__y5_4\}WibbVYÇ> Lg^BѣsC76d pHH.^!O?YvQ,p%Y奱gg{g0˜9N/ֹr+W*))}X@f݄dAɒ%5 AxSڽWhX֯YF T 4V̓'DF!Cr{}vZdS\ʕ+kͪU*[K_SPi?nڳZWʈ.,+Ѭ%wVT)[VeʔqLk׮QQ9b9pxx6]͛Oڵr2 rZt.jɒ%|a ۿ ,g'HMM5ݐ(jҥ -Rĥs[6ͥ7)W֬Z岅\KUTI "#ngxbZ`hݺp"0@j̈́dQmP[t%AAA??ܩ|u|m+W+]k2gΜ=FMڬK/e֚=g}u WfL1c4`@ٴy4He˗>ǦFǎӉ' (&59,ZXUk޽{գW/kPkT7jDސ;>8f͛vy)))z_?Ӌ SO>ikٳG}Z5ҷ}g5|=Ȱk֥|}}:ԨQCM,P^QuEx)))ջn:1lp%%%9=|!>|U@ ˀ4mD/WE C$m߾] 5ґ#Gl)SԐ!63wjۦCc?شgfddC_G5g nW^=SܻwX(r4 k(99 TRE֯Wڵ @ǎm1L:UƏi:tp{uVj԰i7jV^V~0pk֦bŊ?ƛ l֭[ZjA&*TVXVt9m^cb>^]{YmZv݀[oM4jh_{5S ^\\9S7ى3"d櫯W_93{p&)))ٻ.]IMMn%UժUz~EDDvRR<ͲͪWh3A۵m-[y@6pBeff`MTzu ^xEm߾ݡƴgM>f5ka^^0njɓ'⾜gu)m{xxk׮6{-ELk;%%E7o 9@ԥ˗ʗ/M#I jj}3iCmlWSwhTjԢysS>w>7ccc5id6{-9[I yzzꍑ#aZZKJJO=+XΞ;Ysؤ:R||`ڶeAZ8 a gZ۾ 9@ܜs mݴIc?X=|t3.X1w^}.C][0f?cpas'OԮ]=3dۧÃP8Xif;v&}UPKN7/ZiiiNyªqF6y fϲmؠj(. !vT`AMkھ]:v7SN낅 mO:{4N9O/6&5Ǜݻ bل8 *hάYڶyuF!H_}ӌwE6tRv{}-ZvԂqb۷OעMi\rʟ/!6.6i>ܐQ]>}Z[n%ATVM?͘NV^SN9x7nڤd kl׮u Nڶmim7l6Ox r4 ~S4,Lׯ G7S755U1{;<)޾}%}ڮis'N0덑#CEv3{l@8`(Vɗ7]^ioؠ$g=jZlˎ;mӫ'x9Ha7cbx|w .lVfMv]bKܷǎ7 6e6jzwM[R8*xˀ2{\Bh[M|l 5???yyy0i$mڴ%ۋ&K*%oooS]|fy4|"SCAvhbv`̡Cpd;wrqj`V^=S}\⾽n.*[ٳmYVg.=:p #pîRRRw~19ӧr/\PffأXV-S=znݺmjjLk?H_Of<}ںiZj \@ L͜9 9sM'w6}]%J0m3g馵]P!ǿm6m޲.UVM "#vjuԉpIհG׺uyxNxm Uֶ-*lQu֯WOYѠG/.ÓLƍ`'ӦM#$ݼyinsbŊݪeK͵sdL[m1o|m߾ݴeߖ*Ss5ut:tH85 p՘1c?_>lƍ/~Y(_ym/s[ z~ZxyCBСznPmڼYSN՜s]ّYX I&`?'rt\X+W.eV}?֯WOFNg&3PØ4ypg_S|%k*^8z#Fȑ#=۶iݚ5ݫ<=Y\ G 7>A6v:rr6___ȟ MKLLC>>4p8P6nڤ-[`gΞ/J!,P.\H 49 'c߯)qp7?g.[ p #I4gjE4믵~լY@yt)LӦpXAAI?'p_^׮][֯קϏ L5eTݼy γoo} ӦOWNTٹ'Ԏ[UNn& @8oN\!iiig;:$+԰I8p2,]֬Z 7l ۷5v8L0klp C0f,VFq6i sc(aM4 ŋY QÛg dSzz~]N#)9ıǝfsE""p߾NS,[Ι#ooon6 ۷5 Ȇgԑ#G8DBpN=2##C?Ϛjڽ֮[c_|!7LIp_}2Dwy .rM7yٱ鋯"{PJJS=##CQ (jըQCCzJݻuC'5kyx: p )))o 0/Йg ˋgj:s AvңaԫgO 8P5jpqN0Ak׮e3LXK4~5K;v N릶'OB΁ͤIS6h)S*!!aW@5 BX{  \z 9۹sx)+QBO>v߯*VUQSYvGF`Go!ŋMm?44!Iy&OVdRM6VENŗ^Rrr2A‹/:23M"$$s-SW2+[?֬]:am2c*]4VCNdX"2*JK 7'}'{H  pr SOum Pff&aڳgAQvm:TCHHb'PSM3|yj7߰ddd>5PZv>; Rvܩƌ!9ΩSkJ,;~0jBBB!#۷O[m3m蕗_&pX,(( F.퍷 .!))I} Peffj6ݷߖCeжM ߟ9ڸmo=z8,jj/^$dd@TW.`+ȑ# Za*QF 0=X1M29޼u5muxB=/WO>M6 py'OԓO?Mpj,ї_}Er+WڴW:u4g,˛>raiڤ////X-[Fsڼ5jh6VZڼqԮE`Z~Mlݪvlg#mvT ~1r8xCsv֩>hjV ɓceVvg~T͛6uV+W.Zz"s{~%33SC^iii6HšZe:ev~~~ݫMf\[|||ګz9MgżȁԨѣ -u~!G~.},P@ "#ӌ*^UV~ttyԾ}'إV-[j=Ure*$$D}zO3fsntiZ˗Wb[*XPGW_U|&Ϡ -Tɒ%Mg֭:s,ovX@Ho,\HpH:w0 `SoV.]o>233sj9$-!v<'OT 4Ȯ˱(3|}C?6dݻ5Osk?}|իϏ N˺eK4h.zxxsȑڹs'Ac??D0UFF<,\HMoUw}t ԵkѦfip2/\}-[φ*R-j~խkM6̟~bELEt xQ0Mjj3gXARRzc6R#;FQ/\PfXma!{dVYǞxBӰ 0p%w^._+Wի}$Ν[^^ ,"*?Pz hz5mT=gc7ҍ7Ժm[}zOzu'ޮmmԽG%%%qTڵkzgrk}m߮]v:r9,奰0UTI+WVU~},3xu]k֮ &a .]Z˾g{M?zLX@%0"%%E}T7ocŒ;_M+RV3_zvﮄn@ p6|Ξ;?e_gjj6lܨKhڵڳgҬStԩ| W Ժukmƥqy=б,Xﾫ];O>~{GGRco&MҖ[ݴiX"KjՔ;wnݺu&j*G=cL ~qp&x `O'LP>}2)))IzEe;nvaݜ9sF?ΜpXZnI'ƍ.u[^ 56!>Ͽe^ӭ[ԣW{$ss%ٳGu4ǟ|tժYfm&G朖_zIXhܹjؤN8ԯc-zt` S޽˯͛5kԐ! WԒKAZiK/&s/WGtGN:Mh~dE_zՔq0$))Ijխ 7ԯ_f}մaQ?~\M7ק&l `UA;7nhgjjܴ{~DJJ"ԡS'PAkNKԱsgk6Q 1.ݺ)66)ÌU8`9M.pO=zѣGst)))矵lrYN}4f͖SZZ>լSG[m=zcݴy b%J_ԡC.ӧO_W%շ߰bK3Cȑ#.ŋըIue^@ .\N]k:~]rA >\%K'Ԟ={\6}!CTD =?lS{auC4922335mtUTᖜݾ}[?Le˗׫#Gfkl׮]3elYhbuUe˗oih#JLLԒK5|UVMV՛o;8_JjҬK]1鹦fq> UZUtі[ySax}Q h%zwo2bJ.m~EGk޼y9Y+""BnݺpB6rbJ}Zd\͟KƍjC}*_ڷkvm۪AtEGkںm֭[M7;nڴy6mެ^|QM4Qmu}RJ3ɒK5g\-ZXɼy"YiS`R]oA>֭ZݺmϜ=K*2*J+Vd;_V-uQhի[dffjYgΞ%pprjѼzv)_޼wQ-ZX68%???ի[W6TZTzuߒu1>rDCmv>}e/\Z4oz)""BUTMpm߰A׬њ5kcN~&]S={x ϯΝ;uVjִ 'NhӖ-ڼyoySPP׫*UrJT )tpA޽{mvYj34CժUSuU^=խSGŋ[ڻy>۷k۶mZvΝ?OЀ~/_J*%JXb*XBQp< EcccX)&&FW\ t9]xQgϝӹs甞sT TB,YRJTɒ%UX1ϗϢ$55UW^եui:|XCt ~p2eʨJ*Q.vbu5]xQǎױcǜj}Y(? I?{$M]fY/@*Z+,,LAAAS.oo)))IIIIJIMUtt_K.ĉmyI(IԦMq]FO~"" Vu """j4I?Qء5IةSg`.=eIwwFZ,_֭vڪXw`FZ߷<==*xxx_FO$i ;K4H TgVѱCG)Rix#?ؽ-!Hzm?Xء]*zns2z;cw9#IFz)Q>җ+d}QR',vw၎jذW 0~ԱSVN}Z$7O=ŋs  אSOk]C' *`z7뛕ӟοwء"I3G`"pz7'O>cvQ:ƞt * r5)XF@ W% @ -61cv/XzƇIږQaկo?sxxxhG5a)4 Z*i,o{w/QUaNѶ11 Dp/6ƅn\qƕFY h:\c@(5B_1P['}hc :3f2|o9сikK$I$鶷v߷k2XtVGj6#Q8m4npV$I$In;Lݻw]TVVx2 olG6  ɼOG*$I$IUTTgػg/555Gapb67 9'DM@+WhjnԩLLLX%$I$IZp***ؼi vb9l ` )ƌ8r$d V$I$I^.c-vP[[[7 @|lkv>sV$I$IF6elzj6lQ *VF8Y$@]s||s\lHkk AI$I$ͩl6KCC 5466NK1TDapR,'wR.$wIWW']kW=UX$I$IRUUŊ+X|R__O]]VdժդRRpAW=|dk~#7F3@I$I2WY&xE۸Kdʐfd2䪫UXl9O70(ꫯ%kYy2$I$Iftx= ^gqr?SgGI$I$~^ Tb8y x=$I$I x < Rd)Ⱥǒ$I$I 3yFa7zӯ T$I$IEapy.N׌oI$I$݆zO02 {ql&$I$IMǀ/0dR28YDrO$I$Ip2 rIll8l6XG$I$I*#'0VI.'qR<<4k&I$I._0Z/Wlqf@=P 5k fKcI$IRC7}קW'Ea0P`YyIENDB`libtmux-0.45.0/docs/_static/img/icons/000077500000000000000000000000001475667375600175635ustar00rootroot00000000000000libtmux-0.45.0/docs/_static/img/icons/icon-128x128.png000066400000000000000000000164161475667375600221640ustar00rootroot00000000000000PNG  IHDR>a pHYs}DIDATx TTgǙgrΜ9IZ"YLEFqd1tgQ+${[U &Y DbuֻsޫzH) ,~F-;0jfZ"6r*F8ahzVi D7y=z&׽9|ؙ5ޟx0AGP\#WD~8&{`{#;Γ92']w%9$ƞ/3acl=rDHG%X` }Dp7.S9]ozvs'O{zfj ے a17(FA lGjnloͮh'W)2~W= o|ӴwWk'MY_wė4p(] H>܇#",#Xor}J|  ?xRa$M7L3} f !ܥ!I*l6/ xY{I>BXqF }K z,؞ %Τ\wޑ(zC ͗&A`z>)yp{M[sJ x!x'u_se=_UCKpkw}^#]kkbU; &@ԋ\H:u ׀F0\EB2u96 ?@>TVUůjX/,’L 3d@QU[4"?f` #` /<hv 0mEHɃk@QWEhRďOJ>\Z %r;9rmʠH V\kru|cZ+HE=keS d^(<hQ@@Wj{ \3BG aghsWNx@KWzVDA L`W`խj{kf^l">M. Lŷ'JX3ʯUݫ>,~[.us͍=XRϲ*oL]ʎXOauhߘUpA{j[EItsBѨc]]CCCgw{iڸ (Ve&Jj}~$(*[PY /_<8w8q9?0;|0=zN:.\V W\*\>K`[.\ N"@$H۷""" 44 ?wT*!** PQQڋ%zA/ F/WÙrhWtmj:UN5;>>˜$* N“!!!C'!(sj5硼y2)V@#WDg~hm /xr$DBB"EE1 i"QTp\z70 2fN-W±c 22悷V,wA9 t%ϓeǎ@`#h' 6+;5m*dǏgm:drm n[_Bph8GB*# @-Y`D@ PB $',cVj;0)Sa[j}ڵ{nc3RZD ă_= ^ 3)&biܓ{<{i#N@^, R 3))%fF/%!$lAAACpZO=Ebjxzd0xQԔB4Q|B6{8R.Fp$eOqJA"[4"*+y,qXh×FŒM*P+Y!R(ҥK=A[#mT)Тlv<Ng5P/rWCA?ğ$3y8(--5Mxp4B@5-<<$f+oԇp0cASm'jXCγ+ɝ ^YP#A9< hihn x}]Bx  \KA`.>IhnA'z BP|.HĝPp cK h5 ?9)j@`vG cr{9md=5, 5`ȥ eeeml?1((0Z#&7/V3ɽMi cg ؀R^FY@@7#hKh4XAͫ1i;y>-L7|Mt9TY0 FP`k#k[B0_E_P(CiDa۳gszIB@ЖppRU9;s,Cfyg%ykסvD=@M n k@BLʃzߓG)//簙7`a6xb᭯`{u5^Zy(p h &Mwg">y*n޽SҝQ0amLZr8f{AHxMX>VP\f\@Oxi{4Ώ`zK qڰCphfcB%t4D;DKɶ} 0sl 07}b {5.Z3d9AkfW;Eq+xcUcylzaEfY.u3C8 --6- ƠtmGXZ eHu૭vgcBolo1hamNX HͲ|ɆZ; b 4׶8OI /n7 4\el$><|  7b3v&—+BtXtVu΄͑ỘHȤӪ"JV+aܓ4NNd,ċj=Ow$2ˮe4x管dE%aSҽ@Xv lW?-;}(C84".nħ:PADiHRi;|ܟFBC`]۳9#dU|5dVIx͋H~ Q wO .pm*i{L=#G 8fm!_z e`5}=d ɞY ao &͖=SP4__rTJxyE p$ԏeY1уOp-+{eE4a2N-Fsp @&L0bޟ  p:l쪫(RRэ# Ul\b P WJ`N _/(#PV| fmV%2t"QD 0s`4 -4 `wBvAK@)`X(Hނ@J+ZWe׊*)F%m2?sw [&w ZHzQeM%to2v _M|z$a;ejA:'uAHm._ :m+!V*2؞k&~/B:AZ:]iSb5H`Gc󁠎m-O8/1cd,/;\.*d3r<kx2Z!/ <9 >^Dl{ckXWsD^Np,/ ,Tr.d,%x}/@-8={ 6CC?bb?6m2Zg:"]Na,`8l O-`g,*93p;u뽟ME.^V! EJE>} 3$" oߦ#iI0Mg ( /7{])䄫F(+)|3m9-4l wX{,S CK,ZXo|j#!Xؘ &5U5-YYgNOO(x>X@r0@~e7Ԑ'hh]E_BV?,g8)B k>FVx Oͦ5't4BuU 7#"T-L^nT]yG]Mh82Wf{E@r ymc UxGϠƜ\al?(IrTW(KvV68IhtՍ,rpqt2ـơj]srή7nhBSk-k': ~^xs:&sd<}` An :`#8snUiãz*~qy/$2~m1y6( ӟ{ WAO{ ޝ.9sˡ(!zA@r=} ,ZMMMDi"=޼u˸2$rvt m= ro94<ۖy'^ fhY P-N"yypXp /&`K2XT"#J# \mvv61/E<sY_:\,>I,"y1IENDB`libtmux-0.45.0/docs/_static/img/icons/icon-144x144.png000066400000000000000000000200751475667375600221540ustar00rootroot00000000000000PNG  IHDRF pHYs}DIDATxTTyѼ}{/KF#)&R^^_%[4vch5*H`M *-y s.(Cu 2ýs>XXp&U^zsoj7x)3_w5Z~k?/AX.lbZ/hiԓ+w9ͅI5CJjf؄%277yĬcsz<ϋ弣}g =naeZm#D!޻zW;avQp-1lZ?Cg,VsD8Ʌ]T~1[g5<x̷*@U<<\ٕ&f^F6c1f, 'PHk~%̀5 0`ԵsyLFpJJfš N=Z )߀@6}ᇼu7&t0cTL _ٞ)O4 Zx:8& j@E U.z;)P# ѡɰffyi T  ,Ws*Գ;dHTNk0Àc@1[-b@I 0Quh@*h ӻ< &}'԰;C b]XDF9d{m;%xXL?@uvp"{cc)*$$Zx&cDxM mdis>`H%MTT$I΂|-uPl(l3/ N]N}A FjD@@BxPqZ-顰t:tmd)2߼KLHדIPP^OJ]BӰ+/ùLhLDU(QH. ]GlZ66,nKHBH\P ! s" tԝU1U]۰W!I 6K6`{#  3@l==,:| P;S `τ$:ku!2 !3'YCy DL-@\-؆%JuN]@wrp:@D!|8r<HuQع Hʽ@ q(% zZO{@n Ry(XpX8|rhPS&Ay t%h't#ijP#LomBgY9~* Ho #* @8"5zətth:]x Ƭ C?h;I@8/8Y;*d}^ip-4Y% o:@XblDRHv*E!x^Z$Ul0IMa![k F-×sV:@ bt**\P#ՙw5 gĥ]@U 4DpKLOgh93] Sx; E+Xix1pWu:>bU\jRV=i"Aͽ2zq:5aV{kã!3;6B1-!* S=p׎?ÓHkȈ;O *dcҒ"Lb.84:\kS!zh)FZ;#Z%]oo`Ӣ;fCTCIcJY=&\3J=>֛<-غj4~M<-> ;ڴY>%GN  <|JP4ԕ4LG,AzJ 4I֞u%:xYr8 Jxxt]Fw+(0ړjsO ɎH>ZAeteuNۊZQQnqi. ~[NE Ћ#WAy-@]  .]'OBHH7xzzh4Zzyyџ!** ]ɘE@ 0V=q`!0)))p`#Sspp4?4= 111pmV<לze 4z6@yqa):S\Tl<&!!"##)0†wvvRM1Ka0^eƯ;\!#5H/S*hsThb^1o g3q`!PkLO!Hzy c^tޘ؟5:|1hx AD0PMhMXfr@ti:щ rϏpL] p9 ]L]hƆmi:!N  m` U&ktj0N]3vKl< Ѐ @zx#Mkze,ѵ UYQxPZ$isNNi :cQ$f@j͛7Խ(!ȩM(w #.^X7ab}ݥDqȋOyZL_Q@z5cS&d 05 I" ynFՈ$1HSZk!€D̅ \yܚS=UZUs*[VNy +Įmtg؉D..DmjT89YJf s-Tᔧ\=_<`?&7z;el2I?>FH&JtNOnW~17k)@€Ν;0T*5\0gQR0m/LE>Lc~qgTrT;xqxCGϜ9SǕx #T{yy10JOO H`[(Vp%z_-]bMKzRDsԅcE;tÙ 1ץ% d;Cu3Iϻ[_faP lϡ0yqf_=:@!n0v- ]*م FqWHz鬩־SH9TrpϴkzH5PV (Mʚ g<ЎHH=-푠?ٷSDA/W"Pa.|eVaмnBck4$2GVsSVI# "{wZǺ/7ShM|ye=8=Yf (@Ęh52Da,:oӭ!'ܸqM{G1s|[XP,PnF".|Di_wcMlm}j<[!~gb-`}iTJtS¨YK=Iu @K|4>+Xo_^ cx#q ۼ^ ]6xS7=-`FRz4۪~_9 4 ,eF/zN|;]0{w |7 mBAxrNOg-g:Fg ~@H jМ7Ri<ͻKg P+Q"n"&SMvw,/5TsOa;*]wCgJ3@<<>b3ay 6>莱N)Z;,Wh-ۆyGMnA%: ԎnΆ{D9j .%;-N@kh`@ȹ@@J߀sqTy~{%`!&;0 F~Iu,@lrkyܳ7~^a9!^@!2!@d΢}Ǎ[2b\THI+>>N;-J lIG?/[z4_'$D_N]rx}'L\.$g@z‚-@@fĕ^^0e X¤QPz(ȿ v.ʽPA ?V+ا@@fdٷa^Y!$d@zdj^HY3[t]Y4Ff&Lnh.@fS6+;$$HY0uP3h}!MMb fNZDHȼTbat"j2@,l5JIex-xM+46HH TQZ WI ~YǮٗ9hGb('@| EHKp]~su T,S\I vW԰1ʋmX zH̆I?xjhϱXSY)`(*n[X&VBo $*pâ]! ٽ - U4'K@$Ħ@QBA! :V k)t㜈Ko kJ+ %(&ì@<>sPG+X }]٦ w0f~Bwhrԥ*%C2:qN7 !$%^+AW BGxsJ 222h<Ԝ G e%}yU>^æ/H'%̬j`qk#f5|bO90'|]&8<۝*XK Kw+a%6ΌoΩ=e%}3,I dIrb 鰕:+CSn|X QÕ] v(}jw:oəZ-<_V^xrPo[`E MJ U!|^$T\dW\glz^Xw`$:P3H#xzmCuy啸T6{zBP P$rsu!#2'HII1Zn_AzF)--YuC֓;3UTW0@sDAw,7VgbVcHYʢ*Ty=YRQ0fsZL2Q܌ߧM4+1q@ NΐCQg.--%q<5 { &NĮz{'T ; `Lma"Qս{ nU7C ą(@$&V0B"vv x*- 93 : Q~{9GW~9YM bB D}ʠ&(y,H#0A)z}<Mɤ=T u%eA{*c@l(V,[ve-FzDzÕ th¿r|m'ׅH[ct78 xWvU#@D2TF}~hdh_k>>2(KKrxCA׏woX|@t"4f F_ xqdE2Vk{ 8b$~Yz#Ɍ!3#e0l`x ?pJ 8,i.YO[ ׽/ ;yyyDu{kli:*PQD>h󵢀1p\VS`0o? 6nz,|U`GWB ِ!E[C^.x {+^kEECdD|=wvRPPe{Ck/L{hXvb|cM Z-AAW>˘; "ޭd}Χ]z~h<0V @3A[686k'@ze'  8ƐJSsְQ0Ɔ??Xd)L? 3ub\1^BӜ-xAWOΙ zȶ.^d|eڥ[Nm8_ }f]_ ,.R:;:\`x;zHwn=ߟi3;1BXٟ=]8#Z`?hpu&cYƷ5 d#wj='VG^l˂5ra(|W39 ֋@U3l k%N`Ų#. 51뺽 <6z McWNl t8Y%=庵2r\tp{Շӗ߽*>2 `a`زl+9ngQ5u) 9_2 6>0$chy7th2Y ,jv؄@F?@QQQ ̨8&\Xs D7h?-~#׺ A3BȮ^ >w]?57S.kGYMMZ‬? qZ.gS VКC[ꀵr2r~5d[o&a֯5k-ozLF[5BJWT ;C^%mw/wa\AP2:;I9 >$ .%2ĺEbd.&CZeAl U(|[3( $"ɮTs[t\{WbnPX%d3(F쇍0&Ah g!h;F0ς3%ArE1\ן?W %e/-8p{! M,b6 r@}mkS e,N.(R0U߸Ir%CylbαO5cxtkQ+ccP hBU$)qyO]Un7nvTWrGvU& [F"GvsX\P-%ܸ .ܴDe2JpI9ps +05tQ@kNz &x'ج p5Ӡ7`XYYSq'1`ad%,V%qr؁Ɂ!$UUUP]]MWRR gΜ,̤l~aa!r -3>]g^AsPl83 222ð}v0PT2 00jߗh`ӦM v#GPP.\M7!V[0-<;3 >Y GAU9kL38X c;vPwPap dNiͨ8~-44*[~~>V|V0#>_2Β J9zX] RPA+\7jAk|/!luyRRm4-ۉDԠZC]b̑j]֖-[JH f $Y }(Uܹo8!lsrrl7M 4`RHV1VbLx-|7 &&,R5U& ~ 6F G;6Niҭw10l;?4U +YԬifc0؇?A  AHrؽ{5X2T((!ǥcY.Lƿ~SAC׉-۔9r.0Tf«sX@lʹw_tcߕV2eUrSaiIi#Y|YF!E;M4X@˅yyyͪUlh2[!lOlY={Uo 1VJJn:LfX[ >#ȍEq @Uرc3:xb3Y 9qAd`ϴvYŹD WBNVn ƪw K#Є m۶Y2>|!d[`[q'! ]`')>Ս%t,T%#[^9iťD@@~`}KI!0(  4dq•Jb .S-(!`114DoILЭ QbR@ZF6Ff`1vg`0{>"JyHSvI^p.FaQe+X@hxcAROdۓ{YcCz3`˓Ujw|܉.0eZkgd.UѮ EYrrrBWx +:QXK'I 杠Fܑ,Z& 6>F!d..Rk )dCe*PY߿2g(:t~'E"ŨBUޯHywVGW7LV$]dyU P˃^x%wv%W)1:&#֙]ѣGQ.SzcO\\ͼ0 ^_I,|.&(f: )Ma dW()dA.T3.৚8m(.O`VWZE|, #E2#E5t#em@Ϗf& cHȃe 2]0N#dC8Ȧlw00Z TϞ=˹C)~<08XLİ¿o`(B]5?-dO6s5/,]8b㊡ RP.ݠ+&(ryG,8bQewLLD.%5>!.3Cah$#Ԓf?_?|&A.bI|:ͭZTt7RH|B"'"pz׽?{qql:%žVHA}  rȿI??e-Z gπSָFl(3:K#:LK8.8~׹#:݇v3)mc$O> Dzj*X|U ]#pu0@WI: &)PCRZ?`U\bkt{4aC`FL.զzܞqK#iPs gF9V6vI `*7*]({d -E~?0lj] f|QZ} ^{. #q /6Iy^'Omd <@U_ԭm㺳tSQqieALZYpF/?D7 YXg=1F2O!yav}W˂{{)ϾA.g? nKKn02xAYb;P8+B0߫3tm~ǖ^$ -^Q)w'.{Iۓ9`wE`akc&M ,- m34435%`lu㘾,\!dKe 0'IMWӀ)GJޞgx#j4 s!l0|n6o1?,y! UK2Z~:vC><ڷu^%D ox>[GTؼ$DKt8vÞYD68)RNeAFvdBN~ӭZjXWn/)p*?hJroQ$+`<\PclGttBJ̅5"*TEB5kS!@h-Aþ.ekO 02( 0145{e,QTflb{ۢY;jrT!AJ< !&j`c"F\l{Qks51z!&ZP{DpPBb"5J0C N3`؝\6=sjAh` 6FLa_vG|[,Xl67.QYYg@. 4vx\h[f#;WPկjW-I0ܩcD:Ę겲 %%F_x'``M9yC. 0 V_EV(9(&̉4THI90Z t`w͌ 0 0VUU '+`0zsU"ݺFL̉CDvs0hV 證L ALɀ Ֆv)ȗs&`-OOUS 0 0kY7e"i,uSH9JXONk#~Vk.{)J 0 0gfG'+o 0 0vږJ#`R+R̩.`ZM\Q.uSH9y.=˥$&PP\ #F ̃4Lk"-&rVxzu``%dHx[' j@dfo_ ]fe74_K5E6py4Mz7G 0ygh%aPZRD26L8d$ї5`Z:!zuc*1fip[;\%\0bojPZZFCޠ5&3AYY9Y&"pf;411<\͞35]qf (ظjPȃ.CWSD𵽡К˱TӲ֒= 4,F긱AJJ 蜑z~;77pF;nSKKKU,º!m dBH-fjVzѱ` 7}e|9Ȃ 7\<_T*g_V*fhK:]15n<:nm>rɂ!&ydu]l6ov2$De1d;rX !Ue*b!dh2X#h !kiR`/C5QLyVC>]ih(тYx nbM Fønǎ֮nUQa5@9M 0ƻJ^II+lz >|ADl C(*"BJ#J(,0n27{p9^L|aiXw v1M%f~‹^as8Wj40b$6,>wjg5k lWرcǚ M$x$Ney`$v~&jƿ~^`6A  o8ϛJJ9Q@ڡ(]psښ ̂uʺn|OF#IqCR{n׆6cyOOо1a,R7I\-c0T z1m_ #&FVcLc111t5c\ϐ.h:t{1s؀5Aw94 0x Y+XW l/Be4?ѓHut 6lʰO,s㔭C !kяyd]! )@! VApq?)qk&ve" ["@VwaH5?FcfyvYD"y9a,#˗8 򻎀G$1L'@GR0vgk;[D778iJ6\v]K d!@ uVȘ4`BiB׎Υqv(E8 52PB- O"~ V2Vvg ߐ{ F``wfW0d}'6zKU-SOzu'=:a!6E)6(cZ¼h<7'u{tw5,'Ï@Qi58᳂֋gwcZ݃Zny`WJj͂BFq6 bgCc}=QOwr a9H݇!3Gzc_]p=r4%.%׃}e8}ۯw^=zB?Or׍x{r9Є`w+‹I!4,zp#p5҇ݛ=\&-y ֊ .GjsQp,'=J^j,V`~ao+)PFImPJH#Ӝ`|n 182qL NG0e^<{>^|bP5Ì>T^|0̛GWc9pHl#7 ޽as}?e*\xѺXj.6ç :." Qgx7q'aBߏ1n:29Xt)}0;l(+}D`<\XcG'ມO` ;P.M}XϨG  i[EotNqاw#kEONN5u#а, Se 70am x{ԛ%IC׬^ ǎԵ,0L&IENDB`libtmux-0.45.0/docs/_static/img/icons/icon-192x192.png000066400000000000000000000257011475667375600221630ustar00rootroot00000000000000PNG  IHDRRl pHYs}D IDATxxG޵$ 0k{md˚h:lzN؀٘64$ J @d (KH0JDw ϫS53 03;_AtWuΩ>x~N1nA_cSH_=ncM9 &HGnKW9Ƽ>kq, Ob>mMIcv|9'(9nL~ؖs)+K۰oBѷkaAIɑ>@oXC0ObLXo.Ư5@o bȌ9]`~)VA0Wy/|qIl9x$. GI9NG<8>VE~w/@]c [=E#UB`h(z.@ 1䵅ّރ&}ka8p2 bH [ n2dS@ 8~ߋ _j><碿@o y!}9}rvA-)8$BP)zsq; _0x2] ڙ$aa pw yk?:a hHDR߼UCRsS|h\]5<.O9&r0 :=\]@?@8;Cez9Xv p:=C y,V-Nf{8 mX" CzkEt- DkJ8xF@vy)!{|5'ײ~Z]!7*~#lؙH.sPVqΜ²spx,+hVoܣQXF8]X5d:Y3khR %yz6!į%jjjTSCL! &H>QL! 8N>p,Fvzo!Upxl0%]'P^ĉ]4K],UZQ R]{+f!'uU I}@dtFZTV\ Yg]<++<aC¥&/.ut (܂_<'`)(럜*/ZJ"l$(5D|+,jrjL-99cPUUU|wZxX+AX(. BnuupEJɃ  9UvS n577_/O{x,T**kY ,Ah.(sioÞ.{:xo666"Baat)=@>0ڈ%HY l=d2?&KQÞ -k&ǎ0S;0?6H۝ a3MۍRk=HWa7q\]qs8bTX7 \<&gh`o.!Vb;i,u{h.~n5]pa!w{sp 0Afs'97.+۽~ۄ@/"KB.,*s,^ֆTl6/9/7Ygqeݎ&8wÒ ʡe53vbgs]EECNN;v <{HLLعs'ر'%%]g:ߖ%o38\|M} 8KtW*=  9sN> 梨Z !!!d@jh`֭t ƮN`^p`#j x645p[*,=(4ߩShbWTLŋGR?G kcw}F;LLL ۷^Q n/ Cz{ 7?ql۶ -=\쎄mor0:;9(r"""hhuIXLm сb%ʊ@y %x"dee8GuF4Gk@/Dh4aY zG·>p@i&@^{{Za-Ny(X`@E .8 `ROMB\@%8₣4(" -PHEww,j;v)(I s3n@8BiP!#b2*|8z{w XQbvB'~6LfwJߩn*; 3SBee%nrS{AwQEg;EZ @&; pk G-q%(m;~3wIj 3! z/![ߌ?7kYFaflޙM< DHDxO~B-7&8jN]A + h$XO iȯ%ػ6~n/|ǽ}$zcHJ7Ͽx7w.ݿmoX#0 ĐI`ms9(㰯|swaPz p) YN&zxKfD^P^IXc}]dtt7o $4$܁HmAHMM칻]Y0 K$cD26s&i#`31;]whR5gG0Hs\ JhJնC`<tXzZbՠS; 66.-e,x,'c~{EmÙ}08 X2qFB:nx# V>hMY0p WoZ2aۼp] dm]uq$~>aq(^(kJl:M2X T6zfm!aѵ>!@1R_Gz!B0\%k(Fuilҵ @(,’;,$•Ye8+81 Y|qCROAHgϞW,ާ3J ރJ,轂Ob)nᓘ'={ݔT$HL&TPR;sĶSY=m통Axt/2<* 8J w 1Q+//xlڃ{Q&)y࿧ RIGO"]BڢOZC9 =nZ B-a6_CEmG՛8y:rCDLw`u]U *1ra-ңq”uqd”u:ĦoI%<{&ҁ 2X(f2MWq~; mtJ!=Z "V"[(Y<7&HrkУC!ۤBK&APb~{Wi+~ *I<ܔGf| }ӾNv6De|~"t󤍲B Ke:s*%vvF|pm4M/Hf?9?Nz^Y7bSN^W@zBnwjq4b/V!J)\B:4/ Iw I/Wt!I' ߠwܧ_NQ=a8j%HDQg@CNWЇ_jZ*xr~?{XCz3zGuHx(چ=<CI8Hc''qÇ1?.{ IўS$bCd#8_*?HVC2b.25p8 *}p ץc+Kxo9{žUs?{ } 3M}{d 6K>! -s/yk|y7~y6VH N@K@W>8,>(Vv$LgIĆ 9C[Wؐ^<=VZ`N0Z6sf=?,"7B@󏤄(|> P ArsHҡP&, GdXW1aMx2Rs>,S!+GSP0T(~<^?s`sJo?z#L~5j~ 1q߳_k,j!L#C[=y߽{XĊ@u&>zrG }8QN ÞDPPzΒx F^X {~ c]$exO}h+|&T Qc[oo*qcib=ZQt{c~yg,,_XP|k }!?Sf]HGHpgGFPY\1Kt0Jy勭0eML_ *'CtZbz;s>G_q2 l a)ishXz}՟] 5}\vXqʀ=v 8 r H.uOF;YhN d r@~IsPqcmpm|cpR#]~P-v}~Y򛑑A{A}2{@Ye!pE6 [1wD^9YÔ/0СHM&]+:t *2 FpW*y=JAS`w0ri4E`yEGvha@ W`(8zb:|i2k2P3r1uV!`݄ez8_F'^p+Gn.(CaSP8.p:lnd hqp<1.66 +%G@'*+!R7<8|CIih*x%p<hM_-G6 7鬓o0L\aXxf@#x~i$ 8:|K8p`0xWVh;8=1/Ve(t)roaYxnA}џ(NyY4g>Z`Or8ƨxX1pp<\miMIxjn-jq8n@0q aBb 0fbj*xBҝ&gmN/Js|5(C`C_jKCp<0a_LZs8[HPpahll\q` &3ȇ p@p%VL..,{cTUo0Hk'BC2PTTM;ӌD gIDATMM- ζ5g"GSs0h1PAHH(T*8|0T$V[3ʹ>3܈Bnك hPS2t@|`m'I{  L J"~R AAA!--^RRPQQA =V:B*+Jpd4_p^2lX]ӗp0n(ŦpЫPH 0W|Ys/Pm[ ,~<0ta.B R۲3b(B0^:9a3h1Y^8'7^\#J/äuGbW`:FljF_ҟO ADO YYY]2"oG8ۤXxYƤ A-lV^"D.câ83\'OI~$3>>h,Y6C- T*:1gAWS#Ld<{ Bџhh1*++sĘafUQk}H9Ü;?* #GyAlj@omnj으wQeeQ̒%$ N{rlm UUU]:텢/))~/G/C@HABB%rc+W NߐT@7n@XH Jm npܹ__t4tѠtYDff&4ȖEt gϞUH_B t; `"b PS[ץU)do]v ΔAZFN||X^t : ޗ%Ujuv^v+|G^P$(~ @-!:L_jﮚD2ZkLj8п w8N?=z ݯ<{KKIWuut .,k6T^ 9,~ll<B3G惂A3&J_,5J{P`ݪMk+ƭChz[:rsڌ!t_h,j.bh- ;w[*hۓUȱF%~Bk$fP81~)n`[|*is(Fp,&1Ȏnh0~~0 #AŰd%7ĀiP8 ^:afLC8⯦m!zIȎncCqL}e2.={`]޼'Zz|#A}wzfwgi[cЁ>Er \Gv `HBƒ+W@qQoii+ 'WemS  E[oJb*K猝}+x?dre=efꥳ= ǎ>6 lp=;A:x׊:tv҆$.IENDB`libtmux-0.45.0/docs/_static/img/icons/icon-384x384.png000066400000000000000000000560441475667375600221750ustar00rootroot00000000000000PNG  IHDRǵ pHYs}D IDATxtTG+c߷zw;q c06yl<ϝ8H0dccؘ$sI RKB3wگvV $@ROk} !Awծ]^^m| Py?tV-CgDߢ쥙a 3f̘ECf${B\kΈ^:3ĵԙ2Y\SC降)9A^#>y]wۊԼ[ I\WuVl28ks/.Iξ8)tM]ꌩX}KFݪsXy|gYq3c?x9Cg_mg\O?_Gf'Yqڃ92d=r }nj1z xQ`"rUXWVL+/ -M+G>cxgw=z=O`8#J,^bf/).o6g Y\vY_?dfgPWe$pϨ gx o89~Wߑe3;]*5_iVo9I+qYzgUzӧq{nm=^^̌2q^fܢ>%&V ZguF^L/,`fMd[z_]44 P.5!Pk䄇y9AB6 P;-yyyFK죏%Nɘi/Ve#!w}h>r?+k(e|˳~5?3~U 4R1 =jW> t"ȧϣ6 \ʇx:Os3!:r,,!0B@ 5EIX%ꌈJ @fX3?xF3Cf93T@``X2㤷{[*@nk 범A9`\볇@61ת}">fk?^JѼ08+oקq`kQ Vs;+w zyfm"hx/?n ~7?@/ңߘ `Na5* fe1־Ǭ,!U-z@S+ <ZYn-6א1빥P ;xLz_CC:_Mw5eB@r)4>` xAyF0!p?#C9> /+s Z@+tr 8C3 :DlGk@0]-G6Cu5Ud2V{j̙J*- u$¶ȝ?3A[>R6ЖCyTZVAZ7 Md2Duu+`G1tPDq LdlҵUp5,둀ڬ?yJJ˩Q7-W˪NF f!)-rd  "զڗYH17.i hdٿV@5֛DTN r}`~}E @[eOj6?%gČ26OX+!cumܟ/-.fh$Z Nənqԩd [3f @[֏˃E_g1`\?l* PSuF.! n*KO<3_ge#ߜl)%e9Gm+@Н;}Q\<-+}`tB& k%8{⤬j ,%Xo,;5]# n6D PoC9E\4ԉw fXIb v'fv. sih39˲ .o̦SlBB0l͵5r@kA4;{Fnˢӕ6P755@)iCS/f'? J,@֛)f; @@iyd}.m;vlvB]cqUVVN[se).  @9UJgҒ@pa&:SI;tgt ٴ/~s(S@u;ݸ'mG. ù-@`zp'+JJs-Ťt Wd@PD *%Nݵ=֓œq/nMٔUP"0/H{ kZ  `>.:pN0 tt|Ӳ)DSt6 b &] bv0 glΡR2iA@W pKt-PiYqX`<"@EH rH?O!rtЭ0hq.@+n>@vUU:P/p0 +`gVgCYB`A@W bg>)GP B T|9J^ t+AvXƚKgia{f@Ԯ2kn@ m9yC?'Fi14,GZ#7@,_D+Nx$uL̟Q4`R=>%Fϋ}1YHZ͈FcS<0[~L|2Н-( HgepJ󗿈y[(qQsrNRqi9WPIYڼ?|/(>Ã\3UQHZO`2Q!s~m"%)na*8-::`sM`-yW>lc=kfЌFw@ssbɑVk@ܞ"y$!^,:%#g%PCBr{hejT|]d ˣ)>+ @Y@%ʞǧD$)gE7|%@jT#pL5arYu{gۙ11C.z;kQޫk|{*JhU.)u_f1 GOy0D*X@NUgeeE =z+zgg =赯hg14djG`~PVQi@3hU5ۧQ?!@E%%ɋg҃c&zL~8_It/2. >]IKWϾ'3,=K;h@ h@Ԓ<ӕSeizwR ~'o[O}4pl1l|ef\NwX2 ǐ8xm@;hO7ŒrHНύA=/%shL@ۈVoiI5b?s+#|!E[t;jŤclZ` >ryܟB޿83bw-6ʃH@;q5փ4)RrE>Q!9>|lu n=PRZ!w;' U@}-gChg_?ЪMBZAt`%ޛ|M, }Dd2]pmٽo-Ɓ}[za:_14HwX#9ꌔv@lW0sM;Y\/_p _k{l'N89 הl/.+~Nd’2M/5l.\8;vLfN~_qQhh񞌝G a=}l >f˽EEEccc|ffm%75[4yvHqVWњ9UR=.1'''ʲ ,!e0௵Ρ=' eՉ2Dw+)b[v l L@. RSS`#!PYYlҕ!G78[sk3 ]}SA@} ϟ{dr8|g~7Ο﹚mebpִq": UUpڔ#7`UotΝ҆<,!PXo-[z%roj, K7}\Nf y+,)NJ(j{<ғ[Gh%: lZD +v}2nWY>) }4[}b g "30֐$,Y= XQ?RԈm9T\Y-탠Ľʋ'rqCImP5w1`S6ϊM+Pei p}}{ 0jTy%9~B)cD`v*Y21ޒ2rgQ#lLZH)b{.-'qm`k#&C/9psΑircU,<~iYPo͑Wnp/M=lf} ` Cok}EE퐭a@ 47߈?A[mAӢk(hD =5-w gl?A <hdyh<|!_?6%eX7w[6{ wHTo6[K>!U =3;~31~ϠT?Aeӣ(9#~>H55 ׿YCET_cB1aRfS'SՙJ]LzhѸ6L@ppۇnFkW@n6E[O V566JPuu59sF***\=F>gɿβe)tA<  'k3wxUUSUUE%%%KG{Ү]h֭i&JNNuњ5k(!!㭊*..N~gڵ$&&RRRжmhϞ=ta̤|*--_T b)88 <`ن:SNGp`(>}ZTՖ']j`A]ng^aChǎa93gU0V 'Kdp1*,,V@!8z-G_'Rr3پ*;G?geeݻi2؇ +*X5ހ}##F=}ddؚLHAe=,{ȝ@8YbQaA> uFZL϶HAA۷O~f09発_|IW SY:DY`{R9;ov+ )&Shu$ؿg}|΂; O "| $~-p=ܘ[ NnVo{ C# V'f)Yl][KwG7)(l.=H0?,2 p`̌@˖-rgDngKsbho(^w%\~=?|ƍtӶo=Y9bv/fJ!2zQx"nIq\ک6s٧7*\Lui,ZG3]5-[*#.? Ԭ~W y4 xrZ,0t#^H<|0 3U nXm]j|w1S=b)lpz,UF">Ui[g@- ul4 `uP@5]U̙3rCj^W퇆>۔@ `(;2LM&A/I%d e . ,kA o& z3|5ܻQ +x,4mf&VqV ˕DB=OF,!\\Nj)%iW g8Kk?_vp5뿑oӀ -0<|M[Y$+ 0,Жj~_[Bkp{ 8~+k2} ΜχU@ePd';ew* eۅT}r-P R=do]:1K \"ppE3b蛕aL ]vCg\{젛wX ?hLJg_OGж(K}v:ׇk6ln=yY f<7;j@Hp iթb7ē칑*V3~K !uZ6j!:/V9bc 魿OX.㵭d,}niDS`xO~d;ZF-Цg llK^HVq[tطRQnɽ~\VL~CK|B)¦WPpԀ'$Eثwǡ#wɆdܱ~ƿ~V Qzu k>хbuބ61aWFOk3 k֬8Z+}J;j8{\;]]%MewH[(n\{d.n /Tăaݺu7={X+}ieGϺtknH7YeS:}/!~\b2l!rU;WpZ|a@C]n 񕳁IKcI *L4hɫCwѪ*ȝvrH "+!"S  Eǫ\uCٌug6 h*|Bu@k#LnA!3bhXztr$yˠzSUW).. _֊pV ==uU`/t\Mb ~'Ld-CGr,W߽{:yW,_,4,$$:*OT܏\P o] d ,`j7Ͻ c_$Qߝ=‡G=6+&&S7~E߾O29_G|gPP0EFW_Ϩ'3@n[3+LTo"ckX?BCן~scPQz2~@5)7rNzK7nlAeato?-)YG1\I.R{6-ga4}+p෱@0AӢeC)jwo466ݻ[~j r/">@pS/i/ K|C]AgaJڪVN"WtO?0(3>#iO*eYL^ZMby׶BӗQ@p?CICZ ,Wy~~~-?Ci z U>\sz4l=L?7Yj䍵BڢoE̟"i; z(|Hj{x\߲BbBc7A@{["FwFS+Ay?mfs; <4fNONSBD` hhzT]UEu"wE`mChQ4xF= @бSi71w?999vP[&k @ރgßF![\+wb|R;v찫07GѠw m5chǡ\#k1wOֺue;5 @Юʖn sm fNn𱏑6?/m$ + N+f`OSS:tHY Be7XftXܩ<`-5L_a"0=KJ+d'Nvjc-vz UUȶλɓ6?\w64vz1w#GX睅 |wn*?_?^M& a紁ئ+-?M/΍QA f@FdNѭl `@ ]Μ9c紁6iC zdRDﾊP ,η+L2z}~ @ppP0EDDP 6Y0Qo?T@a P`` %&&Ruuua@9xWk5iQX L!@6mFb9 p,ߗ2ube- W-`X :xS؅z:|;=;$ ,L+A[ԕ"+&X^sn}03O7 !/ sug z\Ix ?i @V_@ i q6pQ4封N=܈nt<=kv6{ @.0۷Svv,P AVP xqSS={V^?SUR_^ @Q[qlDm2z[[ h'C\P[CJ L)))r8--lB[nm۶ю;hΝ{nJOO={޽{iZ,.;F'NL 2 GtI***NR*//;D F, >|UheM}.v@u\Faj `qsfg#___|||>LwQxx\`EEEIq&CRRk֬bjݺur_*55v%°P+ZDߨ"~;W;a,v@L!"Â۴ ~8^zȨϜpF2WΉ,34zbJ$A@0hz,i~jh+ r ?g{3^_pߧe͡ӣaApmi' dm(^WlFdzrxO0q8-/n" p0 B. U_=15L  @0', ͲB>p@gЇ6ЀA4A@;*8 xRd-V{D&@2RWCzZ8=i 5TXnSH)uz(Xɵzwq8v h gВա $;KKynv,ҬlS>B G zjz,y4-k Ox=w']IWyw>Ʒ@в'@ArE&v5ۮ+x@RŔ89L)u> L@A@{[<;+f. 01׵gg@p"*A-#[Iz=?z,q&UğGunk , 9 ƍ\j1X1ҹqz竟8Z :Z8+ۂHZ*VHĄK0%Cu (&ZQۨ4oe8V{0e4}m$M_A_ޡ7 #  `˰h(ҁ0tېDa&QY dS4쭙+X?Cbs.}W27F"F 10&WBBoΏzKdo (_I}IAG#h4pp!4gY8ry8[N߈̄xGP$`-@eVepKiWklIKlw\_F0"Z+); RC?s~Ӗߣ4Nz@ iEfEч"sJ_p ;jJaUSSMz}0u!amhhkXi Őa:7&- m=g=.wh\n>/t6Re  k h)?v,6&?y7JZAAV;ӖuЗr >Xh@ V&yfȏѯ_=`ڏv] }I2 @^gkEv0q sM pٱzckrCb0gqqq.uV@,@;8̙J)W Pc&0 cǎTж2/>\A>ݻ< w-d4 7/64kBdP'1Oy6_0d- uI+JccU_HI[zq ϵx0fq[n\1_ԩS .7 ~1ԅ.u>3XAm qm|~!`RSSe?vgV C?Zw@k׮J fes-))`0y>]a- UHHHӧO4t^>s̕8L xT(: s29rD. ggg{:t 2GPHbӦM.sP|{ p9*...LJJݲp<$ 4|}}egF,zZOKHeeХG<H0e$4l W +UeP`` , Z ~gaP|BUUW\C .py7dyNIh =3+[DYpIL+0l0p?]o @VP )4{-rVydjQ8ﬢu;ajw(v Gh_Yy7p=1%LOB'rl*$DЌ`:~ ]~&G]hP{7T^q9X۔u{?DէYd  WY+B/ cQ Fu 8g>8G9w|\ O},xB} M̎G&EҜ-d3M26L͕g|G͔u'CP@~D9wSVߨ_?/jk|'>׶gj)fʼKlYkAݠ-/Ot7әbbώ3:ED**)zֱX#M穪p=vQ΃@ud^'d"U/IUIYΊ$t٢+k"r=3'ϋRjlsS]m ՚.PE1<C+ܾE꣍8MiqXߕ=5?tn kJB {o?Јwlml>7pȼu&*/+/>LM>C Br }J ~JKd>+gu9w^M~W P>9gӹsgq H3g~E{CՋBPggպywxGcFoC^{ ݬgcѣ[1؞p7 gӚu0gϞrr\1CG_>皯{~}ϥJ⃌oׄk \dzX<);Ël;A?AkzoM _112FKH<ϟ; 0}<<^x{{Qr\[>ywK{i5q*!~@\eР'~+ԖݣݿCϩhllxЯ；|W 7:@3O?!gq2Zhx`|j:* gil Zȳfl~]wӟ&mۺM)}BC}$7R><?䁞m?iG(GWS%%ݢo{t #pz~g࣏҂oPaalmx9 5w q¸2=N2qJ!%~?yI;z>=Os8*\Ry7Wt1 ~~;q>={Vh=}pe>#-āΦiSʌW_֍Ax\߿G0M4Yu{8t$Nd=j=/ .0E¿/TVV&}pR![{Ӧ>(~BՐshߧ;4!pCd$z7 kQqqus!+ċ'yTVP$sl6e%7rqrGGVOW?^6̉4<-k;P Tw2i546j3+P-9Cds[4l`;5GPP&j?jÇ l?ecם_㯾={:O, R tosoH}Q ⍁x?AVVyZE?y72qISuN<΁=NǏU+Vh}zDV&h\}nY@^[7!p l9sZU A!  Daa4dY⃖lmhĉGǎ?ʰUз$>"y,V?i%(:Q0 &LS3LiM3F35ST^{'<_c >5p CʎCD+(ߣyd:d<1/{W*'v|B|e CD4Lgj<GŚyLh :7\Ze?&0qwXѬ9O8Ɔ $c/ëtXb}w0Ϳ\Dd;Ļ~-9>B4VZEqpjOR]t#n ۲DTJ'a4]1_EokЫ`j}G/<pqLI{ryw&z1|=% P~sGQQ(s{Vv"WЧbmm `M oc7}p`"0+$d!"{^4'#O7g]?Ù09K$eG!"{%~T.ye? Po7dax{Oce%4W~ #ـ{UKޓ5Gp F#ȝ/O-5oC""[q"wK$g ~@^&f*d "<**þ ~3&""T\&`#0ԶjDDDe)U{&A)Z 8Wۤ!"""[B]j{zpQYyTl 0y? D(vY&sgLMM+X+1 wn*l ȋBDDDvQWචDDD.=\VDDDTf̹a_Y爈       yd "*G!UGM@/ z* |uҢ ӄtLeuLfM < ~]""Tz X[*H8$;i>3Iiek1,DD pHT$eq-EQP2vD p&dP] EyOR"@cmkӃxq@ÌWc "Z&0qU@kC(j'utj 8WL-CܧM[hmtSlh((8%hjް pXvZ*q}A%` "Z`7_V'; B"[7ETuQc "ZDү5PU.$+p+LQb "Z_q݆8<.'nhq,DD ՏP0(;A]% cH@Dt *JȎAE1&;,DDSt\V#;C "Zx8 ꒕ T ѫMղcֻo ѫ0ejyܵUj#Bv[#jQC@DtwsX4,DD税r忛Մd' 9*[ NܳW3@D4+L>\@D4ǧ#d>{ UE3@,DDs<= =â{DDPp;E%h ){EM]  ]ȅx @uh XEe X\EO   "rp p\@D4?h;ѥeKhۉO"""@ (,>` "Vtin9w;inyQ\r--[DDR\3m@D4)"" yqˁ "yʎ@%\Fp{BqˁGvrSbCma/>ULNC&w<,ft @_ Rf ZmJ4$y41151<{bOD^3lJK a P]r*hT!˫qێ&'+uXDE(ԂO 8ч4Nf5`, 2ޑ׮G4^/vmiU[pTS[ܴtY\@DY oތڪ<[5mǿ؁y4tC U5rL ${ezE-UUqۮMضDu1@uɖ[  [s5V9@ Sx eGHKPCo߄._'-C(W}nP!-[pjw-I_۽ oh^~N޶=Y.%p"@^e~ߺIvE޴");Jr1\yB|vʎRx P,DsJy'{nގni( 2@"8c?[ۆ?d(+<@X\in ߼c y9uw+˖3t.7 yW_q?lUq肿"хe㲍/~>w^)3Dey׷_,+ :b W)޺fB,qX\~l??Q Ɏ(6:G{I@^}m?yIDdGq ^p6KVU_#Wʎ! >ђU@eͭxE ŏa}o":fXl}F/!ɎRxtpaUX,q?_8GsQJRmPnt .x*;/.; 4Ƹw].wda>_<ݲ jbMJ҅4 KxDss?=(;K)XW ]$Jyn @e򨪊o<ߔE&b`KsT|^/v֗PY+r+( ZZZXvY|cP[ӐD ` G:B455}_n Z?-kkˎa)r,֘+җ YpHQܰ),H/ˏQla7&MUU\Q,@xny衇^~VdžO$eG!B UAueKN勃^~Cw_Y}Dnq$(TUx$UWY 9^VUU~}9~ :nnUqFNk/u>g#p_uuڪw#jvԠ>ɝx<5W >l@e@uJyTU{6?<#;bh.@mu5W*W ]G8Na i{&,G77Pi/_"VUO }r8+ؑ͢'d/[.5V\s?Jr-No{&wdV ֏dT @.`۪5\Zw,gp/}Ph֫5X@}Ed7EQҐDK01‰NMy-9=P(`gk / bDD1>X_ccCOTҙ :&prYA)džj , 5>1{1[}):6WXP oA:"2MOc,+p&"?*@HQ2zQWC`;<@qwD<[+Gp}_\c}MIZD"@2det]GAӠ:|>ߊ_OV> d2Y 0*`8u9=0Ht$#$"F9dy h r ÀihuXH (ʪ*zlH>"@ODT:XJ "@E4Pp'"*],TJ Y?Qc Kq'"r ""` Kp'"rZ5DD@șXh89 ""gc[q'"r0ZO܌]ʎADD@ruk ; -Y,Sw9o""㑜쓷  ʎADD`%Y j'"*,$SDDeGtZTm̏kd "" Тؑ"2ã:-ꪍ#XhAQ/cXhA׮ˎ@DDE@ XTɎ@DDE@ #T^Uv"( 0M4yQ@UU !|>w kЂ<EJid2Hd2d2r( g0 (<~=`0_קѝT-OP@*:Ϲ}Pazz A4E8F$9U3vb: @*155T*L&#;%4M8/^0D$A,C<G<G(uH@ fs HT,l&&&\;6?122rk^hD<iЂR33JȎATLOcccfcBp BH$H&F0йXhAS)-bxx###)NNND"F2DUUJX"Z ѥ麎1`xxKt/>ꂢ(@MM $8#$Z4MD 4 CCCѓ} 8{~ Gee%9xT醁a444ȎBTRt](ADr9tvv>G2{3\ZӧYp'a׮w|>^󡾾 r -jxx333òI199nA4q|F @SSZ[[]uE -4Mtvvb۶m&ϣ===(͢'ODMM ֬Y?E@KՅ6PEww792ibhhCCCggZZZv7BZ4qQڵKv"麎ӧOԩSeO0?+сd2ףZv,KВ Y"ˡNB.J&NX ֭CCCCY`e9x DN;R):u O4?-ߏcǎaڵXfHqnrB4ꇡf!<ꁉAQ0P /pa-;% O7 Bp9y1 BP)4 ͹=aĖ-[,- -hXNiXfMqBkСC󲣬 W~^tO CZ'?BptvvbH$g`ɭtAx<[BΔNqAȎl'WT<8]|槠M@ι$y`֭PU,ʦ"M*jkk-NEn1?]z1h&;ΒBH@ǡ*Q1Z Z 9N@OA8ઃn+@UU-)J I#+{nI799^z ,Nீ8_2C͎=O~ 0KOB]6m*l -<6TjUUqעTT:;;qȑT(++{K.Zl77%71Q E P^E{v* )~4M "L"XM&}-;)*`h+rssnzB ͞. hY.P(ۋ\.$ZmY${~\wuD"rׇCP(` _@5`ː C)eǹ@$Ν;,}^ВDV7]:QWW'} *BD{{; td 5B:CצWIQ{#(jbiBѳ%x0ϣ^YhIr Z:nD4 /Bq1ݻv}ZAEyٞ˘zZ2wL0fffL&-9%@K6)XW!P(`hh%庻/Ĕ)TBuס ʎD ܬ櫀b%V Ja``UUUWl*/~ZP(`ddn|A麎ĉWjh )]T 3Z2h8@pXhY ZƊ8W>Ǚ3gP&`޽wӽ*f^OKb*8 B28@MM͊,,)pzZź  lhll644{Jm![|t i C!TSB3/^T*A]ޮ,lyC`(`m̀bN155z2d&q!iurG`zYD]"C)H)|D0b@+2 db%%`ffӨc (#a`6qdQ7r*!`xB+]MpiATTT,1,b39m\fe (lV~Sd!{Bu00c^ $E,*Sy񼂶+쩩) ԟ IDATXl$K*޽{Jl}]S#]\E S$0|1hZ@(36 LNNfXh& Қ@sؚ d2'#ۍb޽'xfUQU t_ Z. QWWwVXg r@* 766EQl/6Y/dabO%I *PlY0a``~,3U`@Cؚ(|>{_S?~Gt_ Yx?9j`- 5MC?;2*ԅyc# [|T8~-e[a˻H+50]Wu * PaoI8|0NmI8tFFF|煡_9" PTwhu'''p,44M-{r"Z~aJ*ch嗊/՗mկ'|䟾-LV-n≡%w^eud܃άXy>r9cYWc!Gx =߾ 8`SM|Ϟ={Ɋ'#"{8p@c&x3K{۲0 ߿ߊ]sBw?jE."ׁ^r~`zn4!stttXqid^={ŠLD$ݻMr~}ڇ»\q 8qbOB?Qy` Gx%!ۜ4i^xai~`Ϟ=Yb 1m(!Qi:|0j4Mh@oo爵4}ѿ(rPFH$rC|>Ci裏r2@ea<ੁ;INS=#|բ8DTbXltTfhjjEUMOYJ k[K-麎)ԍ}<PP-ގ>睔 nF$C)tvvB6DTXlveRtM={:&* hCnLNNٳV!ۥQYx5_(p>{<_/A?ʡc6EH_>qO~e ǫ yqY[R#/qB'(B$"*U:|޹՗MOO{%RUЬDD%M,xmqGY?Mq/bd"` GF"&;4^CgϞ'CD@=oYU{]w"D"""@r,*m]`jjjYL#<{YXD z*}>10 |=}cEED@uv~F&Yc~r?EJDDN@T󢹮Zv )Vl{ik(|vvv". <) p&wN뺎'O.14KDc y*bQ1B.D^-b""r*r]Fv)4M[ֹtNã/v/9 9ukcXSCe/ 6Dtq,~Uo";is?94{NJ7"sYtEw$"a G}e_Vv iG11UD0*y7n^BQ~vh"Np"ZoD%mW÷nw?pԩ% wRPIRU?i ^s(Ri ,gF Py͚(>yfT'*dG >g :>gC""*,T2vFΫ޵ez{{OC69FU^ \іDMUBv288Τ89bC""*',tH@W(xP ? TE@[Q(s޳  -x)KCa\GDão kN#"Ua" `l>/{gQU}>/(Ct:3g,s]S!)6Tass%j*+zeG"Iz{{]g&?5DD YEP{u5v[:iYubd2cC""*G,}*&py+|OF6]gtKbX$x>-CP Zʥo LDj,6(gn_nkJi^gtxW*ؤ*ռ֝.mhh>4QbA}̇߻(T_7` a({%\O [ i$6y|=s%^p_75XolCCM}} ODd "y݆ \Uv rM02r&#ܪP^U࣯[Ғ-6ߓR1+YG"u "c,8X,(V1a*LWţBA1A?X,ve #, Е?" Z*VL yô1  ^+iYt]EgB?QqXhk3?򌎎0~;p"* WUȎ@;?QXģ0W\j Пf aHs"ENZBT*u?"*"XigbbEFyIX,M3>>~ѯM+.p E*ش<*'SHzR$㑆HT*BpOO(M"c R@$_ wDdm$k*4NMX$@/وfLa "bio HDT,D6i*x! @Wx!٫ d^ U"ًG"yA?"Flqj>"FtMnCDc Q&9ft@dW H" +HDrCds aY <EY)1  ??I@dBp]\OD$˝i#<<٤P(TA sa I>?Q~'"x"ɹ3y\< 0ţM=0"&3Y Hk,D$ M?l2 JDD61ٍYHDd0y'"Xl6@D%&a@30"?GDd"TrDTx4"i@DT"Xlb&R\HD%&kX4DQX4DUUd Qiш&"NAD4&:TH:"u##M #@dCQ` ⑝,"( gt$Ɏ@Dt Mb,DTBXla @d "~b IHD& ⥀DTXlxeG "@dx@v"",DjJQi` Q}"(;"[%c!٪J bDDXlzPŽ٬-ɅD$ ڪc ښDD,Dvkf "XlLdG "b Cc'; @$ڈDr,DIr@$A] @$A4F]+; $Z8 @DImM\v"r1"I%dG "c 2C,\HEQs  "9X,b@Wp`|AhC=,ɱ %T1ȅX,2Ɏ@( n\_!; ErlVv r'eG "b@PHD6aBccc#l ɎAD.`ȡ^Zv"r MNNbzzZv r-,Dd/Ɏ@T[@u&"X =hyJ1EX,#;9еeG "a(Ǐ#ˎAX[O=X c!5cKIWW/ ezcD,Eb&8\ĚJD,Efw^h&; 9[xlPdSSSطoK-ٮu# `tt{EP2^Ma1̱d||O>$eG!xkdG 2`L&w8y$ ÐJض U1X4saѣxgp̙"zxǎDTX,RXIwó>aKm7mkʘGvrbE( PSS*򑬌cGszyi" Ef `v&ɓ'qIh4h4P( !zgW:{=Dd=LA ]T똘Ąf͗UUϖUUϖp ī(yyn9BkP:4o1MDbxNA[=Je/!~?~?b$dG+)wj_>+;  4GJ4ff199^!PUUŜ/oO9΅DdZ?W4M^SO=M~ @DbXV`-;4U e "hd&ǏR]]]#H݄p0^ӏi.Tw (;9 $y:/LXXX-;9 dYwA/zUhb`YP(dǐFUU<ȎADû֔.plƒc@k"7xLU@}촁"ܟ"U|t]G__Z[[eGfۦueFnLDPL LJث- ޹QԹI:5Qe@ٝ ǫb̾& Exӧ[ru<QX\pE%*L<&&C*|+& S:Gue;_'dG!"F7R])yO'<"tw~Z*e "`2zʇ3;GׇL&Sdz]wȎAD@%)UPo><[} p@am ]cQc֕R.&K{vwwy[QUJ xnkP@oo J[0CxDTXrc>L?p)ٶ or1Dc5_/Q&=J'ѐDTXQ zҔh$o.1`4[wrr6%*m6LJrDTbXqLxadM,O:eCg[w $W#Ue^8<EQpՎm_BDrX4Mi! }}<,h9oT*eSL&D$ 9^+yskhhD$ 9^gʳ-Y.| 9f''/V6EnbGTUUo@emL*&#o TQQ7Y2!}QqPY<8MMMr_';  m*yuJ|>7Av"**;/{`@ss3<@D|/~ _@egFi&Q"^+dg!"kPYf^oxͯ, 9_ƻJv׊$֣cLz!ri]PIUFv׋&Z[d 1ReB?#WI㨊wo5МhcZo^ŀǔ@(߶[dGWV$1\7/=x @aFW(RðzQ\/cTd'_,lmP=eG!r&-**/3,7]yKGQxq!ܖN !U#Db  w1h 4{١CKv˝/@(^SQG@x(!"0YHz|`ys;3|٩nQʒP}rXK̺VV=}/( g9d2x_ǓyBvI?wZ8Vw܁O~e[nA(¾瞓,\5_*9ӯ~oVY9}泘ȱ>ޕݔJ7ހ?gΜ?y=rTv"Gb~۷_rޅo|[| B7CQؿ_v"G]U?g$lݺ eG! =s$ !ɻ{{'TU9YHuGyKY7Ʒ| QJJ2ķlܸe ִFeG`~c7 ɎC$moD"?7 ISW_OH$dG300| ɝ***ڵhD?[ѵGw4{-o>}_gFYvX ?۟Avr<}ˎBTTC;wڲ9 ߢUvۻ8SNK90xaD YnFa&pL3#OCagʜ nɃ af $2l9^Mi݋~*"2ZQ_Nؒ+=33"Y06ӉV9i4$$%"9%EG !AA!:7wlǮlZblvveEanF߰ =#YQ^EAuS+Oev\hjÇyi- ؑ5Am+/#7/(R0N':D屣m*uS___N*f3i_ ם7))ɄbZg"2 Du5:/R0̬xaz Izk 1L}Oq%_qaA56~k) )x:4ԭ7 $GcקQnWjff--I\u#m`BS, A$ 7o^ǩzU| Ɩ(uu 7!6op>$IKEKT-!7/w30sa;-s e2y?+QUIՉ3ug=] m6^"P1oooYeV Z_{=LRҐn&ucE(Z[[qV1{lM/h4BR'3 <.2ApYq}d;P_I5k"IO3g˿^JTF\\Rg0Ҧp?6]FR'y0kFDDy} _ҘIENDB`libtmux-0.45.0/docs/_static/img/icons/icon-72x72.png000066400000000000000000000103031475667375600220050ustar00rootroot00000000000000PNG  IHDRHHUG pHYs}DuIDATx TWǙ393{N۴A($j\tLt\2&3Nw:1q9ubG%-q#hQPiM|U~D h#)UX鳻I][\n{洱P7@n՝qĀJ.}1HZ pPi_H<Ըwc(Vx@2@ЈsQTYH֩%/ޫgR~1`|NS8xQ. ?uw {H9tm;^jIg}}[(RhzU<^Xd᳅µ8$vN?+//G^^Μ9'NѣBǏǩSR[ܺYsV.$n[DeehHjJ%  eÕPjEff&Ξ= 8@4REW,IWvư9r111PT h*D%"56ϴ7J$`d{Hܛ]<@׫7ppzPmz+Wpaz;jV4h#֙4&!<&aqU^:,&JS2h:h#wj&"BXe=lA&[ϷUaCr}s`2hv(H=©ѡmiV H.2sJYIi@R cԉO[M 4Gp޶$QlZI wPIFT:Wښ%m'$qpd\sRH!I{%J)QRSS%rl11YCݲO6_W&L Lj"yb`wR+SZ~.j=t=8oi֗QT<keddظW"S$E1^?w);;fh4u!̍~^?loI2rě wfe4#搩FȰk1iEw…Ά ЍHY_wی\݋cOrr28-zn2˖5|him{c:,ki[<Fętse y-3l\T ^Eҥᐲt/H;0]`3 fͳk$=/ O⪘r;'V3ٶzc5u8<pNqdM˱!W< c0<:qE"I=w cP>ڒY!~,Zn=Z1=I.1fzSH"@ @]˃B#&9΢eW6 "s)7\#a˹, jݍlOM)$> =c@a0x}9]KUv`0FO7ۼ'ρ> 9!Mb߹u4tsX%#oM j*mt/a{Qbx [ ߾h {)"nG*^Yb@ TEemu%6jh T]MWs`̢GoKe-#@[A2L܈<ԶU GAI /.PDTKy,^\jGŒwh,⇨X7/P5>ڜ d*;QM PڣF8R2=p*Oܚfd|z*y3y%xeyF㽘A(QACc]b7(u4aU(nMӀL@z zh6v-^onr{7By~}/ߞ79_ե&, !TEZ F &BlB/$޸`iP;"v\(h_0dkArHFc2̈Hh9eo*R,Z]]}KyhoE,)׎vHAVXĈy& disC,,U7P,!@)YRk߸q53x2㯣~, +{1fOֈK8[C1$TWq)_6*?V*H j/ !k5xbDw _z"*JŰ'Z!UKUTSۄ wѽ(п=Jy12knP=,R Ir)A>àO`ʤ(TF1^n{=Y*qMM0EEC/?_C1Ǜ4<+'f \\7ލ R^7ГO M@qQͦry/ ZVgt>=g 9sݷߊg`YoqAG?)zgSx_*xΞܱTn p,!@s< yw \γӹ3Jg|qM;`"wgŞ?wh xf04lc"u_07s'Fg!HA3 C.TQ VWc"j,k*|$51*&띅$@P1Ri t=,޸LlL\w1OuP%B oh,J"@*\$\%BEn=GұMy4ݝ7@@]v-nB+45w p6%~q۽m=`com Iy,CeyPײ+@ֽ|k@7vKJ8Jb} ˳ײ򱍅"@AVK䗖r) Q\d99n|? y,t(DyY 粙-# PVVj-E,/Et @ R2D^(,*FYЛ<ś:dt:ÌFUdqqq] pMgO b >'2m(@b.P|"~oaYI,?E!\{'v&tJL*&Ĝ'OfP*R9Qu@B숾q9g4Bzn_JFz/,*VάܜYH/ ;jMi|LSoC4Hr~AmUUK|󞐘;9"z-HQSP  $Hv-$(:&\{TJS&M~W7j/ׯ]=qRK~w hH&[coїM尩߾A%J"@%B y6`p@3,TA"R|2NlkE4Ydff"==iii<9GߧzGoO=qV*NAu!I'kw'ܹs8|0 V!3=}N >>_O^CK=+yۢPQRf "tDb?Cu'$ u04 \c8'kiAKq|:uE+Zm",_L(h! C1es&zmk?CQ̠zt경0>*%m)^JE4ST/ڸaJv2%rUNgU,'EttYFaE x nK0Mt|(?ʗ7 ˥TxvКo5Ъ"g3++W,])$''Ӎ ((*Yb!HY#!KEhzvװ|x~,_ʟ Dr|>J^?]17 [e"P(RTM,=wBB=$K b1}߁rwm*dCR@^ՏIS$AF.i)Boȧɓ'\Z)4juf4{EnP~TOV_{ Ga2ዝ*.B@`BBBp]N`oȧ!ivp ~S !*JtчOhwi g\V>Ճ곅ՋՏ,$ vi+uJDDDDkZ )KoPW ̵~hï!hG!*#RȎS"L1!{P];}O` !11oV}}o|y9[b 'M/!a70$ nSC3g϶uzLMMX,2ZwZYZ'\w`Z7L[f,Uz" wڕ$FjH~YYPXXVBN(&ce ,4Z:asE޽|nnXb]a"Po. ch>+ݑA0(o>J/<7+y}R=BK+}q%z/A :p9!e !5r /`pw$( {=++1~Q>r͖QKx:ƳO?`JfaR~fx`:GUC ."^5|)]K5͖u(hT ûo3ݼ'27-_1mU8^_=7vƍt ޸6k>g`$@CH>m&ZYDKDN&e,$$gBJoµ\e߁..s9H_~ú?5^0x'+HOJZ3.B Yy5CUE9* Fa7[,ׯ_w>k{0 .xaW/9šNļ+*qq|] }ƒYE yGDE@  :C:ɂ+[,1ywr'P[Q*~*Kw2L\)UTVJ%F@֣N*LYaNl"@ GhD5p `_JJ{G?fS; P$@S <?!@:~N.K;kO^YܣQ֍r P_S $> A wYqfh? E`H;_8wv=* ^^ucĖZYTSqgT ${JHe:pגQ]S܄A]M?c0_ɹOqR1 ̤;?BaKu<^4#ߙ@VҦ@DEEs.^Ɖ$& m )))C/222pm.tEt^OHϚ71n^,Ÿ7B7?~/ -:@utVЕpEk]3~v@i6n CaNҰă*;haA)0b4Q*ߋNF!',6B a{ûkC_h^a" u5{ bڊ :-qTJzR-ںA#a 3a:0ii8#&:|>uu[u·(TOUzmP#:2 EEF]TX=@7a:@p CSu1GTWuwzamaV~Fэ1Oh|#Bn,^<%|RJtSZ"Tԣ$^$?]QZ&Y c(0֧% 1 Ugb<@^)=cƊHC瓳 == gC Re7!hz8RAMLQ2G &DI pJ&-ŏE_V=BM0ԞwOWF1!H<:Kk=%1`Lm0^/8tԡHrTc%HD(녊F?#zm z?W'yᕗ=0cˆ~d/5A* ) O m &xx /BMm=RRuxx/ 7/ סv7;yW?|w~DM]>/`$ڪR ?=!'ZJB_\*TV'!O=O7WHV6Ox9VKGcǶDZ)2F/7n~3b}hljBqQOе8Љn/0"^ijO>Iu=yˡK||p#- Y'Kma[6o)wwznFZXt|aMpDW5#y9qx^W\A=3!,08G ^xv?gGw $:A@G iod<\01GCPr#ϣr*c9KKIENDB`libtmux-0.45.0/docs/_static/img/libtmux.svg000066400000000000000000000252701475667375600206630ustar00rootroot00000000000000 libtmux Blue Square Group object (Shape) Blue Square shadow object (Shape) Blue Square object (Shape) Yellow Square Group object (Shape) Yellow Square Shadow object (Shape) Yellow Square object (Shape) Bottom bar object (Shape) Light Blue Square Group object (Shape) Light Blue Square Shadow 1 object (Shape) Light Blue Square object (Shape) Light Blue Square Shadow 2 object (Shape) Gear object (Group) Gear Shadow object (Shape) Gear object (Shape) libtmux libtmux-0.45.0/docs/_templates/000077500000000000000000000000001475667375600164035ustar00rootroot00000000000000libtmux-0.45.0/docs/_templates/book.html000066400000000000000000000014441475667375600202260ustar00rootroot00000000000000

The book!

The Tao of tmux is available on Leanpub and Kindle (Amazon).

Read and browse the book for free on the web.

Amazon Kindle libtmux-0.45.0/docs/_templates/layout.html000066400000000000000000000043301475667375600206060ustar00rootroot00000000000000{% extends "!layout.html" %} {%- block extrahead %} {{ super() }} {%- if theme_show_meta_manifest_tag == true %} {% endif -%} {%- if theme_show_meta_og_tags == true %} {% endif -%} {%- if theme_show_meta_app_icon_tags == true %} {% endif -%} {% endblock %} libtmux-0.45.0/docs/_templates/sidebar/000077500000000000000000000000001475667375600200145ustar00rootroot00000000000000libtmux-0.45.0/docs/_templates/sidebar/projects.html000066400000000000000000000047451475667375600225450ustar00rootroot00000000000000 libtmux-0.45.0/docs/about.md000066400000000000000000000070511475667375600157050ustar00rootroot00000000000000(internals)= (about)= # About :::{seealso} {ref}`api` ::: ```{currentmodule} libtmux ``` libtmux is a [typed](https://docs.python.org/3/library/typing.html) [abstraction layer] for tmux. It builds upon the concept of targets `-t`, to direct commands against individual sessions, windows and panes and `FORMATS`, template variables exposed by tmux to describe their properties. Think of `-t` analogously to [scope]. {class}`common.TmuxRelationalObject` acts as a container to connect the relations of {class}`Server`, {class}`Session`, {class}`Window` and {class}`Pane`. | Object | Child | Parent | | ---------------- | ---------------- | ---------------- | | {class}`Server` | {class}`Session` | None | | {class}`Session` | {class}`Window` | {class}`Server` | | {class}`Window` | {class}`Pane` | {class}`Session` | | {class}`Pane` | None | {class}`Window` | Internally, tmux allows multiple servers to be run on a system. Each one uses a socket. The server-client architecture is executed so cleanly, many users don't think about it. tmux automatically connects to a default socket name and location for you if none (`-L`, `-S`) is specified. A server will be created automatically upon starting if none exists. A server can have multiple sessions. `Ctrl+a s` can be used to switch between sessions running on the server. Sessions, windows and panes all have their own unique identifier for internal purposes. {class}`common.TmuxMappingObject` will make use of the unique identifiers (`session_id`, `window_id`, `pane_id`) to look up the data stored in the {class}`Server` object. | Object | Prefix | Example | | ---------------- | ------ | ----------------------------------------- | | {class}`Server` | N/A | N/A, uses `socket-name` and `socket-path` | | {class}`Session` | `$` | `$13` | | {class}`Window` | `@` | `@3243` | | {class}`Pane` | `%` | `%5433` | ## Similarities to tmux and Pythonics libtmux was built in the spirit of understanding how tmux operates and how python objects and tools can abstract the APIs in a pleasant way. libtmux uses `FORMATTERS` in tmux to give identity attributes to {class}`Session`, {class}`Window` and {class}`Pane` objects. See [format.c]. [format.c]: https://github.com/tmux/tmux/blob/master/format.c How is libtmux able to keep references to panes, windows and sessions? > Tmux has unique IDs for sessions, windows and panes. > > panes use `%`, such as `%1234` > > windows use `@`, such as `@2345` > > sessions use `$`, such as `$13` > > How is libtmux able to handle windows with no names? > Tmux provides `window_id` as a unique identifier. > > What is a {pane,window}\_index vs a {pane,window,session}\_id? > Pane index refers to the order of a pane on the screen. > > Window index refers to the number of the window in the session. > > To assert pane, window and session data, libtmux will use > {meth}`Server.sessions()`, {meth}`Session.windows()`, > {meth}`Window.panes()` to update objects. ## Naming conventions Because this is a python abstraction and commands like `new-window` have dashes (-) replaced with underscores (\_). ## Reference - tmux docs - tmux source code [abstraction layer]: http://en.wikipedia.org/wiki/Abstraction_layer [scope]: https://en.wikipedia.org/wiki/Variable_(computer_science)#Scope_and_extent libtmux-0.45.0/docs/api/000077500000000000000000000000001475667375600150175ustar00rootroot00000000000000libtmux-0.45.0/docs/api/common.md000066400000000000000000000001131475667375600166240ustar00rootroot00000000000000# Utilities ```{eval-rst} .. automodule:: libtmux.common :members: ``` libtmux-0.45.0/docs/api/constants.md000066400000000000000000000001161475667375600173530ustar00rootroot00000000000000# Constants ```{eval-rst} .. automodule:: libtmux.constants :members: ``` libtmux-0.45.0/docs/api/exceptions.md000066400000000000000000000001111475667375600175130ustar00rootroot00000000000000# Exceptions ```{eval-rst} .. automodule:: libtmux.exc :members: ``` libtmux-0.45.0/docs/api/index.md000066400000000000000000000001771475667375600164550ustar00rootroot00000000000000(api)= (reference)= # API Reference ```{toctree} properties servers sessions windows panes constants common exceptions ``` libtmux-0.45.0/docs/api/panes.md000066400000000000000000000006411475667375600164500ustar00rootroot00000000000000(panes)= # Panes - Contain [pseudoterminal]s ([pty(4)][pty(4)]) - Exist inside {ref}`Windows` - Identified by `%`, e.g. `%313` [pseudoterminal]: https://en.wikipedia.org/wiki/Pseudoterminal [pty(4)]: https://www.freebsd.org/cgi/man.cgi?query=pty&sektion=4 ```{eval-rst} .. autoclass:: libtmux.Pane :members: :inherited-members: :private-members: :show-inheritance: :member-order: bysource ``` libtmux-0.45.0/docs/api/properties.md000066400000000000000000000035731475667375600175450ustar00rootroot00000000000000(properties)= # Properties Get access to the data attributes behind tmux sessions, windows and panes. This is done through accessing the [formats][formats] available in `list-sessions`, `list-windows` and `list-panes`. Open two terminals: Terminal one: start tmux in a separate terminal: ```console $ tmux ``` Terminal two: `python` or `ptpython` if you have it: ```console $ python ``` Import libtmux: ```python >>> import libtmux ``` Attach default tmux {class}`~libtmux.Server` to `t`: ```python >>> import libtmux >>> t = libtmux.Server() >>> t Server(socket_path=/tmp/tmux-.../default) ``` ## Session Get the {class}`~libtmux.Session` object: ```python >>> session = server.sessions[0] >>> session Session($1 libtmux_...) ``` Quick access to basic attributes: ```python >>> session.session_name 'libtmux_...' >>> session.session_id '$1' ``` To see all attributes for a session: ```python from libtmux.neo import Obj >>> sorted(list(Obj.__dataclass_fields__.keys())) ['session_attached', 'session_created', ...] ``` ```python >>> session.session_windows '...' ``` ## Windows The same concepts apply for {class}`~libtmux.Window`: ```python >>> window = session.active_window >>> window Window(@1 ...:..., Session($1 ...)) ``` Basics: ```python >>> window.window_name '...' >>> window.window_id '@1' >>> window.window_height '...' >>> window.window_width '...' ``` Use attribute access for details not accessible via properties: ```python >>> window.window_panes '1' ``` ## Panes Get the {class}`~libtmux.Pane`: ```python >>> pane = window.active_pane >>> pane Pane(%1 Window(@1 ...:..., Session($1 libtmux_...))) ``` Basics: ```python >>> pane.pane_current_command '...' >>> type(pane.pane_current_command) >>> pane.pane_height '...' >>> pane.pane_width '...' >>> pane.pane_index '0' ``` [formats]: http://man.openbsd.org/OpenBSD-5.9/man1/tmux.1#FORMATS libtmux-0.45.0/docs/api/servers.md000066400000000000000000000007101475667375600170300ustar00rootroot00000000000000(servers)= # Servers - Identified by _socket path_ and _socket name_ - May have >1 servers running of tmux at the same time. - Contain {ref}`Sessions` (which contain {ref}`Windows`, which contain {ref}`Panes`) tmux initializes a server automatically on first running (e.g. executing `tmux`) ```{eval-rst} .. autoclass:: libtmux.Server :members: :inherited-members: :private-members: :show-inheritance: :member-order: bysource ``` libtmux-0.45.0/docs/api/sessions.md000066400000000000000000000004571475667375600172150ustar00rootroot00000000000000(sessions)= # Sessions - Exist inside {ref}`Servers` - Contain {ref}`Windows` (which contain {ref}`Panes`) - Identified by `$`, e.g. `$313` ```{eval-rst} .. autoclass:: libtmux.Session :members: :inherited-members: :private-members: :show-inheritance: :member-order: bysource ``` libtmux-0.45.0/docs/api/windows.md000066400000000000000000000004401475667375600170310ustar00rootroot00000000000000(windows)= # Windows - Exist inside {ref}`Sessions` - Contain {ref}`Panes` - Identified by `@`, e.g. `@313` ```{module} libtmux ``` ```{eval-rst} .. autoclass:: Window :members: :inherited-members: :private-members: :show-inheritance: :member-order: bysource ``` libtmux-0.45.0/docs/conf.py000066400000000000000000000146631475667375600155570ustar00rootroot00000000000000# flake8: NOQA: E501 """Sphinx configuration for libtmux.""" from __future__ import annotations import contextlib import inspect import pathlib import sys import typing as t from os.path import relpath import libtmux if t.TYPE_CHECKING: from sphinx.application import Sphinx # Get the project root dir, which is the parent dir of this cwd = pathlib.Path(__file__).parent project_root = cwd.parent project_src = project_root / "src" sys.path.insert(0, str(project_src)) sys.path.insert(0, str(cwd / "_ext")) # package data about: dict[str, str] = {} with (project_src / "libtmux" / "__about__.py").open() as fp: exec(fp.read(), about) extensions = [ "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx_autodoc_typehints", "sphinx.ext.todo", "sphinx.ext.linkcode", "sphinx.ext.napoleon", "sphinx_inline_tabs", "sphinx_copybutton", "sphinxext.opengraph", "sphinxext.rediraffe", "myst_parser", "linkify_issues", ] myst_enable_extensions = [ "colon_fence", "substitution", "replacements", "strikethrough", "linkify", ] templates_path = ["_templates"] source_suffix = {".rst": "restructuredtext", ".md": "markdown"} master_doc = "index" project = about["__title__"] project_copyright = about["__copyright__"] version = "{}".format(".".join(about["__version__"].split("."))[:2]) release = "{}".format(about["__version__"]) exclude_patterns = ["_build"] pygments_style = "monokai" pygments_dark_style = "monokai" html_favicon = "_static/favicon.ico" html_static_path = ["_static"] html_css_files = ["css/custom.css"] html_extra_path = ["manifest.json"] html_theme = "furo" html_theme_path: list[str] = [] html_theme_options: dict[str, str | list[dict[str, str]]] = { "light_logo": "img/libtmux.svg", "dark_logo": "img/libtmux.svg", "footer_icons": [ { "name": "GitHub", "url": about["__github__"], "html": """ """, "class": "", }, ], "source_repository": f"{about['__github__']}/", "source_branch": "master", "source_directory": "docs/", "announcement": "Friendly reminder: 📌 Pin the package, libtmux is pre-1.0 and APIs will be changing throughout 2025.", } html_sidebars = { "**": [ "sidebar/scroll-start.html", "sidebar/brand.html", "sidebar/search.html", "sidebar/navigation.html", "sidebar/projects.html", "sidebar/scroll-end.html", ], } # linkify_issues issue_url_tpl = f"{about['__github__']}/issues/{{issue_id}}" # sphinx.ext.autodoc autoclass_content = "both" autodoc_member_order = "bysource" # Automatically extract typehints when specified and place them in # descriptions of the relevant function/method. autodoc_typehints = "description" # Don't show class signature with the class' name. autodoc_class_signature = "separated" toc_object_entries_show_parents = "hide" # sphinx-copybutton copybutton_prompt_text = ( r">>> |\.\.\. |> |\$ |\# | In \[\d*\]: | {2,5}\.\.\.: | {5,8}: " ) copybutton_prompt_is_regexp = True copybutton_remove_prompts = True # sphinxext-rediraffe rediraffe_redirects = "redirects.txt" rediraffe_branch = "master~1" # sphinxext.opengraph ogp_site_url = about["__docs__"] ogp_image = "_static/img/icons/icon-192x192.png" ogp_site_name = about["__title__"] intersphinx_mapping = { "python": ("https://docs.python.org/", None), "pytest": ("https://docs.pytest.org/en/stable/", None), } def linkcode_resolve(domain: str, info: dict[str, str]) -> None | str: """ Determine the URL corresponding to Python object. Notes ----- From https://github.com/numpy/numpy/blob/v1.15.1/doc/source/conf.py, 7c49cfa on Jul 31. License BSD-3. https://github.com/numpy/numpy/blob/v1.15.1/LICENSE.txt """ if domain != "py": return None modname = info["module"] fullname = info["fullname"] submod = sys.modules.get(modname) if submod is None: return None obj = submod for part in fullname.split("."): try: obj = getattr(obj, part) except Exception: # noqa: PERF203 return None # strip decorators, which would resolve to the source of the decorator # possibly an upstream bug in getsourcefile, bpo-1764286 try: unwrap = inspect.unwrap except AttributeError: pass else: if callable(obj): obj = unwrap(obj) try: fn = inspect.getsourcefile(obj) except Exception: fn = None if not fn: return None try: source, lineno = inspect.getsourcelines(obj) except Exception: lineno = None linespec = f"#L{lineno}-L{lineno + len(source) - 1}" if lineno else "" fn = relpath(fn, start=pathlib.Path(libtmux.__file__).parent) if "dev" in about["__version__"]: return "{}/blob/master/{}/{}/{}{}".format( about["__github__"], "src", about["__package_name__"], fn, linespec, ) return "{}/blob/v{}/{}/{}/{}{}".format( about["__github__"], about["__version__"], "src", about["__package_name__"], fn, linespec, ) def remove_tabs_js(app: Sphinx, exc: Exception) -> None: """Remove tabs.js from _static after build.""" # Fix for sphinx-inline-tabs#18 if app.builder.format == "html" and not exc: tabs_js = pathlib.Path(app.builder.outdir) / "_static" / "tabs.js" with contextlib.suppress(FileNotFoundError): tabs_js.unlink() # When python 3.7 deprecated, use missing_ok=True def setup(app: Sphinx) -> None: """Configure Sphinx app hooks.""" app.connect("build-finished", remove_tabs_js) libtmux-0.45.0/docs/developing.md000066400000000000000000000102751475667375600167310ustar00rootroot00000000000000# Development Install [git] and [uv] Clone: ```console $ git clone https://github.com/tmux-python/libtmux.git ``` ```console $ cd libtmux ``` Install packages: ```console $ uv sync --all-extras --dev ``` [installation documentation]: https://docs.astral.sh/uv/getting-started/installation/ [git]: https://git-scm.com/ [uv]: https://github.com/astral-sh/uv Makefile commands prefixed with `watch_` will watch files and rerun. ## Tests ```console $ uv run py.test ``` ### Helpers ```console $ make test ``` Rerun tests on file change: ```console $ make watch_test ``` (requires [entr(1)]) ### Pytest plugin :::{seealso} See {ref}`pytest_plugin`. ::: ## Documentation Default preview server: http://localhost:8023 [sphinx-autobuild] will automatically build the docs, watch for file changes and launch a server. From home directory: ```console $ make start_docs ``` From inside `docs/`: ```console $ make start ``` [sphinx-autobuild]: https://github.com/executablebooks/sphinx-autobuild ### Manual documentation (the hard way) ```console $ cd docs/ $ make html ``` to build. ```console $ make serve ``` to start http server. Helpers: ```console $ make build_docs $ make serve_docs ``` Rebuild docs on file change: ```console $ make watch_docs ``` (requires [entr(1)]) Rebuild docs and run server via one terminal: ```console $ make dev_docs ``` (requires above, and {command}`make(1)` with `-J` support, e.g. GNU Make) ## Linting ### ruff The project uses [ruff] to handle formatting, sorting imports and linting. ````{tab} Command uv: ```console $ uv run ruff ``` If you setup manually: ```console $ ruff check . ``` ```` ````{tab} make ```console $ make ruff ``` ```` ````{tab} Watch ```console $ make watch_ruff ``` requires [entr(1)]. ```` ````{tab} Fix files uv: ```console $ uv run ruff check . --fix ``` If you setup manually: ```console $ ruff check . --fix ``` ```` #### ruff format [ruff format] is used for formatting. ````{tab} Command uv: ```console $ uv run ruff format . ``` If you setup manually: ```console $ ruff format . ``` ```` ````{tab} make ```console $ make ruff_format ``` ```` ### mypy [mypy] is used for static type checking. ````{tab} Command uv: ```console $ uv run mypy . ``` If you setup manually: ```console $ mypy . ``` ```` ````{tab} make ```console $ make mypy ``` ```` ````{tab} Watch ```console $ make watch_mypy ``` requires [entr(1)]. ```` ## Releasing Since this software is used by tens of thousands of users daily, we don't want to release breaking changes. Additionally this is packaged on large Linux/BSD distros, so we must be mindful of architectural changes. Choose what the next version is. Assuming it's version 0.9.0, it could be: - 0.9.0post0: postrelease, if there was a packaging issue - 0.9.1: bugfix / security / tweak - 0.10.0: breaking changes, new features Let's assume we pick 0.9.1 `CHANGES`: Assure any PRs merged since last release are mentioned. Give a thank you to the contributor. Set the header with the new version and the date. Leave the "current" header and _Insert changes/features/fixes for next release here_ at the top: ``` current ------- - *Insert changes/features/fixes for next release here* libtmux 0.9.1 (2020-10-12) -------------------------- - :issue:`1`: Fix bug ``` `libtmux/__init__.py` and `__about__.py` - Set version ```console $ git commit -m 'Tag v0.9.1' ``` ```console $ git tag v0.9.1 ``` After `git push` and `git push --tags`, CI will automatically build and deploy to PyPI. ### Releasing via GitHub Actions (manual) This isn't used yet since package maintainers may want setup.py in the source. See https://github.com/tmux-python/tmuxp/issues/625. As of v0.10, [uv] handles virtualenv creation, package requirements, versioning, building, and publishing. Therefore there is no setup.py or requirements files. Update `__version__` in `__about__.py` and `pyproject.toml`: ```console git commit -m 'build(libtmux): Tag v0.1.1' git tag v0.1.1 git push git push --tags ``` [twine]: https://twine.readthedocs.io/ [uv]: https://github.com/astral-sh/uv [entr(1)]: http://eradman.com/entrproject/ [ruff format]: https://docs.astral.sh/ruff/formatter/ [ruff]: https://ruff.rs [mypy]: http://mypy-lang.org/ libtmux-0.45.0/docs/glossary.md000066400000000000000000000027321475667375600164370ustar00rootroot00000000000000(glossary)= # Glossary ```{glossary} tmuxp A tool to manage workspaces with tmux. A pythonic abstraction of tmux. tmux tmux(1) The tmux binary. Used internally to distinguish tmuxp is only a layer on top of tmux. kaptan configuration management library, see [kaptan on github](https://github.com/emre/kaptan). Server Tmux runs in the background of your system as a process. The server holds multiple {term}`Session`. By default, tmux automatically starts the server the first time ``$ tmux`` is run. A server contains {term}`session`'s. tmux starts the server automatically if it's not running. Advanced cases: multiple can be run by specifying ``[-L socket-name]`` and ``[-S socket-path]``. Client Attaches to a tmux {term}`server`. When you use tmux through CLI, you are using tmux as a client. Session Inside a tmux {term}`server`. The session has 1 or more {term}`Window`. The bottom bar in tmux show a list of windows. Normally they can be navigated with ``Ctrl-a [0-9]``, ``Ctrl-a n`` and ``Ctrl-a p``. Sessions can have a ``session_name``. Uniquely identified by ``session_id``. Window Entity of a {term}`session`. Can have 1 or more {term}`pane`. Panes can be organized with a layouts. Windows can have names. Pane Linked to a {term}`Window`. a pseudoterminal. Target A target, cited in the manual as ``[-t target]`` can be a session, window or pane. ``` libtmux-0.45.0/docs/history.md000066400000000000000000000001421475667375600162660ustar00rootroot00000000000000(changes)= (changelog)= (history)= ```{currentmodule} libtmux ``` ```{include} ../CHANGES ``` libtmux-0.45.0/docs/index.md000066400000000000000000000005441475667375600157020ustar00rootroot00000000000000--- hide-toc: true --- (index)= ```{include} ../README.md ``` ## Table of Contents :hidden: ```{toctree} :maxdepth: 2 quickstart about topics/index api/index pytest-plugin/index test-helpers/index ``` ```{toctree} :caption: Project :hidden: developing internals/index history migration glossary GitHub ``` libtmux-0.45.0/docs/internals/000077500000000000000000000000001475667375600162455ustar00rootroot00000000000000libtmux-0.45.0/docs/internals/dataclasses.md000066400000000000000000000002321475667375600210530ustar00rootroot00000000000000# Dataclass helpers - `libtmux._internal.dataclasses` ```{eval-rst} .. automodule:: libtmux._internal.dataclasses :members: :special-members: ``` libtmux-0.45.0/docs/internals/index.md000066400000000000000000000014111475667375600176730ustar00rootroot00000000000000(internals)= # 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](https://github.com/tmux-python/libtmux/issues). ::: ```{toctree} dataclasses query_list ``` ## Environmental variables (LIBTMUX_TMUX_FORMAT_SEPARATOR)= ### tmux format separator ```{versionadded} 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 . libtmux-0.45.0/docs/internals/query_list.md000066400000000000000000000001761475667375600207730ustar00rootroot00000000000000# List querying - `libtmux._internal.query_list` ```{eval-rst} .. automodule:: libtmux._internal.query_list :members: ``` libtmux-0.45.0/docs/manifest.json000066400000000000000000000023271475667375600167530ustar00rootroot00000000000000{ "name": "libtmux", "short_name": "libtmux", "description": "scripting library / orm for tmux", "theme_color": "#2196f3", "background_color": "#fff", "display": "browser", "Scope": "https://libtmux.git-pull.com/", "start_url": "https://libtmux.git-pull.com/", "icons": [ { "src": "_static/img/icons/icon-72x72.png", "sizes": "72x72", "type": "image/png" }, { "src": "_static/img/icons/icon-96x96.png", "sizes": "96x96", "type": "image/png" }, { "src": "_static/img/icons/icon-128x128.png", "sizes": "128x128", "type": "image/png" }, { "src": "_static/img/icons/icon-144x144.png", "sizes": "144x144", "type": "image/png" }, { "src": "_static/img/icons/icon-152x152.png", "sizes": "152x152", "type": "image/png" }, { "src": "_static/img/icons/icon-192x192.png", "sizes": "192x192", "type": "image/png" }, { "src": "_static/img/icons/icon-384x384.png", "sizes": "384x384", "type": "image/png" }, { "src": "_static/img/icons/icon-512x512.png", "sizes": "512x512", "type": "image/png" } ], "splash_pages": null } libtmux-0.45.0/docs/migration.md000066400000000000000000000001161475667375600165570ustar00rootroot00000000000000(migration)= ```{currentmodule} libtmux ``` ```{include} ../MIGRATION ``` libtmux-0.45.0/docs/pytest-plugin/000077500000000000000000000000001475667375600170725ustar00rootroot00000000000000libtmux-0.45.0/docs/pytest-plugin/index.md000066400000000000000000000100571475667375600205260ustar00rootroot00000000000000(pytest_plugin)= # tmux `pytest` plugin libtmux provides pytest fixtures for tmux. The plugin automatically manages setup and teardown of an independent tmux server. ```{seealso} Using the pytest plugin? Do you want more flexibility? Correctness? Power? Defaults changed? [Connect with us] on the tracker, we want to know your case, we won't stabilize APIs until we're sure everything is by the book. [connect with us]: https://github.com/tmux-python/libtmux/discussions ``` ```{module} libtmux.pytest_plugin ``` ## Usage Install `libtmux` via the python package manager of your choosing, e.g. ```console $ pip install libtmux ``` The pytest plugin will be automatically detected via pytest, and the fixtures will be added. ### Real world usage View libtmux's own [tests/](https://github.com/tmux-python/libtmux/tree/master/tests) as well as tmuxp's [tests/](https://github.com/tmux-python/tmuxp/tree/master/tests). libtmux's tests `autouse` the {ref}`recommended-fixtures` above to ensure stable test execution, assertions and object lookups in the test grid. ## pytest-tmux `pytest-tmux` works through providing {ref}`pytest fixtures ` - so read up on those! The plugin's fixtures guarantee a fresh, headless {command}`tmux(1)` server, session, window, or pane is passed into your test. (recommended-fixtures)= ## Recommended fixtures These fixtures are automatically used when the plugin is enabled and `pytest` is run. - Creating temporary, test directories for: - `/home/` ({func}`home_path`) - `/home/${user}` ({func}`user_path`) - Default `.tmux.conf` configuration with these settings ({func}`config_file`): - `base-index -g 1` These are set to ensure panes and windows can be reliably referenced and asserted. ## Setting a tmux configuration If you would like {func}`session fixture ` to automatically use a configuration, you have a few options: - Pass a `config_file` into {class}`~libtmux.Server` - Set the `HOME` directory to a local or temporary pytest path with a configuration file You could also read the code and override {func}`server fixture ` in your own doctest. (custom_session_params)= ### Custom session parameters You can override `session_params` to customize the `session` fixture. The dictionary will directly pass into {meth}`Server.new_session` keyword arguments. ```python import pytest @pytest.fixture def session_params(): return { 'x': 800, 'y': 600 } def test_something(session): assert session ``` The above will assure the libtmux session launches with `-x 800 -y 600`. (temp_server)= ### Creating temporary servers If you need multiple independent tmux servers in your tests, the {func}`TestServer fixture ` provides a factory that creates servers with unique socket names. Each server is automatically cleaned up when the test completes. ```python def test_something(TestServer): Server = TestServer() # Get unique partial'd Server server = Server() # Create server instance session = server.new_session() assert server.is_alive() ``` You can also use it with custom configurations, similar to the {ref}`server fixture `: ```python def test_with_config(TestServer, tmp_path): config_file = tmp_path / "tmux.conf" config_file.write_text("set -g status off") Server = TestServer() server = Server(config_file=str(config_file)) ``` This is particularly useful when testing interactions between multiple tmux servers or when you need to verify behavior across server restarts. (set_home)= ### Setting a temporary home directory ```python import pathlib import pytest @pytest.fixture(autouse=True, scope="function") def set_home( monkeypatch: pytest.MonkeyPatch, user_path: pathlib.Path, ): monkeypatch.setenv("HOME", str(user_path)) ``` ## Fixtures ```{eval-rst} .. automodule:: libtmux.pytest_plugin :members: :inherited-members: :private-members: :show-inheritance: :member-order: bysource ``` libtmux-0.45.0/docs/quickstart.md000066400000000000000000000241511475667375600167650ustar00rootroot00000000000000(quickstart)= # Quickstart libtmux allows for developers and system administrators to control live tmux sessions using python code. In this example, we will launch a tmux session and control the windows from inside a live tmux session. (requirements)= ## Requirements - [tmux] - [pip] - for this handbook's examples [tmux]: https://tmux.github.io/ (installation)= ## Installation Next, ensure `libtmux` is installed: ```console $ pip install --user libtmux ``` (developmental-releases)= ### Developmental releases New versions of libtmux are published to PyPI as alpha, beta, or release candidates. In their versions you will see notification like `a1`, `b1`, and `rc1`, respectively. `1.10.0b4` would mean the 4th beta release of `1.10.0` before general availability. - [pip]\: ```console $ pip install --user --upgrade --pre libtmux ``` via trunk (can break easily): - [pip]\: ```console $ pip install --user -e git+https://github.com/tmux-python/libtmux.git#egg=libtmux ``` [pip]: https://pip.pypa.io/en/stable/ [ptpython]: https://github.com/prompt-toolkit/ptpython ## Start a tmux session Now, let's open a tmux session. ```console $ tmux new-session -n bar -s foo ``` This tutorial will be using the session and window name in the example. Window name `-n`: `bar` Session name `-s`: `foo` ## Control tmux via python :::{seealso} {ref}`api` ::: ```console $ python ``` For commandline completion, you can also use [ptpython]. ```console $ pip install --user ptpython ``` ```console $ ptpython ``` ```{module} libtmux ``` First, we can grab a {class}`Server`. ```python >>> import libtmux >>> server = libtmux.Server() >>> server Server(socket_path=/tmp/tmux-.../default) ``` :::{tip} You can also use [tmuxp]'s [`tmuxp shell`] to drop straight into your current tmux server / session / window pane. [tmuxp]: https://tmuxp.git-pull.com/ [`tmuxp shell`]: https://tmuxp.git-pull.com/cli/shell.html ::: :::{note} You can specify a `socket_name`, `socket_path` and `config_file` in your server object. `libtmux.Server(socket_name='mysocket')` is equivalent to `$ tmux -L mysocket`. ::: `server` is now a living object bound to the tmux server's Sessions, Windows and Panes. ## Raw, contextual commands New session: ```python >>> server.cmd('new-session', '-d', '-P', '-F#{session_id}').stdout[0] '$2' ``` ```python >>> session.cmd('new-window', '-P').stdout[0] 'libtmux...:2.0' ``` From raw command output, to a rich {class}`Window` object (in practice and as shown later, you'd use {meth}`Session.new_window()`): ```python >>> Window.from_window_id(window_id=session.cmd('new-window', '-P', '-F#{window_id}').stdout[0], server=session.server) Window(@2 2:..., Session($1 libtmux_...)) ``` Create a pane from a window: ```python >>> window.cmd('split-window', '-P', '-F#{pane_id}').stdout[0] '%2' ``` Raw output directly to a {class}`Pane` (in practice, you'd use {meth}`Window.split()`): ```python >>> Pane.from_pane_id(pane_id=window.cmd('split-window', '-P', '-F#{pane_id}').stdout[0], server=window.server) Pane(%... Window(@1 1:..., Session($1 libtmux_...))) ``` ## Find your {class}`Session` If you have multiple tmux sessions open, all methods in {class}`Server` are available. We can list sessions with {meth}`Server.sessions`: ```python >>> server.sessions [Session($1 ...), Session($0 ...)] ``` This returns a list of {class}`Session` objects you can grab. We can find our current session with: ```python >>> server.sessions[0] Session($1 ...) ``` However, this isn't guaranteed, libtmux works against current tmux information, the session's name could be changed, or another tmux session may be created, so {meth}`Server.sessions` and {meth}`Server.windows` exist as a lookup. ## Get session by ID tmux sessions use the `$[0-9]` convention as a way to identify sessions. `$1` is whatever the ID `sessions()` returned above. ```python >>> server.sessions.filter(session_id='$1')[0] Session($1 ...) ``` You may `session = server.get_by_id('$')` to use the session object. ## Get session by name / other properties ```python >>> server.sessions[0].rename_session('foo') Session($1 foo) >>> server.sessions.filter(session_name="foo")[0] Session($1 foo) >>> server.sessions.get(session_name="foo") Session($1 foo) ``` With `filter`, pass in attributes and return a list of matches. In this case, a {class}`Server` holds a collection of child {class}`Session`. {class}`Session` and {class}`Window` both utilize `filter` to sift through Windows and Panes, respectively. So you may now use: ```python >>> server.sessions[0].rename_session('foo') Session($1 foo) >>> session = server.sessions.get(session_name="foo") >>> session Session($1 foo) ``` to give us a `session` object to play with. ## Playing with our tmux session We now have access to `session` from above with all of the methods available in {class}`Session`. Let's make a {meth}`Session.new_window`, in the background: ```python >>> session.new_window(attach=False, window_name="ha in the bg") Window(@2 ...:ha in the bg, Session($1 ...)) ``` So a few things: 1. `attach=False` meant to create a new window, but not to switch to it. It is the same as `$ tmux new-window -d`. 2. `window_name` may be specified. 3. Returns the {class}`Window` object created. :::{note} Use the API reference {ref}`api` for more commands. ::: Let's delete that window ({meth}`Session.kill_window`). Method 1: Use passthrough to tmux's `target` system. ```python >>> session.kill_window(window.window_id) ``` The window in the bg disappeared. This was the equivalent of `$ tmux kill-window -t'ha in'` Internally, tmux uses `target`. Its specific behavior depends on what the target is, view the tmux manpage for more information: ``` 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. ``` In this case, you can also go back in time and recreate the window again. The CLI should have history, so navigate up with the arrow key. ```python >>> session.new_window(attach=False, window_name="ha in the bg") Window(@2 ...:ha in the bg, Session($1 ...)) ``` Try to kill the window by the matching id `@[0-9999]`. ```python >>> session.new_window(attach=False, window_name="ha in the bg") Window(@2 ...:ha in the bg, Session($1 ...)) >>> session.kill_window('ha in the bg') ``` In addition, you could also `.kill_window` direction from the {class}`Window` object: ```python >>> window = session.new_window(attach=False, window_name="check this out") >>> window Window(@2 2:check this out, Session($1 ...)) ``` And kill: ```python >>> window.kill() ``` Use {meth}`Session.windows` and {meth}`Session.windows.filter()` to list and sort through active {class}`Window`'s. ## Manipulating windows Now that we know how to create windows, let's use one. Let's use {meth}`Session.active_window()` to grab our current window. ```python >>> window = session.active_window ``` `window` now has access to all of the objects inside of {class}`Window`. Let's create a pane, {meth}`Window.split`: ```python >>> window.split(attach=False) Pane(%2 Window(@1 ...:..., Session($1 ...))) ``` Powered up. Let's have a break down: 1. `window = session.active_window()` gave us the {class}`Window` of the current attached to window. 2. `attach=False` assures the cursor didn't switch to the newly created pane. 3. Returned the created {class}`Pane`. Also, since you are aware of this power, let's commemorate the experience: ```python >>> window.rename_window('libtmuxower') Window(@1 ...:..., Session($1 ...)) ``` You should have noticed {meth}`Window.rename_window` renamed the window. ## Moving cursor across windows and panes You have two ways you can move your cursor to new sessions, windows and panes. For one, arguments such as `attach=False` can be omittted. ```python >>> pane = window.split() ``` This gives you the {class}`Pane` along with moving the cursor to a new window. You can also use the `.select_*` available on the object, in this case the pane has {meth}`Pane.select()`. ```python >>> pane = window.split(attach=False) ``` ```python >>> pane.select() Pane(%1 Window(@1 ...:..., Session($1 ...))) ``` ```{eval-rst} .. todo:: create a ``kill_pane()`` method. ``` ```{eval-rst} .. todo:: have a ``.kill()`` and ``.select()`` proxy for Server, Session, Window and Pane objects. ``` ## Sending commands to tmux panes remotely As long as you have the object, or are iterating through a list of them, you can use `.send_keys`. ```python >>> window = session.new_window(attach=False, window_name="test") >>> pane = window.split(attach=False) >>> pane.send_keys('echo hey', enter=False) ``` See the other window, notice that {meth}`Pane.send_keys` has "`echo hey`" written, _still in the prompt_. `enter=False` can be used to send keys without pressing return. In this case, you may leave it to the user to press return himself, or complete a command using {meth}`Pane.enter()`: ```python >>> pane.enter() Pane(%1 ...) ``` ### Avoid cluttering shell history `suppress_history=True` can send commands to pane windows and sessions **without** them being visible in the history. ```python >>> pane.send_keys('echo Howdy', enter=True, suppress_history=True) ``` In this case, {meth}`Pane.send_keys` has " `echo Howdy`" written, automatically sent, the leading space character prevents adding it to the user's shell history. Omitting `enter=false` means the default behavior (sending the command) is done, without needing to use `pane.enter()` after. ## Final notes These objects created use tmux's internal usage of ID's to make servers, sessions, windows and panes accessible at the object level. You don't have to see the tmux session to be able to orchestrate it. After all, {class}`WorkspaceBuilder` uses these same internals to build your sessions in the background. :) :::{seealso} If you want to dig deeper, check out {ref}`API`, the code for and our [test suite] (see {ref}`development`.) ::: [workspacebuilder.py]: https://github.com/tmux-python/libtmux/blob/master/libtmux/workspacebuilder.py [test suite]: https://github.com/tmux-python/libtmux/tree/master/tests [ptpython]: https://github.com/prompt-toolkit/ptpython libtmux-0.45.0/docs/redirects.txt000066400000000000000000000013071475667375600167740ustar00rootroot00000000000000"panes.md" "reference/panes.md" "properties.md" "reference/properties.md" "servers.md" "reference/servers.md" "windows.md" "reference/windows.md" "traversal.md" "topics/traversal.md" "sessions.md" "reference/sessions.md" "api.md" "reference/index.md" "pytest-plugin.md" "pytest-plugin/index.md" "reference/common.md" "api/common.md" "reference/constants.md" "api/constants.md" "reference/exceptions.md" "api/exceptions.md" "reference/index.md" "api/index.md" "reference/panes.md" "api/panes.md" "reference/properties.md" "api/properties.md" "reference/servers.md" "api/servers.md" "reference/sessions.md" "api/sessions.md" "reference/windows.md" "api/windows.md" "pytest-plugin/test.md" "test-helpers/index.md" libtmux-0.45.0/docs/requirements.txt000066400000000000000000000000331475667375600175260ustar00rootroot00000000000000-r ../requirements/doc.txt libtmux-0.45.0/docs/test-helpers/000077500000000000000000000000001475667375600166655ustar00rootroot00000000000000libtmux-0.45.0/docs/test-helpers/constants.md000066400000000000000000000002661475667375600212270ustar00rootroot00000000000000# Constants Test-related constants used across libtmux test helpers. ```{eval-rst} .. automodule:: libtmux.test.constants :members: :undoc-members: :show-inheritance: ``` libtmux-0.45.0/docs/test-helpers/environment.md000066400000000000000000000002631475667375600215540ustar00rootroot00000000000000# Environment Environment variable mocking utilities for tests. ```{eval-rst} .. automodule:: libtmux.test.environment :members: :undoc-members: :show-inheritance: ``` libtmux-0.45.0/docs/test-helpers/index.md000066400000000000000000000003071475667375600203160ustar00rootroot00000000000000# Test helpers Test helpers for libtmux and downstream libraries. ```{toctree} :maxdepth: 2 constants environment random temporary ``` ```{eval-rst} .. automodule:: libtmux.test :members: ``` libtmux-0.45.0/docs/test-helpers/random.md000066400000000000000000000002521475667375600204660ustar00rootroot00000000000000# Random Random string generation utilities for test names. ```{eval-rst} .. automodule:: libtmux.test.random :members: :undoc-members: :show-inheritance: ``` libtmux-0.45.0/docs/test-helpers/temporary.md000066400000000000000000000003061475667375600212300ustar00rootroot00000000000000# Temporary Objects Context managers for temporary tmux objects (sessions, windows). ```{eval-rst} .. automodule:: libtmux.test.temporary :members: :undoc-members: :show-inheritance: ``` libtmux-0.45.0/docs/topics/000077500000000000000000000000001475667375600155475ustar00rootroot00000000000000libtmux-0.45.0/docs/topics/context_managers.md000066400000000000000000000067431475667375600214440ustar00rootroot00000000000000(context_managers)= # Context Managers libtmux provides context managers for all main tmux objects to ensure proper cleanup of resources. This is done through Python's `with` statement, which automatically handles cleanup when you're done with the tmux objects. Open two terminals: Terminal one: start tmux in a separate terminal: ```console $ tmux ``` Terminal two, `python` or `ptpython` if you have it: ```console $ python ``` Import `libtmux`: ```python import libtmux ``` ## Server Context Manager Create a temporary server that will be killed when you're done: ```python >>> with Server() as server: ... session = server.new_session() ... print(server.is_alive()) True >>> print(server.is_alive()) # Server is killed after exiting context False ``` ## Session Context Manager Create a temporary session that will be killed when you're done: ```python >>> server = Server() >>> with server.new_session() as session: ... print(session in server.sessions) ... window = session.new_window() True >>> print(session in server.sessions) # Session is killed after exiting context False ``` ## Window Context Manager Create a temporary window that will be killed when you're done: ```python >>> server = Server() >>> session = server.new_session() >>> with session.new_window() as window: ... print(window in session.windows) ... pane = window.split() True >>> print(window in session.windows) # Window is killed after exiting context False ``` ## Pane Context Manager Create a temporary pane that will be killed when you're done: ```python >>> server = Server() >>> session = server.new_session() >>> window = session.new_window() >>> with window.split() as pane: ... print(pane in window.panes) ... pane.send_keys('echo "Hello"') True >>> print(pane in window.panes) # Pane is killed after exiting context False ``` ## Nested Context Managers Context managers can be nested to create a clean hierarchy of tmux objects that are automatically cleaned up: ```python >>> with Server() as server: ... with server.new_session() as session: ... with session.new_window() as window: ... with window.split() as pane: ... pane.send_keys('echo "Hello"') ... # Do work with the pane ... # Everything is cleaned up automatically when exiting contexts ``` This ensures that: 1. The pane is killed when exiting its context 2. The window is killed when exiting its context 3. The session is killed when exiting its context 4. The server is killed when exiting its context The cleanup happens in reverse order (pane → window → session → server), ensuring proper resource management. ## Benefits Using context managers provides several advantages: 1. **Automatic Cleanup**: Resources are automatically cleaned up when you're done with them 2. **Clean Code**: No need to manually call `kill()` methods 3. **Exception Safety**: Resources are cleaned up even if an exception occurs 4. **Hierarchical Cleanup**: Nested contexts ensure proper cleanup order 5. **Resource Management**: Prevents resource leaks by ensuring tmux objects are properly destroyed ## When to Use Context managers are particularly useful when: 1. Creating temporary tmux objects for testing 2. Running short-lived tmux sessions 3. Managing multiple tmux servers 4. Ensuring cleanup in scripts that may raise exceptions 5. Creating isolated environments that need to be cleaned up afterward [target]: http://man.openbsd.org/OpenBSD-5.9/man1/tmux.1#COMMANDS libtmux-0.45.0/docs/topics/index.md000066400000000000000000000004131475667375600171760ustar00rootroot00000000000000--- orphan: true --- # Topics Explore libtmux’s core functionalities and underlying principles at a high level, while providing essential context and detailed explanations to help you understand its design and usage. ```{toctree} context_managers traversal ``` libtmux-0.45.0/docs/topics/traversal.md000066400000000000000000000061351475667375600201010ustar00rootroot00000000000000(traversal)= # Traversal libtmux provides convenient access to move around the hierarchy of sessions, windows and panes in tmux. This is done by libtmux's object abstraction of {term}`target`s (the `-t` argument) and the permanent internal ID's tmux gives to objects. Open two terminals: Terminal one: start tmux in a separate terminal: ```console $ tmux ``` Terminal two, `python` or `ptpython` if you have it: ```console $ python ``` ## Setup First, create a test session: ```python >>> session = server.new_session() # Create a test session using existing server ``` ## Server Level View the server's representation: ```python >>> server # doctest: +ELLIPSIS Server(socket_name=...) ``` Get all sessions in the server: ```python >>> server.sessions # doctest: +ELLIPSIS [Session($... ...)] ``` Get all windows across all sessions: ```python >>> server.windows # doctest: +ELLIPSIS [Window(@... ..., Session($... ...))] ``` Get all panes across all windows: ```python >>> server.panes # doctest: +ELLIPSIS [Pane(%... Window(@... ..., Session($... ...)))] ``` ## Session Level Get first session: ```python >>> session = server.sessions[0] >>> session # doctest: +ELLIPSIS Session($... ...) ``` Get windows in a session: ```python >>> session.windows # doctest: +ELLIPSIS [Window(@... ..., Session($... ...))] ``` Get active window and pane: ```python >>> session.active_window # doctest: +ELLIPSIS Window(@... ..., Session($... ...)) >>> session.active_pane # doctest: +ELLIPSIS Pane(%... Window(@... ..., Session($... ...))) ``` ## Window Level Get a window and inspect its properties: ```python >>> window = session.windows[0] >>> window.window_index # doctest: +ELLIPSIS '...' ``` Access the window's parent session: ```python >>> window.session # doctest: +ELLIPSIS Session($... ...) >>> window.session.session_id == session.session_id True ``` Get panes in a window: ```python >>> window.panes # doctest: +ELLIPSIS [Pane(%... Window(@... ..., Session($... ...)))] ``` Get active pane: ```python >>> window.active_pane # doctest: +ELLIPSIS Pane(%... Window(@... ..., Session($... ...))) ``` ## Pane Level Get a pane and traverse upwards: ```python >>> pane = window.panes[0] >>> pane.window.window_id == window.window_id True >>> pane.session.session_id == session.session_id True >>> pane.server is server True ``` ## Filtering and Finding Objects Find windows by index: ```python >>> session.windows.filter(window_index=window.window_index) # doctest: +ELLIPSIS [Window(@... ..., Session($... ...))] ``` Get a specific pane by ID: ```python >>> window.panes.get(pane_id=pane.pane_id) # doctest: +ELLIPSIS Pane(%... Window(@... ..., Session($... ...))) ``` ## Checking Relationships Check if objects are related: ```python >>> window in session.windows True >>> pane in window.panes True >>> session in server.sessions True ``` Check if a window is active: ```python >>> window.window_id == session.active_window.window_id True ``` Check if a pane is active: ```python >>> pane.pane_id == window.active_pane.pane_id True ``` [target]: http://man.openbsd.org/OpenBSD-5.9/man1/tmux.1#COMMANDS libtmux-0.45.0/pyproject.toml000066400000000000000000000114731475667375600162400ustar00rootroot00000000000000[project] name = "libtmux" version = "0.45.0" description = "Typed library that provides an ORM wrapper for tmux, a terminal multiplexer." requires-python = ">=3.9,<4.0" authors = [ {name = "Tony Narlock", email = "tony@git-pull.com"} ] license = { text = "MIT" } classifiers = [ "Development Status :: 5 - Production/Stable", "License :: OSI Approved :: MIT License", "Operating System :: POSIX", "Operating System :: MacOS :: MacOS X", "Environment :: Web Environment", "Framework :: Pytest", "Intended Audience :: Developers", "Programming Language :: Python", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: Utilities", "Topic :: System :: Shells", "Typing :: Typed", ] keywords = ["tmux", "session manager", "terminal", "ncurses"] homepage = "http://github.com/tmux-python/libtmux/" readme = "README.md" packages = [ { include = "*", from = "src" }, ] include = [ { path = "CHANGES", format = "sdist" }, { path = "MIGRATION", format = "sdist" }, { path = ".tmuxp.yaml", format = "sdist" }, { path = "tests", format = "sdist" }, { path = "docs", format = "sdist" }, { path = "conftest.py", format = "sdist" }, ] [project.urls] "Bug Tracker" = "https://github.com/tmux-python/libtmux/issues" Documentation = "https://libtmux.git-pull.com" Repository = "https://github.com/tmux-python/libtmux" Changes = "https://github.com/tmux-python/libtmux/blob/master/CHANGES" [tool.uv] dev-dependencies = [ # Docs "sphinx", "furo", "gp-libs", "sphinx-autobuild", "sphinx-autodoc-typehints", "sphinx-inline-tabs", "sphinxext-opengraph", "sphinx-copybutton", "sphinxext-rediraffe", "myst-parser", "linkify-it-py", # Testing "typing-extensions; python_version < '3.11'", "gp-libs", "pytest", "pytest-rerunfailures", "pytest-mock", "pytest-watcher", "pytest-xdist", # Coverage "codecov", "coverage", "pytest-cov", # Lint "ruff", "mypy", ] [dependency-groups] docs = [ "sphinx", "furo", "gp-libs", "sphinx-autobuild", "sphinx-autodoc-typehints", "sphinx-inline-tabs", "sphinxext-opengraph", "sphinx-copybutton", "sphinxext-rediraffe", "myst-parser", "linkify-it-py", ] testing = [ "typing-extensions; python_version < '3.11'", "gp-libs", "pytest", "pytest-rerunfailures", "pytest-mock", "pytest-watcher", ] coverage =[ "codecov", "coverage", "pytest-cov", ] lint = [ "typing-extensions; python_version < '3.11'", "ruff", "mypy", ] [project.entry-points.pytest11] libtmux = "libtmux.pytest_plugin" [build-system] requires = ["hatchling"] build-backend = "hatchling.build" [tool.mypy] strict = true python_version = "3.9" files = [ "src", "tests", ] [tool.coverage.run] branch = true parallel = true omit = [ "*/_compat.py", "docs/conf.py", "tests/test_*.py", "tests/*/test_*.py", ] [tool.coverage.report] show_missing = true skip_covered = true exclude_lines = [ "pragma: no cover", "def __repr__", "raise NotImplementedError", "return NotImplemented", "def parse_args", "if TYPE_CHECKING:", "if t.TYPE_CHECKING:", "@overload( |$)", "from __future__ import annotations", ] [tool.ruff] target-version = "py39" [tool.ruff.lint] select = [ "E", # pycodestyle "F", # pyflakes "I", # isort "UP", # pyupgrade "A", # flake8-builtins "B", # flake8-bugbear "C4", # flake8-comprehensions "COM", # flake8-commas "EM", # flake8-errmsg "Q", # flake8-quotes "PTH", # flake8-use-pathlib "SIM", # flake8-simplify "TRY", # Trycertatops "PERF", # Perflint "RUF", # Ruff-specific rules "D", # pydocstyle "FA100", # future annotations ] ignore = [ "COM812", # missing trailing comma, ruff format conflict ] extend-safe-fixes = [ "UP006", "UP007", ] pyupgrade.keep-runtime-typing = false [tool.ruff.lint.isort] known-first-party = [ "libtmux", ] combine-as-imports = true required-imports = [ "from __future__ import annotations", ] [tool.ruff.lint.flake8-builtins] builtins-allowed-modules = [ "dataclasses", "random", "types", ] [tool.ruff.lint.pydocstyle] convention = "numpy" [tool.ruff.lint.per-file-ignores] "*/__init__.py" = ["F401"] [tool.pytest.ini_options] addopts = [ "--tb=short", "--no-header", "--showlocals", "--doctest-docutils-modules", "-p no:doctest", "--reruns=2" ] doctest_optionflags = [ "ELLIPSIS", "NORMALIZE_WHITESPACE" ] testpaths = [ "src/libtmux", "tests", "docs", "README.md", ] filterwarnings = [ "ignore:The frontend.Option(Parser)? class.*:DeprecationWarning::", "ignore::DeprecationWarning:libtmux.*:", "ignore::DeprecationWarning:tests:", # tests/ ] libtmux-0.45.0/src/000077500000000000000000000000001475667375600141055ustar00rootroot00000000000000libtmux-0.45.0/src/libtmux/000077500000000000000000000000001475667375600155715ustar00rootroot00000000000000libtmux-0.45.0/src/libtmux/__about__.py000066400000000000000000000010501475667375600200450ustar00rootroot00000000000000"""Metadata package for libtmux.""" from __future__ import annotations __title__ = "libtmux" __package_name__ = "libtmux" __version__ = "0.45.0" __description__ = "Typed scripting library / ORM / API wrapper for tmux" __email__ = "tony@git-pull.com" __author__ = "Tony Narlock" __github__ = "https://github.com/tmux-python/libtmux" __docs__ = "https://libtmux.git-pull.com" __tracker__ = "https://github.com/tmux-python/libtmux/issues" __pypi__ = "https://pypi.org/project/libtmux/" __license__ = "MIT" __copyright__ = "Copyright 2016- Tony Narlock" libtmux-0.45.0/src/libtmux/__init__.py000066400000000000000000000011541475667375600177030ustar00rootroot00000000000000"""libtmux, a typed, pythonic API wrapper for the tmux terminal multiplexer.""" from __future__ import annotations from .__about__ import ( __author__, __copyright__, __description__, __email__, __license__, __package_name__, __title__, __version__, ) from .pane import Pane from .server import Server from .session import Session from .window import Window __all__ = ( "Pane", "Server", "Session", "Window", "__author__", "__copyright__", "__description__", "__email__", "__license__", "__package_name__", "__title__", "__version__", ) libtmux-0.45.0/src/libtmux/_compat.py000066400000000000000000000063611475667375600175730ustar00rootroot00000000000000# flake8: NOQA import functools import sys import types import typing as t console_encoding = sys.stdout.encoding # TODO Consider removing, reraise does not seem to be called anywhere def reraise( tp: t.Type[BaseException], value: BaseException, tb: types.TracebackType, ) -> t.NoReturn: if value.__traceback__ is not tb: raise (value.with_traceback(tb)) raise value import re from typing import Iterator, List, Tuple from libtmux._vendor.version import Version ### ### Legacy support for LooseVersion / LegacyVersion, e.g. 2.4-openbsd ### https://github.com/pypa/packaging/blob/21.3/packaging/version.py#L106-L115 ### License: BSD, Accessed: Jan 14th, 2022 ### LegacyCmpKey = Tuple[int, Tuple[str, ...]] _legacy_version_component_re = re.compile(r"(\d+ | [a-z]+ | \.| -)", re.VERBOSE) _legacy_version_replacement_map = { "pre": "c", "preview": "c", "-": "final-", "rc": "c", "dev": "@", } def _parse_version_parts(s: str) -> Iterator[str]: for part in _legacy_version_component_re.split(s): part = _legacy_version_replacement_map.get(part, part) if not part or part == ".": continue if part[:1] in "0123456789": # pad for numeric comparison yield part.zfill(8) else: yield "*" + part # ensure that alpha/beta/candidate are before final yield "*final" def _legacy_cmpkey(version: str) -> LegacyCmpKey: # We hardcode an epoch of -1 here. A PEP 440 version can only have a epoch # greater than or equal to 0. This will effectively put the LegacyVersion, # which uses the defacto standard originally implemented by setuptools, # as before all PEP 440 versions. epoch = -1 # This scheme is taken from pkg_resources.parse_version setuptools prior to # it's adoption of the packaging library. parts: List[str] = [] for part in _parse_version_parts(version.lower()): if part.startswith("*"): # remove "-" before a prerelease tag if part < "*final": while parts and parts[-1] == "*final-": parts.pop() # remove trailing zeros from each series of numeric parts while parts and parts[-1] == "00000000": parts.pop() parts.append(part) return epoch, tuple(parts) @functools.total_ordering class LegacyVersion: _key: LegacyCmpKey def __hash__(self) -> int: return hash(self._key) def __init__(self, version: object) -> None: self._version = str(version) self._key = _legacy_cmpkey(self._version) def __str__(self) -> str: return self._version def __lt__(self, other: object) -> bool: if isinstance(other, str): other = LegacyVersion(other) if not isinstance(other, LegacyVersion): return NotImplemented return self._key < other._key def __eq__(self, other: object) -> bool: if isinstance(other, str): other = LegacyVersion(other) if not isinstance(other, LegacyVersion): return NotImplemented return self._key == other._key def __repr__(self) -> str: return "".format(repr(str(self))) LooseVersion = LegacyVersion libtmux-0.45.0/src/libtmux/_internal/000077500000000000000000000000001475667375600175445ustar00rootroot00000000000000libtmux-0.45.0/src/libtmux/_internal/__init__.py000066400000000000000000000000001475667375600216430ustar00rootroot00000000000000libtmux-0.45.0/src/libtmux/_internal/dataclasses.py000066400000000000000000000045451475667375600224150ustar00rootroot00000000000000""":mod:`dataclasses` utilities. Note ---- This is an internal API not covered by versioning policy. """ from __future__ import annotations import dataclasses import typing as t from operator import attrgetter if t.TYPE_CHECKING: from _typeshed import DataclassInstance class SkipDefaultFieldsReprMixin: r"""Skip default fields in :func:`~dataclasses.dataclass` object representation. See Also -------- :func:`object representation ` Notes ----- Credit: Pietro Oldrati, 2022-05-08, Unilicense https://stackoverflow.com/a/72161437/1396928 Examples -------- >>> @dataclasses.dataclass() ... class Item: ... name: str ... unit_price: float = 1.00 ... quantity_on_hand: int = 0 ... >>> @dataclasses.dataclass(repr=False) ... class ItemWithMixin(SkipDefaultFieldsReprMixin): ... name: str ... unit_price: float = 1.00 ... quantity_on_hand: int = 0 ... >>> Item('Test') Item(name='Test', unit_price=1.0, quantity_on_hand=0) >>> ItemWithMixin('Test') ItemWithMixin(name=Test) >>> Item('Test', quantity_on_hand=2) Item(name='Test', unit_price=1.0, quantity_on_hand=2) >>> ItemWithMixin('Test', quantity_on_hand=2) ItemWithMixin(name=Test, quantity_on_hand=2) If you want to copy/paste the :meth:`~.__repr__()` directly, you can omit the ``repr=False``: >>> @dataclasses.dataclass ... class ItemWithMixin(SkipDefaultFieldsReprMixin): ... name: str ... unit_price: float = 1.00 ... quantity_on_hand: int = 0 ... __repr__ = SkipDefaultFieldsReprMixin.__repr__ ... >>> ItemWithMixin('Test') ItemWithMixin(name=Test) >>> ItemWithMixin('Test', unit_price=2.00) ItemWithMixin(name=Test, unit_price=2.0) >>> item = ItemWithMixin('Test') >>> item.unit_price = 2.05 >>> item ItemWithMixin(name=Test, unit_price=2.05) """ def __repr__(self: DataclassInstance) -> str: """Omit default fields in object representation.""" nodef_f_vals = ( (f.name, attrgetter(f.name)(self)) for f in dataclasses.fields(self) if attrgetter(f.name)(self) != f.default ) nodef_f_repr = ", ".join(f"{name}={value}" for name, value in nodef_f_vals) return f"{self.__class__.__name__}({nodef_f_repr})" libtmux-0.45.0/src/libtmux/_internal/query_list.py000066400000000000000000000366451475667375600223340ustar00rootroot00000000000000"""Utilities for filtering or searching :class:`list` of objects / list data. Note ---- This is an internal API not covered by versioning policy. """ from __future__ import annotations import logging import re import traceback import typing as t from collections.abc import Callable, Iterable, Mapping, Sequence logger = logging.getLogger(__name__) if t.TYPE_CHECKING: class LookupProtocol(t.Protocol): """Protocol for :class:`QueryList` filtering operators.""" def __call__( self, data: str | list[str] | Mapping[str, str], rhs: str | list[str] | Mapping[str, str] | re.Pattern[str], ) -> bool: """Return callback for :class:`QueryList` filtering operators.""" ... T = t.TypeVar("T") no_arg = object() class MultipleObjectsReturned(Exception): """The query returned multiple objects when only one was expected.""" class ObjectDoesNotExist(Exception): """The requested object does not exist.""" def keygetter( obj: Mapping[str, t.Any], path: str, ) -> None | t.Any | str | list[str] | Mapping[str, str]: """Fetch values in objects and keys, supported nested data. **With dictionaries**: >>> keygetter({ "food": { "breakfast": "cereal" } }, "food") {'breakfast': 'cereal'} >>> keygetter({ "food": { "breakfast": "cereal" } }, "food__breakfast") 'cereal' **With objects**: >>> from typing import List, Optional >>> from dataclasses import dataclass, field >>> @dataclass() ... class Food: ... fruit: List[str] = field(default_factory=list) ... breakfast: Optional[str] = None >>> @dataclass() ... class Restaurant: ... place: str ... city: str ... state: str ... food: Food = field(default_factory=Food) >>> restaurant = Restaurant( ... place="Largo", ... city="Tampa", ... state="Florida", ... food=Food( ... fruit=["banana", "orange"], breakfast="cereal" ... ) ... ) >>> restaurant Restaurant(place='Largo', city='Tampa', state='Florida', food=Food(fruit=['banana', 'orange'], breakfast='cereal')) >>> keygetter(restaurant, "food") Food(fruit=['banana', 'orange'], breakfast='cereal') >>> keygetter(restaurant, "food__breakfast") 'cereal' """ try: sub_fields = path.split("__") dct = obj for sub_field in sub_fields: if isinstance(dct, dict): dct = dct[sub_field] elif hasattr(dct, sub_field): dct = getattr(dct, sub_field) except Exception as e: traceback.print_stack() logger.debug(f"The above error was {e}") return None return dct def parse_lookup( obj: Mapping[str, t.Any], path: str, lookup: str, ) -> t.Any | None: """Check if field lookup key, e.g. "my__path__contains" has comparator, return val. If comparator not used or value not found, return None. >>> parse_lookup({ "food": "red apple" }, "food__istartswith", "__istartswith") 'red apple' It can also look up objects: >>> from dataclasses import dataclass >>> @dataclass() ... class Inventory: ... food: str >>> item = Inventory(food="red apple") >>> item Inventory(food='red apple') >>> parse_lookup(item, "food__istartswith", "__istartswith") 'red apple' """ try: if isinstance(path, str) and isinstance(lookup, str) and path.endswith(lookup): field_name = path.rsplit(lookup)[0] if field_name is not None: return keygetter(obj, field_name) except Exception as e: traceback.print_stack() logger.debug(f"The above error was {e}") return None def lookup_exact( data: str | list[str] | Mapping[str, str], rhs: str | list[str] | Mapping[str, str] | re.Pattern[str], ) -> bool: return rhs == data def lookup_iexact( data: str | list[str] | Mapping[str, str], rhs: str | list[str] | Mapping[str, str] | re.Pattern[str], ) -> bool: if not isinstance(rhs, str) or not isinstance(data, str): return False return rhs.lower() == data.lower() def lookup_contains( data: str | list[str] | Mapping[str, str], rhs: str | list[str] | Mapping[str, str] | re.Pattern[str], ) -> bool: if not isinstance(rhs, str) or not isinstance(data, (str, Mapping, list)): return False return rhs in data def lookup_icontains( data: str | list[str] | Mapping[str, str], rhs: str | list[str] | Mapping[str, str] | re.Pattern[str], ) -> bool: if not isinstance(rhs, str) or not isinstance(data, (str, Mapping, list)): return False if isinstance(data, str): return rhs.lower() in data.lower() if isinstance(data, Mapping): return rhs.lower() in [k.lower() for k in data] return False def lookup_startswith( data: str | list[str] | Mapping[str, str], rhs: str | list[str] | Mapping[str, str] | re.Pattern[str], ) -> bool: if not isinstance(rhs, str) or not isinstance(data, str): return False return data.startswith(rhs) def lookup_istartswith( data: str | list[str] | Mapping[str, str], rhs: str | list[str] | Mapping[str, str] | re.Pattern[str], ) -> bool: if not isinstance(rhs, str) or not isinstance(data, str): return False return data.lower().startswith(rhs.lower()) def lookup_endswith( data: str | list[str] | Mapping[str, str], rhs: str | list[str] | Mapping[str, str] | re.Pattern[str], ) -> bool: if not isinstance(rhs, str) or not isinstance(data, str): return False return data.endswith(rhs) def lookup_iendswith( data: str | list[str] | Mapping[str, str], rhs: str | list[str] | Mapping[str, str] | re.Pattern[str], ) -> bool: if not isinstance(rhs, str) or not isinstance(data, str): return False return data.lower().endswith(rhs.lower()) def lookup_in( data: str | list[str] | Mapping[str, str], rhs: str | list[str] | Mapping[str, str] | re.Pattern[str], ) -> bool: if isinstance(rhs, list): return data in rhs try: if isinstance(rhs, str) and isinstance(data, Mapping): return rhs in data if isinstance(rhs, str) and isinstance(data, (str, list)): return rhs in data if isinstance(rhs, str) and isinstance(data, Mapping): return rhs in data # TODO: Add a deep Mappingionary matcher # if isinstance(rhs, Mapping) and isinstance(data, Mapping): # return rhs.items() not in data.items() except Exception: return False return False def lookup_nin( data: str | list[str] | Mapping[str, str], rhs: str | list[str] | Mapping[str, str] | re.Pattern[str], ) -> bool: if isinstance(rhs, list): return data not in rhs try: if isinstance(rhs, str) and isinstance(data, Mapping): return rhs not in data if isinstance(rhs, str) and isinstance(data, (str, list)): return rhs not in data if isinstance(rhs, str) and isinstance(data, Mapping): return rhs not in data # TODO: Add a deep Mappingionary matcher # if isinstance(rhs, Mapping) and isinstance(data, Mapping): # return rhs.items() not in data.items() except Exception: return False return False def lookup_regex( data: str | list[str] | Mapping[str, str], rhs: str | list[str] | Mapping[str, str] | re.Pattern[str], ) -> bool: if isinstance(data, (str, bytes, re.Pattern)) and isinstance(rhs, (str, bytes)): return bool(re.search(rhs, data)) return False def lookup_iregex( data: str | list[str] | Mapping[str, str], rhs: str | list[str] | Mapping[str, str] | re.Pattern[str], ) -> bool: if isinstance(data, (str, bytes, re.Pattern)) and isinstance(rhs, (str, bytes)): return bool(re.search(rhs, data, re.IGNORECASE)) return False LOOKUP_NAME_MAP: Mapping[str, LookupProtocol] = { "eq": lookup_exact, "exact": lookup_exact, "iexact": lookup_iexact, "contains": lookup_contains, "icontains": lookup_icontains, "startswith": lookup_startswith, "istartswith": lookup_istartswith, "endswith": lookup_endswith, "iendswith": lookup_iendswith, "in": lookup_in, "nin": lookup_nin, "regex": lookup_regex, "iregex": lookup_iregex, } class PKRequiredException(Exception): def __init__(self, *args: object) -> None: return super().__init__("items() require a pk_key exists") class OpNotFound(ValueError): def __init__(self, op: str, *args: object) -> None: return super().__init__(f"{op} not in LOOKUP_NAME_MAP") class QueryList(list[T], t.Generic[T]): """Filter list of object/dictionaries. For small, local datasets. *Experimental, unstable*. **With dictionaries**: >>> query = QueryList( ... [ ... { ... "place": "Largo", ... "city": "Tampa", ... "state": "Florida", ... "foods": {"fruit": ["banana", "orange"], "breakfast": "cereal"}, ... }, ... { ... "place": "Chicago suburbs", ... "city": "Elmhurst", ... "state": "Illinois", ... "foods": {"fruit": ["apple", "cantelope"], "breakfast": "waffles"}, ... }, ... ] ... ) >>> query.filter(place="Chicago suburbs")[0]['city'] 'Elmhurst' >>> query.filter(place__icontains="chicago")[0]['city'] 'Elmhurst' >>> query.filter(foods__breakfast="waffles")[0]['city'] 'Elmhurst' >>> query.filter(foods__fruit__in="cantelope")[0]['city'] 'Elmhurst' >>> query.filter(foods__fruit__in="orange")[0]['city'] 'Tampa' >>> query.filter(foods__fruit__in="apple") [{'place': 'Chicago suburbs', 'city': 'Elmhurst', 'state': 'Illinois', 'foods': {'fruit': ['apple', 'cantelope'], 'breakfast': 'waffles'}}] >>> query.filter(foods__fruit__in="non_existent") [] **With objects**: >>> from typing import Any, Dict >>> from dataclasses import dataclass, field >>> @dataclass() ... class Restaurant: ... place: str ... city: str ... state: str ... foods: Dict[str, Any] >>> restaurant = Restaurant( ... place="Largo", ... city="Tampa", ... state="Florida", ... foods={ ... "fruit": ["banana", "orange"], "breakfast": "cereal" ... } ... ) >>> restaurant Restaurant(place='Largo', city='Tampa', state='Florida', foods={'fruit': ['banana', 'orange'], 'breakfast': 'cereal'}) >>> query = QueryList([restaurant]) >>> query.filter(foods__fruit__in="banana") [Restaurant(place='Largo', city='Tampa', state='Florida', foods={'fruit': ['banana', 'orange'], 'breakfast': 'cereal'})] >>> query.filter(foods__fruit__in="banana")[0].city 'Tampa' >>> query.get(foods__fruit__in="banana").city 'Tampa' **With objects (nested)**: >>> from typing import List, Optional >>> from dataclasses import dataclass, field >>> @dataclass() ... class Food: ... fruit: List[str] = field(default_factory=list) ... breakfast: Optional[str] = None >>> @dataclass() ... class Restaurant: ... place: str ... city: str ... state: str ... food: Food = field(default_factory=Food) >>> query = QueryList([ ... Restaurant( ... place="Largo", ... city="Tampa", ... state="Florida", ... food=Food( ... fruit=["banana", "orange"], breakfast="cereal" ... ) ... ), ... Restaurant( ... place="Chicago suburbs", ... city="Elmhurst", ... state="Illinois", ... food=Food( ... fruit=["apple", "cantelope"], breakfast="waffles" ... ) ... ) ... ]) >>> query.filter(food__fruit__in="banana") [Restaurant(place='Largo', city='Tampa', state='Florida', food=Food(fruit=['banana', 'orange'], breakfast='cereal'))] >>> query.filter(food__fruit__in="banana")[0].city 'Tampa' >>> query.get(food__fruit__in="banana").city 'Tampa' >>> query.filter(food__breakfast="waffles") [Restaurant(place='Chicago suburbs', city='Elmhurst', state='Illinois', food=Food(fruit=['apple', 'cantelope'], breakfast='waffles'))] >>> query.filter(food__breakfast="waffles")[0].city 'Elmhurst' >>> query.filter(food__breakfast="non_existent") [] """ data: Sequence[T] pk_key: str | None def __init__(self, items: Iterable[T] | None = None) -> None: super().__init__(items if items is not None else []) def items(self) -> list[tuple[str, T]]: if self.pk_key is None: raise PKRequiredException return [(getattr(item, self.pk_key), item) for item in self] def __eq__( self, other: object, ) -> bool: data = other if not isinstance(self, list) or not isinstance(data, list): return False if len(self) == len(data): for a, b in zip(self, data): if isinstance(a, Mapping): a_keys = a.keys() if a.keys == b.keys(): for key in a_keys: if abs(a[key] - b[key]) > 1: return False elif a != b: return False return True return False def filter( self, matcher: Callable[[T], bool] | T | None = None, **kwargs: t.Any, ) -> QueryList[T]: """Filter list of objects.""" def filter_lookup(obj: t.Any) -> bool: for path, v in kwargs.items(): try: lhs, op = path.rsplit("__", 1) if op not in LOOKUP_NAME_MAP: raise OpNotFound(op=op) except ValueError: lhs = path op = "exact" assert op in LOOKUP_NAME_MAP path = lhs data = keygetter(obj, path) if data is None or not LOOKUP_NAME_MAP[op](data, v): return False return True if callable(matcher): filter_ = matcher elif matcher is not None: def val_match(obj: str | list[t.Any] | T) -> bool: if isinstance(matcher, list): return obj in matcher return bool(obj == matcher) filter_ = val_match else: filter_ = filter_lookup return self.__class__(k for k in self if filter_(k)) def get( self, matcher: Callable[[T], bool] | T | None = None, default: t.Any | None = no_arg, **kwargs: t.Any, ) -> T | None: """Retrieve one object. Raises :exc:`MultipleObjectsReturned` if multiple objects found. Raises :exc:`ObjectDoesNotExist` if no object found, unless ``default`` stated. """ objs = self.filter(matcher=matcher, **kwargs) if len(objs) > 1: raise MultipleObjectsReturned if len(objs) == 0: if default == no_arg: raise ObjectDoesNotExist return default return objs[0] libtmux-0.45.0/src/libtmux/_vendor/000077500000000000000000000000001475667375600172255ustar00rootroot00000000000000libtmux-0.45.0/src/libtmux/_vendor/__init__.py000066400000000000000000000000001475667375600213240ustar00rootroot00000000000000libtmux-0.45.0/src/libtmux/_vendor/_structures.py000066400000000000000000000030031475667375600221550ustar00rootroot00000000000000# via https://github.com/pypa/packaging/blob/22.0/packaging/_structures.py # This file is dual licensed under the terms of the Apache License, Version # 2.0, and the BSD License. See the LICENSE file in the root of this repository # for complete details. from __future__ import annotations class InfinityType: def __repr__(self) -> str: return "Infinity" def __hash__(self) -> int: return hash(repr(self)) def __lt__(self, other: object) -> bool: return False def __le__(self, other: object) -> bool: return False def __eq__(self, other: object) -> bool: return isinstance(other, self.__class__) def __gt__(self, other: object) -> bool: return True def __ge__(self, other: object) -> bool: return True def __neg__(self: object) -> NegativeInfinityType: return NegativeInfinity Infinity = InfinityType() class NegativeInfinityType: def __repr__(self) -> str: return "-Infinity" def __hash__(self) -> int: return hash(repr(self)) def __lt__(self, other: object) -> bool: return True def __le__(self, other: object) -> bool: return True def __eq__(self, other: object) -> bool: return isinstance(other, self.__class__) def __gt__(self, other: object) -> bool: return False def __ge__(self, other: object) -> bool: return False def __neg__(self: object) -> InfinityType: return Infinity NegativeInfinity = NegativeInfinityType() libtmux-0.45.0/src/libtmux/_vendor/version.py000066400000000000000000000404621475667375600212720ustar00rootroot00000000000000# via https://github.com/pypa/packaging/blob/22.0/packaging/version.py # This file is dual licensed under the terms of the Apache License, Version # 2.0, and the BSD License. See the LICENSE file in the root of this repository # for complete details. """Backport of the ``packaging.version`` module from Python 3.8. .. testsetup:: from packaging.version import parse, Version """ from __future__ import annotations import collections import itertools import re import typing as t from collections.abc import Callable from ._structures import Infinity, InfinityType, NegativeInfinity, NegativeInfinityType __all__ = ["VERSION_PATTERN", "InvalidVersion", "Version", "parse"] InfiniteTypes = t.Union[InfinityType, NegativeInfinityType] PrePostDevType = t.Union[InfiniteTypes, tuple[str, int]] SubLocalType = t.Union[InfiniteTypes, int, str] LocalType = t.Union[ NegativeInfinityType, tuple[ t.Union[ SubLocalType, tuple[SubLocalType, str], tuple[NegativeInfinityType, SubLocalType], ], ..., ], ] CmpKey = tuple[ int, tuple[int, ...], PrePostDevType, PrePostDevType, PrePostDevType, LocalType, ] VersionComparisonMethod = Callable[[CmpKey, CmpKey], bool] _Version = collections.namedtuple( "_Version", ["epoch", "release", "dev", "pre", "post", "local"], ) def parse(version: str) -> Version: """Parse the given version string. Examples -------- >>> parse('1.0.dev1') Parameters ---------- version : The version string to parse. Raises ------ InvalidVersion When the version string is not a valid version. """ return Version(version) class InvalidVersion(ValueError): """Raised when a version string is not a valid version. >>> Version("invalid") Traceback (most recent call last): ... libtmux._vendor.version.InvalidVersion: Invalid version: 'invalid' """ def __init__(self, version: str, *args: object) -> None: return super().__init__(f"Invalid version: '{version}'") class _BaseVersion: _key: CmpKey def __hash__(self) -> int: return hash(self._key) # Please keep the duplicated `isinstance` check # in the six comparisons hereunder # unless you find a way to avoid adding overhead function calls. def __lt__(self, other: _BaseVersion) -> bool: if not isinstance(other, _BaseVersion): return NotImplemented return self._key < other._key def __le__(self, other: _BaseVersion) -> bool: if not isinstance(other, _BaseVersion): return NotImplemented return self._key <= other._key def __eq__(self, other: object) -> bool: if not isinstance(other, _BaseVersion): return NotImplemented return self._key == other._key def __ge__(self, other: _BaseVersion) -> bool: if not isinstance(other, _BaseVersion): return NotImplemented return self._key >= other._key def __gt__(self, other: _BaseVersion) -> bool: if not isinstance(other, _BaseVersion): return NotImplemented return self._key > other._key def __ne__(self, other: object) -> bool: if not isinstance(other, _BaseVersion): return NotImplemented return self._key != other._key # Deliberately not anchored to the start and end of the string, to make it # easier for 3rd party code to reuse _VERSION_PATTERN = r""" v? (?: (?:(?P[0-9]+)!)? # epoch (?P[0-9]+(?:\.[0-9]+)*) # release segment (?P
                                          # pre-release
            [-_\.]?
            (?P(a|b|c|rc|alpha|beta|pre|preview))
            [-_\.]?
            (?P[0-9]+)?
        )?
        (?P                                         # post release
            (?:-(?P[0-9]+))
            |
            (?:
                [-_\.]?
                (?Ppost|rev|r)
                [-_\.]?
                (?P[0-9]+)?
            )
        )?
        (?P                                          # dev release
            [-_\.]?
            (?Pdev)
            [-_\.]?
            (?P[0-9]+)?
        )?
    )
    (?:\+(?P[a-z0-9]+(?:[-_\.][a-z0-9]+)*))?       # local version
"""

VERSION_PATTERN = _VERSION_PATTERN
"""
A string containing the regular expression used to match a valid version.

The pattern is not anchored at either end, and is intended for embedding in larger
expressions (for example, matching a version number as part of a file name). The
regular expression should be compiled with the ``re.VERBOSE`` and ``re.IGNORECASE``
flags set.

:meta hide-value:
"""


class Version(_BaseVersion):
    """Class abstracts handling of a project's versions.

    A :class:`Version` instance is comparison aware and can be compared and
    sorted using the standard Python interfaces.

    >>> v1 = Version("1.0a5")
    >>> v2 = Version("1.0")
    >>> v1
    
    >>> v2
    
    >>> v1 < v2
    True
    >>> v1 == v2
    False
    >>> v1 > v2
    False
    >>> v1 >= v2
    False
    >>> v1 <= v2
    True
    """

    _regex = re.compile(r"^\s*" + VERSION_PATTERN + r"\s*$", re.VERBOSE | re.IGNORECASE)

    def __init__(self, version: str) -> None:
        """Initialize a Version object.

        Parameters
        ----------
        version : str
            The string representation of a version which will be parsed and normalized
            before use.

        Raises
        ------
        InvalidVersion
            If the ``version`` does not conform to PEP 440 in any way then this
            exception will be raised.
        """
        # Validate the version and parse it into pieces
        match = self._regex.search(version)
        if not match:
            raise InvalidVersion(version=version)

        # Store the parsed out pieces of the version
        self._version = _Version(
            epoch=int(match.group("epoch")) if match.group("epoch") else 0,
            release=tuple(int(i) for i in match.group("release").split(".")),
            pre=_parse_letter_version(match.group("pre_l"), match.group("pre_n")),
            post=_parse_letter_version(
                match.group("post_l"),
                match.group("post_n1") or match.group("post_n2"),
            ),
            dev=_parse_letter_version(match.group("dev_l"), match.group("dev_n")),
            local=_parse_local_version(match.group("local")),
        )

        # Generate a key which will be used for sorting
        self._key = _cmpkey(
            self._version.epoch,
            self._version.release,
            self._version.pre,
            self._version.post,
            self._version.dev,
            self._version.local,
        )

    def __repr__(self) -> str:
        """Return representation of the Version that shows all internal state.

        >>> Version('1.0.0')
        
        """
        return f""

    def __str__(self) -> str:
        """Return string representation of the version that can be rounded-tripped.

        >>> str(Version("1.0a5"))
        '1.0a5'
        """
        parts = []

        # Epoch
        if self.epoch != 0:
            parts.append(f"{self.epoch}!")

        # Release segment
        parts.append(".".join(str(x) for x in self.release))

        # Pre-release
        if self.pre is not None:
            parts.append("".join(str(x) for x in self.pre))

        # Post-release
        if self.post is not None:
            parts.append(f".post{self.post}")

        # Development release
        if self.dev is not None:
            parts.append(f".dev{self.dev}")

        # Local version segment
        if self.local is not None:
            parts.append(f"+{self.local}")

        return "".join(parts)

    @property
    def epoch(self) -> int:
        """The epoch of the version.

        >>> Version("2.0.0").epoch
        0
        >>> Version("1!2.0.0").epoch
        1
        """
        epoch: int = self._version.epoch
        return epoch

    @property
    def release(self) -> tuple[int, ...]:
        """The components of the "release" segment of the version.

        >>> Version("1.2.3").release
        (1, 2, 3)
        >>> Version("2.0.0").release
        (2, 0, 0)
        >>> Version("1!2.0.0.post0").release
        (2, 0, 0)

        Includes trailing zeroes but not the epoch or any pre-release / development /
        post-release suffixes.
        """
        release: tuple[int, ...] = self._version.release
        return release

    @property
    def pre(self) -> tuple[str, int] | None:
        """The pre-release segment of the version.

        >>> print(Version("1.2.3").pre)
        None
        >>> Version("1.2.3a1").pre
        ('a', 1)
        >>> Version("1.2.3b1").pre
        ('b', 1)
        >>> Version("1.2.3rc1").pre
        ('rc', 1)
        """
        pre: tuple[str, int] | None = self._version.pre
        return pre

    @property
    def post(self) -> int | None:
        """The post-release number of the version.

        >>> print(Version("1.2.3").post)
        None
        >>> Version("1.2.3.post1").post
        1
        """
        return self._version.post[1] if self._version.post else None

    @property
    def dev(self) -> int | None:
        """The development number of the version.

        >>> print(Version("1.2.3").dev)
        None
        >>> Version("1.2.3.dev1").dev
        1
        """
        return self._version.dev[1] if self._version.dev else None

    @property
    def local(self) -> str | None:
        """The local version segment of the version.

        >>> print(Version("1.2.3").local)
        None
        >>> Version("1.2.3+abc").local
        'abc'
        """
        if self._version.local:
            return ".".join(str(x) for x in self._version.local)
        return None

    @property
    def public(self) -> str:
        """The public portion of the version.

        >>> Version("1.2.3").public
        '1.2.3'
        >>> Version("1.2.3+abc").public
        '1.2.3'
        >>> Version("1.2.3+abc.dev1").public
        '1.2.3'
        """
        return str(self).split("+", 1)[0]

    @property
    def base_version(self) -> str:
        """The "base version" of the version.

        >>> Version("1.2.3").base_version
        '1.2.3'
        >>> Version("1.2.3+abc").base_version
        '1.2.3'
        >>> Version("1!1.2.3+abc.dev1").base_version
        '1!1.2.3'

        The "base version" is the public version of the project without any pre or post
        release markers.
        """
        parts = []

        # Epoch
        if self.epoch != 0:
            parts.append(f"{self.epoch}!")

        # Release segment
        parts.append(".".join(str(x) for x in self.release))

        return "".join(parts)

    @property
    def is_prerelease(self) -> bool:
        """Whether this version is a pre-release.

        >>> Version("1.2.3").is_prerelease
        False
        >>> Version("1.2.3a1").is_prerelease
        True
        >>> Version("1.2.3b1").is_prerelease
        True
        >>> Version("1.2.3rc1").is_prerelease
        True
        >>> Version("1.2.3dev1").is_prerelease
        True
        """
        return self.dev is not None or self.pre is not None

    @property
    def is_postrelease(self) -> bool:
        """Whether this version is a post-release.

        >>> Version("1.2.3").is_postrelease
        False
        >>> Version("1.2.3.post1").is_postrelease
        True
        """
        return self.post is not None

    @property
    def is_devrelease(self) -> bool:
        """Whether this version is a development release.

        >>> Version("1.2.3").is_devrelease
        False
        >>> Version("1.2.3.dev1").is_devrelease
        True
        """
        return self.dev is not None

    @property
    def major(self) -> int:
        """The first item of :attr:`release` or ``0`` if unavailable.

        >>> Version("1.2.3").major
        1
        """
        return self.release[0] if len(self.release) >= 1 else 0

    @property
    def minor(self) -> int:
        """The second item of :attr:`release` or ``0`` if unavailable.

        >>> Version("1.2.3").minor
        2
        >>> Version("1").minor
        0
        """
        return self.release[1] if len(self.release) >= 2 else 0

    @property
    def micro(self) -> int:
        """The third item of :attr:`release` or ``0`` if unavailable.

        >>> Version("1.2.3").micro
        3
        >>> Version("1").micro
        0
        """
        return self.release[2] if len(self.release) >= 3 else 0


def _parse_letter_version(
    letter: str,
    number: str | bytes | t.SupportsInt,
) -> tuple[str, int] | None:
    if letter:
        # We consider there to be an implicit 0 in a pre-release if there is
        # not a numeral associated with it.
        if number is None:
            number = 0

        # We normalize any letters to their lower case form
        letter = letter.lower()

        # We consider some words to be alternate spellings of other words and
        # in those cases we want to normalize the spellings to our preferred
        # spelling.
        if letter == "alpha":
            letter = "a"
        elif letter == "beta":
            letter = "b"
        elif letter in {"c", "pre", "preview"}:
            letter = "rc"
        elif letter in {"rev", "r"}:
            letter = "post"

        return letter, int(number)
    if not letter and number:
        # We assume if we are given a number, but we are not given a letter
        # then this is using the implicit post release syntax (e.g. 1.0-1)
        letter = "post"

        return letter, int(number)

    return None


_local_version_separators = re.compile(r"[\._-]")


def _parse_local_version(local: str) -> LocalType | None:
    """Take a string like abc.1.twelve and turns it into ("abc", 1, "twelve")."""
    if local is not None:
        return tuple(
            part.lower() if not part.isdigit() else int(part)
            for part in _local_version_separators.split(local)
        )
    return None


def _cmpkey(
    epoch: int,
    release: tuple[int, ...],
    pre: tuple[str, int] | None,
    post: tuple[str, int] | None,
    dev: tuple[str, int] | None,
    local: tuple[SubLocalType] | None,
) -> CmpKey:
    # When we compare a release version, we want to compare it with all of the
    # trailing zeros removed. So we'll use a reverse the list, drop all the now
    # leading zeros until we come to something non zero, then take the rest
    # re-reverse it back into the correct order and make it a tuple and use
    # that for our sorting key.
    release_ = tuple(
        reversed(list(itertools.dropwhile(lambda x: x == 0, reversed(release)))),
    )

    # We need to "trick" the sorting algorithm to put 1.0.dev0 before 1.0a0.
    # We'll do this by abusing the pre segment, but we _only_ want to do this
    # if there is not a pre or a post segment. If we have one of those then
    # the normal sorting rules will handle this case correctly.
    if pre is None and post is None and dev is not None:
        pre_: PrePostDevType = NegativeInfinity
    # Versions without a pre-release (except as noted above) should sort after
    # those with one.
    elif pre is None:
        pre_ = Infinity
    else:
        pre_ = pre

    # Versions without a post segment should sort before those with one.
    if post is None:
        post_: PrePostDevType = NegativeInfinity

    else:
        post_ = post

    # Versions without a development segment should sort after those with one.
    if dev is None:
        dev_: PrePostDevType = Infinity

    else:
        dev_ = dev

    if local is None:
        # Versions without a local segment should sort before those with one.
        local_: LocalType = NegativeInfinity
    else:
        # Versions with a local segment need that segment parsed to implement
        # the sorting rules in PEP440.
        # - Alpha numeric segments sort before numeric segments
        # - Alpha numeric segments sort lexicographically
        # - Numeric segments sort numerically
        # - Shorter versions sort before longer versions when the prefixes
        #   match exactly
        local_ = tuple(
            (i, "") if isinstance(i, int) else (NegativeInfinity, i) for i in local
        )

    return epoch, release_, pre_, post_, dev_, local_
libtmux-0.45.0/src/libtmux/common.py000066400000000000000000000324241475667375600174400ustar00rootroot00000000000000"""Helper methods and mixins for libtmux.

libtmux.common
~~~~~~~~~~~~~~

"""

from __future__ import annotations

import logging
import re
import shutil
import subprocess
import sys
import typing as t

from . import exc
from ._compat import LooseVersion

if t.TYPE_CHECKING:
    from collections.abc import Callable

logger = logging.getLogger(__name__)


#: Minimum version of tmux required to run libtmux
TMUX_MIN_VERSION = "1.8"

#: Most recent version of tmux supported
TMUX_MAX_VERSION = "3.4"

SessionDict = dict[str, t.Any]
WindowDict = dict[str, t.Any]
WindowOptionDict = dict[str, t.Any]
PaneDict = dict[str, t.Any]


class EnvironmentMixin:
    """Mixin for manager session and server level environment variables in tmux."""

    _add_option = None

    cmd: Callable[[t.Any, t.Any], tmux_cmd]

    def __init__(self, add_option: str | None = None) -> None:
        self._add_option = add_option

    def set_environment(self, name: str, value: str) -> None:
        """Set environment ``$ tmux set-environment  ``.

        Parameters
        ----------
        name : str
            the environment variable name. such as 'PATH'.
        option : str
            environment value.
        """
        args = ["set-environment"]
        if self._add_option:
            args += [self._add_option]

        args += [name, value]

        cmd = self.cmd(*args)

        if cmd.stderr:
            (
                cmd.stderr[0]
                if isinstance(cmd.stderr, list) and len(cmd.stderr) == 1
                else cmd.stderr
            )
            msg = f"tmux set-environment stderr: {cmd.stderr}"
            raise ValueError(msg)

    def unset_environment(self, name: str) -> None:
        """Unset environment variable ``$ tmux set-environment -u ``.

        Parameters
        ----------
        name : str
            the environment variable name. such as 'PATH'.
        """
        args = ["set-environment"]
        if self._add_option:
            args += [self._add_option]
        args += ["-u", name]

        cmd = self.cmd(*args)

        if cmd.stderr:
            (
                cmd.stderr[0]
                if isinstance(cmd.stderr, list) and len(cmd.stderr) == 1
                else cmd.stderr
            )
            msg = f"tmux set-environment stderr: {cmd.stderr}"
            raise ValueError(msg)

    def remove_environment(self, name: str) -> None:
        """Remove environment variable ``$ tmux set-environment -r ``.

        Parameters
        ----------
        name : str
            the environment variable name. such as 'PATH'.
        """
        args = ["set-environment"]
        if self._add_option:
            args += [self._add_option]
        args += ["-r", name]

        cmd = self.cmd(*args)

        if cmd.stderr:
            (
                cmd.stderr[0]
                if isinstance(cmd.stderr, list) and len(cmd.stderr) == 1
                else cmd.stderr
            )
            msg = f"tmux set-environment stderr: {cmd.stderr}"
            raise ValueError(msg)

    def show_environment(self) -> dict[str, bool | str]:
        """Show environment ``$ tmux show-environment -t [session]``.

        Return dict of environment variables for the session.

        .. versionchanged:: 0.13

           Removed per-item lookups. Use :meth:`libtmux.common.EnvironmentMixin.getenv`.

        Returns
        -------
        dict
            environmental variables in dict, if no name, or str if name
            entered.
        """
        tmux_args = ["show-environment"]
        if self._add_option:
            tmux_args += [self._add_option]
        cmd = self.cmd(*tmux_args)
        output = cmd.stdout
        opts = [tuple(item.split("=", 1)) for item in output]
        opts_dict: dict[str, str | bool] = {}
        for _t in opts:
            if len(_t) == 2:
                opts_dict[_t[0]] = _t[1]
            elif len(_t) == 1:
                opts_dict[_t[0]] = True
            else:
                raise exc.VariableUnpackingError(variable=_t)

        return opts_dict

    def getenv(self, name: str) -> str | bool | None:
        """Show environment variable ``$ tmux show-environment -t [session] ``.

        Return the value of a specific variable if the name is specified.

        .. versionadded:: 0.13

        Parameters
        ----------
        name : str
            the environment variable name. such as 'PATH'.

        Returns
        -------
        str
            Value of environment variable
        """
        tmux_args: tuple[str | int, ...] = ()

        tmux_args += ("show-environment",)
        if self._add_option:
            tmux_args += (self._add_option,)
        tmux_args += (name,)
        cmd = self.cmd(*tmux_args)
        output = cmd.stdout
        opts = [tuple(item.split("=", 1)) for item in output]
        opts_dict: dict[str, str | bool] = {}
        for _t in opts:
            if len(_t) == 2:
                opts_dict[_t[0]] = _t[1]
            elif len(_t) == 1:
                opts_dict[_t[0]] = True
            else:
                raise exc.VariableUnpackingError(variable=_t)

        return opts_dict.get(name)


class tmux_cmd:
    """Run any :term:`tmux(1)` command through :py:mod:`subprocess`.

    Examples
    --------
    Create a new session, check for error:

    >>> proc = tmux_cmd(f'-L{server.socket_name}', 'new-session', '-d', '-P', '-F#S')
    >>> if proc.stderr:
    ...     raise exc.LibTmuxException(
    ...         'Command: %s returned error: %s' % (proc.cmd, proc.stderr)
    ...     )
    ...

    >>> print(f'tmux command returned {" ".join(proc.stdout)}')
    tmux command returned 2

    Equivalent to:

    .. code-block:: console

        $ tmux new-session -s my session

    Notes
    -----
    .. versionchanged:: 0.8
        Renamed from ``tmux`` to ``tmux_cmd``.
    """

    def __init__(self, *args: t.Any) -> None:
        tmux_bin = shutil.which("tmux")
        if not tmux_bin:
            raise exc.TmuxCommandNotFound

        cmd = [tmux_bin]
        cmd += args  # add the command arguments to cmd
        cmd = [str(c) for c in cmd]

        self.cmd = cmd

        try:
            self.process = subprocess.Popen(
                cmd,
                stdout=subprocess.PIPE,
                stderr=subprocess.PIPE,
                text=True,
                errors="backslashreplace",
            )
            stdout, stderr = self.process.communicate()
            returncode = self.process.returncode
        except Exception:
            logger.exception(f"Exception for {subprocess.list2cmdline(cmd)}")
            raise

        self.returncode = returncode

        stdout_split = stdout.split("\n")
        # remove trailing newlines from stdout
        while stdout_split and stdout_split[-1] == "":
            stdout_split.pop()

        stderr_split = stderr.split("\n")
        self.stderr = list(filter(None, stderr_split))  # filter empty values

        if "has-session" in cmd and len(self.stderr) and not stdout_split:
            self.stdout = [self.stderr[0]]
        else:
            self.stdout = stdout_split

        logger.debug(
            "self.stdout for {cmd}: {stdout}".format(
                cmd=" ".join(cmd),
                stdout=self.stdout,
            ),
        )


def get_version() -> LooseVersion:
    """Return tmux version.

    If tmux is built from git master, the version returned will be the latest
    version appended with -master, e.g. ``2.4-master``.

    If using OpenBSD's base system tmux, the version will have ``-openbsd``
    appended to the latest version, e.g. ``2.4-openbsd``.

    Returns
    -------
    :class:`distutils.version.LooseVersion`
        tmux version according to :func:`shtuil.which`'s tmux
    """
    proc = tmux_cmd("-V")
    if proc.stderr:
        if proc.stderr[0] == "tmux: unknown option -- V":
            if sys.platform.startswith("openbsd"):  # openbsd has no tmux -V
                return LooseVersion(f"{TMUX_MAX_VERSION}-openbsd")
            msg = (
                f"libtmux supports tmux {TMUX_MIN_VERSION} and greater. This system"
                " is running tmux 1.3 or earlier."
            )
            raise exc.LibTmuxException(
                msg,
            )
        raise exc.VersionTooLow(proc.stderr)

    version = proc.stdout[0].split("tmux ")[1]

    # Allow latest tmux HEAD
    if version == "master":
        return LooseVersion(f"{TMUX_MAX_VERSION}-master")

    version = re.sub(r"[a-z-]", "", version)

    return LooseVersion(version)


def has_version(version: str) -> bool:
    """Return True if tmux version installed.

    Parameters
    ----------
    version : str
        version number, e.g. '1.8'

    Returns
    -------
    bool
        True if version matches
    """
    return get_version() == LooseVersion(version)


def has_gt_version(min_version: str) -> bool:
    """Return True if tmux version greater than minimum.

    Parameters
    ----------
    min_version : str
        tmux version, e.g. '1.8'

    Returns
    -------
    bool
        True if version above min_version
    """
    return get_version() > LooseVersion(min_version)


def has_gte_version(min_version: str) -> bool:
    """Return True if tmux version greater or equal to minimum.

    Parameters
    ----------
    min_version : str
        tmux version, e.g. '1.8'

    Returns
    -------
    bool
        True if version above or equal to min_version
    """
    return get_version() >= LooseVersion(min_version)


def has_lte_version(max_version: str) -> bool:
    """Return True if tmux version less or equal to minimum.

    Parameters
    ----------
    max_version : str
        tmux version, e.g. '1.8'

    Returns
    -------
    bool
         True if version below or equal to max_version
    """
    return get_version() <= LooseVersion(max_version)


def has_lt_version(max_version: str) -> bool:
    """Return True if tmux version less than minimum.

    Parameters
    ----------
    max_version : str
        tmux version, e.g. '1.8'

    Returns
    -------
    bool
        True if version below max_version
    """
    return get_version() < LooseVersion(max_version)


def has_minimum_version(raises: bool = True) -> bool:
    """Return True if tmux meets version requirement. Version >1.8 or above.

    Parameters
    ----------
    raises : bool
        raise exception if below minimum version requirement

    Returns
    -------
    bool
        True if tmux meets minimum required version.

    Raises
    ------
    libtmux.exc.VersionTooLow
        tmux version below minimum required for libtmux

    Notes
    -----
    .. versionchanged:: 0.7.0
        No longer returns version, returns True or False

    .. versionchanged:: 0.1.7
        Versions will now remove trailing letters per `Issue 55`_.

        .. _Issue 55: https://github.com/tmux-python/tmuxp/issues/55.
    """
    if get_version() < LooseVersion(TMUX_MIN_VERSION):
        if raises:
            msg = (
                f"libtmux only supports tmux {TMUX_MIN_VERSION} and greater. This "
                + f"system has {get_version()} installed. Upgrade your tmux to use "
                + "libtmux."
            )
            raise exc.VersionTooLow(msg)
        return False
    return True


def session_check_name(session_name: str | None) -> None:
    """Raise exception session name invalid, modeled after tmux function.

    tmux(1) session names may not be empty, or include periods or colons.
    These delimiters are reserved for noting session, window and pane.

    Parameters
    ----------
    session_name : str
        Name of session.

    Raises
    ------
    :exc:`exc.BadSessionName`
        Invalid session name.
    """
    if session_name is None or len(session_name) == 0:
        raise exc.BadSessionName(reason="empty", session_name=session_name)
    if "." in session_name:
        raise exc.BadSessionName(reason="contains periods", session_name=session_name)
    if ":" in session_name:
        raise exc.BadSessionName(reason="contains colons", session_name=session_name)


def handle_option_error(error: str) -> type[exc.OptionError]:
    """Raise exception if error in option command found.

    In tmux 3.0, show-option and show-window-option return invalid option instead of
    unknown option. See https://github.com/tmux/tmux/blob/3.0/cmd-show-options.c.

    In tmux >2.4, there are 3 different types of option errors:

    - unknown option
    - invalid option
    - ambiguous option

    In tmux <2.4, unknown option was the only option.

    All errors raised will have the base error of :exc:`exc.OptionError`. So to
    catch any option error, use ``except exc.OptionError``.

    Parameters
    ----------
    error : str
        Error response from subprocess call.

    Raises
    ------
    :exc:`exc.OptionError`, :exc:`exc.UnknownOption`, :exc:`exc.InvalidOption`,
    :exc:`exc.AmbiguousOption`
    """
    if "unknown option" in error:
        raise exc.UnknownOption(error)
    if "invalid option" in error:
        raise exc.InvalidOption(error)
    if "ambiguous option" in error:
        raise exc.AmbiguousOption(error)
    raise exc.OptionError(error)  # Raise generic option error


def get_libtmux_version() -> LooseVersion:
    """Return libtmux version is a PEP386 compliant format.

    Returns
    -------
    distutils.version.LooseVersion
        libtmux version
    """
    from libtmux.__about__ import __version__

    return LooseVersion(__version__)
libtmux-0.45.0/src/libtmux/constants.py000066400000000000000000000023461475667375600201640ustar00rootroot00000000000000"""Constant variables for libtmux."""

from __future__ import annotations

import enum


class ResizeAdjustmentDirection(enum.Enum):
    """Used for *adjustment* in ``resize_window``, ``resize_pane``."""

    Up = "UP"
    Down = "DOWN"
    Left = "LEFT"
    Right = "RIGHT"


RESIZE_ADJUSTMENT_DIRECTION_FLAG_MAP: dict[ResizeAdjustmentDirection, str] = {
    ResizeAdjustmentDirection.Up: "-U",
    ResizeAdjustmentDirection.Down: "-D",
    ResizeAdjustmentDirection.Left: "-L",
    ResizeAdjustmentDirection.Right: "-R",
}


class WindowDirection(enum.Enum):
    """Used for *adjustment* in :meth:`Session.new_window()`."""

    Before = "BEFORE"
    After = "AFTER"


WINDOW_DIRECTION_FLAG_MAP: dict[WindowDirection, str] = {
    WindowDirection.Before: "-b",
    WindowDirection.After: "-a",
}


class PaneDirection(enum.Enum):
    """Used for *adjustment* in :meth:`Pane.split()`."""

    Above = "ABOVE"
    Below = "BELOW"  # default with no args
    Right = "RIGHT"
    Left = "LEFT"


PANE_DIRECTION_FLAG_MAP: dict[PaneDirection, list[str]] = {
    # -v is assumed, but for explicitness it is passed
    PaneDirection.Above: ["-v", "-b"],
    PaneDirection.Below: ["-v"],
    PaneDirection.Right: ["-h"],
    PaneDirection.Left: ["-h", "-b"],
}
libtmux-0.45.0/src/libtmux/exc.py000066400000000000000000000107061475667375600167260ustar00rootroot00000000000000"""libtmux exceptions.

libtmux.exc
~~~~~~~~~~~

"""

from __future__ import annotations

import typing as t

from libtmux._internal.query_list import ObjectDoesNotExist

if t.TYPE_CHECKING:
    from libtmux.neo import ListExtraArgs


class LibTmuxException(Exception):
    """Base Exception for libtmux Errors."""


class TmuxSessionExists(LibTmuxException):
    """Session does not exist in the server."""


class TmuxCommandNotFound(LibTmuxException):
    """Application binary for tmux not found."""


class TmuxObjectDoesNotExist(ObjectDoesNotExist):
    """The query returned multiple objects when only one was expected."""

    def __init__(
        self,
        obj_key: str | None = None,
        obj_id: str | None = None,
        list_cmd: str | None = None,
        list_extra_args: ListExtraArgs | None = None,
        *args: object,
    ) -> None:
        if all(arg is not None for arg in [obj_key, obj_id, list_cmd, list_extra_args]):
            return super().__init__(
                f"Could not find {obj_key}={obj_id} for {list_cmd} "
                f"{list_extra_args if list_extra_args is not None else ''}",
            )
        return super().__init__("Could not find object")


class VersionTooLow(LibTmuxException):
    """Raised if tmux below the minimum version to use libtmux."""


class BadSessionName(LibTmuxException):
    """Disallowed session name for tmux (empty, contains periods or colons)."""

    def __init__(
        self,
        reason: str,
        session_name: str | None = None,
        *args: object,
    ) -> None:
        msg = f"Bad session name: {reason}"
        if session_name is not None:
            msg += f" (session name: {session_name})"
        return super().__init__(msg)


class OptionError(LibTmuxException):
    """Root error for any error involving invalid, ambiguous or bad options."""


class UnknownOption(OptionError):
    """Option unknown to tmux show-option(s) or show-window-option(s)."""


class UnknownColorOption(UnknownOption):
    """Unknown color option."""

    def __init__(self, *args: object) -> None:
        return super().__init__("Server.colors must equal 88 or 256")


class InvalidOption(OptionError):
    """Option invalid to tmux, introduced in tmux v2.4."""


class AmbiguousOption(OptionError):
    """Option that could potentially match more than one."""


class WaitTimeout(LibTmuxException):
    """Function timed out without meeting condition."""


class VariableUnpackingError(LibTmuxException):
    """Error unpacking variable."""

    def __init__(self, variable: t.Any | None = None, *args: object) -> None:
        return super().__init__(f"Unexpected variable: {variable!s}")


class PaneError(LibTmuxException):
    """Any type of pane related error."""


class PaneNotFound(PaneError):
    """Pane not found."""

    def __init__(self, pane_id: str | None = None, *args: object) -> None:
        if pane_id is not None:
            return super().__init__(f"Pane not found: {pane_id}")
        return super().__init__("Pane not found")


class WindowError(LibTmuxException):
    """Any type of window related error."""


class MultipleActiveWindows(WindowError):
    """Multiple active windows."""

    def __init__(self, count: int, *args: object) -> None:
        return super().__init__(f"Multiple active windows: {count} found")


class NoActiveWindow(WindowError):
    """No active window found."""

    def __init__(self, *args: object) -> None:
        return super().__init__("No active windows found")


class NoWindowsExist(WindowError):
    """No windows exist for object."""

    def __init__(self, *args: object) -> None:
        return super().__init__("No windows exist for object")


class AdjustmentDirectionRequiresAdjustment(LibTmuxException, ValueError):
    """If *adjustment_direction* is set, *adjustment* must be set."""

    def __init__(self) -> None:
        super().__init__("adjustment_direction requires adjustment")


class WindowAdjustmentDirectionRequiresAdjustment(
    WindowError,
    AdjustmentDirectionRequiresAdjustment,
):
    """ValueError for :meth:`libtmux.Window.resize_window`."""


class PaneAdjustmentDirectionRequiresAdjustment(
    WindowError,
    AdjustmentDirectionRequiresAdjustment,
):
    """ValueError for :meth:`libtmux.Pane.resize_pane`."""


class RequiresDigitOrPercentage(LibTmuxException, ValueError):
    """Requires digit (int or str digit) or a percentage."""

    def __init__(self) -> None:
        super().__init__("Requires digit (int or str digit) or a percentage.")
libtmux-0.45.0/src/libtmux/formats.py000066400000000000000000000037671475667375600176330ustar00rootroot00000000000000"""Format variables for tmux objects.

libtmux.formats
~~~~~~~~~~~~~~~

For reference: https://github.com/tmux/tmux/blob/master/format.c

"""

from __future__ import annotations

import os

FORMAT_SEPARATOR = os.environ.get("LIBTMUX_TMUX_FORMAT_SEPARATOR", "␞")

SESSION_FORMATS = [
    "session_name",
    "session_windows",
    "session_width",
    "session_height",
    "session_id",
    "session_created",
    "session_created_string",
    "session_attached",
    # "session_grouped",  Apparently unused, mistake found while adding dataclasses
    "session_group",
]

CLIENT_FORMATS = [
    "client_cwd",
    "client_height",
    "client_width",
    "client_tty",
    "client_termname",
    "client_created",
    "client_created_string",
    "client_activity",
    "client_activity_string",
    "client_prefix",
    "client_utf8",
    "client_readonly",
    "client_session",
    "client_last_session",
]

WINDOW_FORMATS = [
    # format_window()
    "window_id",
    "window_name",
    "window_width",
    "window_height",
    "window_layout",
    "window_panes",
    # format_winlink()
    "window_index",
    "window_flags",
    "window_active",
    "window_bell_flag",
    "window_activity_flag",
    "window_silence_flag",
]

PANE_FORMATS = [
    "history_size",
    "history_limit",
    "history_bytes",
    "pane_index",
    "pane_width",
    "pane_height",
    # "pane_title",  # removed in 3.1+
    "pane_id",
    "pane_active",
    "pane_dead",
    "pane_in_mode",
    "pane_synchronized",
    "pane_tty",
    "pane_pid",
    "pane_start_command",
    "pane_start_path",
    "pane_current_path",
    "pane_current_command",
    "cursor_x",
    "cursor_y",
    "scroll_region_upper",
    "scroll_region_lower",
    "saved_cursor_x",
    "saved_cursor_y",
    "alternate_on",
    "alternate_saved_x",
    "alternate_saved_y",
    "cursor_flag",
    "insert_flag",
    "keypad_cursor_flag",
    "keypad_flag",
    "wrap_flag",
    "mouse_standard_flag",
    "mouse_button_flag",
    "mouse_any_flag",
    "mouse_utf8_flag",
]
libtmux-0.45.0/src/libtmux/neo.py000066400000000000000000000176501475667375600167350ustar00rootroot00000000000000"""Tools for hydrating tmux data into python dataclass objects."""

from __future__ import annotations

import dataclasses
import logging
import typing as t
from collections.abc import Iterable

from libtmux import exc
from libtmux.common import tmux_cmd
from libtmux.formats import FORMAT_SEPARATOR

if t.TYPE_CHECKING:
    ListCmd = t.Literal["list-sessions", "list-windows", "list-panes"]
    ListExtraArgs = t.Optional[Iterable[str]]

    from libtmux.server import Server

logger = logging.getLogger(__name__)


OutputRaw = dict[str, t.Any]
OutputsRaw = list[OutputRaw]


"""
Quirks:

QUIRK_TMUX_3_1_X_0001:

- tmux 3.1 and 3.1a:
- server crash with list-panes w/ buffer_created, client_activity, client_created
"""


@dataclasses.dataclass()
class Obj:
    """Dataclass of generic tmux object."""

    server: Server

    active_window_index: str | None = None
    alternate_saved_x: str | None = None
    alternate_saved_y: str | None = None
    # See QUIRK_TMUX_3_1_X_0001
    buffer_name: str | None = None
    buffer_sample: str | None = None
    buffer_size: str | None = None
    # See QUIRK_TMUX_3_1_X_0001
    client_cell_height: str | None = None
    client_cell_width: str | None = None
    # See QUIRK_TMUX_3_1_X_0001
    client_discarded: str | None = None
    client_flags: str | None = None
    client_height: str | None = None
    client_key_table: str | None = None
    client_name: str | None = None
    client_pid: str | None = None
    client_termname: str | None = None
    client_tty: str | None = None
    client_uid: str | None = None
    client_user: str | None = None
    client_width: str | None = None
    client_written: str | None = None
    command_list_alias: str | None = None
    command_list_name: str | None = None
    command_list_usage: str | None = None
    config_files: str | None = None
    copy_cursor_line: str | None = None
    copy_cursor_word: str | None = None
    copy_cursor_x: str | None = None
    copy_cursor_y: str | None = None
    current_file: str | None = None
    cursor_character: str | None = None
    cursor_flag: str | None = None
    cursor_x: str | None = None
    cursor_y: str | None = None
    history_bytes: str | None = None
    history_limit: str | None = None
    history_size: str | None = None
    insert_flag: str | None = None
    keypad_cursor_flag: str | None = None
    keypad_flag: str | None = None
    last_window_index: str | None = None
    line: str | None = None
    mouse_all_flag: str | None = None
    mouse_any_flag: str | None = None
    mouse_button_flag: str | None = None
    mouse_sgr_flag: str | None = None
    mouse_standard_flag: str | None = None
    next_session_id: str | None = None
    origin_flag: str | None = None
    pane_active: str | None = None  # Not detected by script
    pane_at_bottom: str | None = None
    pane_at_left: str | None = None
    pane_at_right: str | None = None
    pane_at_top: str | None = None
    pane_bg: str | None = None
    pane_bottom: str | None = None
    pane_current_command: str | None = None
    pane_current_path: str | None = None
    pane_dead_signal: str | None = None
    pane_dead_status: str | None = None
    pane_dead_time: str | None = None
    pane_fg: str | None = None
    pane_height: str | None = None
    pane_id: str | None = None
    pane_index: str | None = None
    pane_left: str | None = None
    pane_pid: str | None = None
    pane_right: str | None = None
    pane_search_string: str | None = None
    pane_start_command: str | None = None
    pane_start_path: str | None = None
    pane_tabs: str | None = None
    pane_top: str | None = None
    pane_tty: str | None = None
    pane_width: str | None = None
    pid: str | None = None
    scroll_position: str | None = None
    scroll_region_lower: str | None = None
    scroll_region_upper: str | None = None
    search_match: str | None = None
    selection_end_x: str | None = None
    selection_end_y: str | None = None
    selection_start_x: str | None = None
    selection_start_y: str | None = None
    session_activity: str | None = None
    session_alerts: str | None = None
    session_attached: str | None = None
    session_attached_list: str | None = None
    session_created: str | None = None
    session_group: str | None = None
    session_group_attached: str | None = None
    session_group_list: str | None = None
    session_group_size: str | None = None
    session_id: str | None = None
    session_last_attached: str | None = None
    session_name: str | None = None
    session_path: str | None = None
    session_stack: str | None = None
    session_windows: str | None = None
    socket_path: str | None = None
    start_time: str | None = None
    uid: str | None = None
    user: str | None = None
    version: str | None = None
    window_active: str | None = None  # Not detected by script
    window_active_clients: str | None = None
    window_active_sessions: str | None = None
    window_activity: str | None = None
    window_cell_height: str | None = None
    window_cell_width: str | None = None
    window_height: str | None = None
    window_id: str | None = None
    window_index: str | None = None
    window_layout: str | None = None
    window_linked: str | None = None
    window_linked_sessions: str | None = None
    window_linked_sessions_list: str | None = None
    window_marked_flag: str | None = None
    window_name: str | None = None
    window_offset_x: str | None = None
    window_offset_y: str | None = None
    window_panes: str | None = None
    window_raw_flags: str | None = None
    window_stack_index: str | None = None
    window_width: str | None = None
    wrap_flag: str | None = None

    def _refresh(
        self,
        obj_key: str,
        obj_id: str,
        list_cmd: ListCmd = "list-panes",
        list_extra_args: ListExtraArgs | None = None,
    ) -> None:
        assert isinstance(obj_id, str)
        obj = fetch_obj(
            obj_key=obj_key,
            obj_id=obj_id,
            list_cmd=list_cmd,
            list_extra_args=list_extra_args,
            server=self.server,
        )
        assert obj is not None
        if obj is not None:
            for k, v in obj.items():
                setattr(self, k, v)


def fetch_objs(
    server: Server,
    list_cmd: ListCmd,
    list_extra_args: ListExtraArgs | None = None,
) -> OutputsRaw:
    """Fetch a listing of raw data from a tmux command."""
    formats = list(Obj.__dataclass_fields__.keys())

    cmd_args: list[str | int] = []

    if server.socket_name:
        cmd_args.insert(0, f"-L{server.socket_name}")
    if server.socket_path:
        cmd_args.insert(0, f"-S{server.socket_path}")
    tmux_formats = [f"#{{{f}}}{FORMAT_SEPARATOR}" for f in formats]

    tmux_cmds = [
        *cmd_args,
        list_cmd,
    ]

    if list_extra_args is not None and isinstance(list_extra_args, Iterable):
        tmux_cmds.extend(list(list_extra_args))

    tmux_cmds.append("-F{}".format("".join(tmux_formats)))

    proc = tmux_cmd(*tmux_cmds)  # output

    if proc.stderr:
        raise exc.LibTmuxException(proc.stderr)

    obj_output = proc.stdout

    obj_formatters = [
        dict(zip(formats, formatter.split(FORMAT_SEPARATOR)))
        for formatter in obj_output
    ]

    # Filter empty values
    return [{k: v for k, v in formatter.items() if v} for formatter in obj_formatters]


def fetch_obj(
    server: Server,
    obj_key: str,
    obj_id: str,
    list_cmd: ListCmd = "list-panes",
    list_extra_args: ListExtraArgs | None = None,
) -> OutputRaw:
    """Fetch raw data from tmux command."""
    obj_formatters_filtered = fetch_objs(
        server=server,
        list_cmd=list_cmd,
        list_extra_args=list_extra_args,
    )

    obj = None
    for _obj in obj_formatters_filtered:
        if _obj.get(obj_key) == obj_id:
            obj = _obj

    if obj is None:
        raise exc.TmuxObjectDoesNotExist(
            obj_key=obj_key,
            obj_id=obj_id,
            list_cmd=list_cmd,
            list_extra_args=list_extra_args,
        )

    assert obj is not None

    return obj
libtmux-0.45.0/src/libtmux/pane.py000066400000000000000000000645211475667375600170760ustar00rootroot00000000000000"""Pythonization of the :ref:`tmux(1)` pane.

libtmux.pane
~~~~~~~~~~~~

"""

from __future__ import annotations

import dataclasses
import logging
import pathlib
import typing as t
import warnings

from libtmux.common import has_gte_version, has_lt_version, tmux_cmd
from libtmux.constants import (
    PANE_DIRECTION_FLAG_MAP,
    RESIZE_ADJUSTMENT_DIRECTION_FLAG_MAP,
    PaneDirection,
    ResizeAdjustmentDirection,
)
from libtmux.formats import FORMAT_SEPARATOR
from libtmux.neo import Obj, fetch_obj

from . import exc

if t.TYPE_CHECKING:
    import sys
    import types

    from .server import Server
    from .session import Session
    from .window import Window

    if sys.version_info >= (3, 11):
        from typing import Self
    else:
        from typing_extensions import Self

logger = logging.getLogger(__name__)


@dataclasses.dataclass()
class Pane(Obj):
    """:term:`tmux(1)` :term:`Pane` [pane_manual]_.

    ``Pane`` instances can send commands directly to a pane, or traverse
    between linked tmux objects.

    Attributes
    ----------
    window : :class:`Window`

    Examples
    --------
    >>> pane
    Pane(%1 Window(@1 1:..., Session($1 ...)))

    >>> pane in window.panes
    True

    >>> pane.window
    Window(@1 1:..., Session($1 ...))

    >>> pane.session
    Session($1 ...)

    The pane can be used as a context manager to ensure proper cleanup:

    >>> with window.split() as pane:
    ...     pane.send_keys('echo "Hello"')
    ...     # Do work with the pane
    ...     # Pane will be killed automatically when exiting the context

    Notes
    -----
    .. versionchanged:: 0.8
        Renamed from ``.tmux`` to ``.cmd``.

    References
    ----------
    .. [pane_manual] tmux pane. openbsd manpage for TMUX(1).
           "Each window displayed by tmux may be split into one or more
           panes; each pane takes up a certain area of the display and is
           a separate terminal."

       https://man.openbsd.org/tmux.1#WINDOWS_AND_PANES.
       Accessed April 1st, 2018.
    """

    server: Server

    def __enter__(self) -> Self:
        """Enter the context, returning self.

        Returns
        -------
        :class:`Pane`
            The pane instance
        """
        return self

    def __exit__(
        self,
        exc_type: type[BaseException] | None,
        exc_value: BaseException | None,
        exc_tb: types.TracebackType | None,
    ) -> None:
        """Exit the context, killing the pane if it exists.

        Parameters
        ----------
        exc_type : type[BaseException] | None
            The type of the exception that was raised
        exc_value : BaseException | None
            The instance of the exception that was raised
        exc_tb : types.TracebackType | None
            The traceback of the exception that was raised
        """
        if (
            self.pane_id is not None
            and len(self.window.panes.filter(pane_id=self.pane_id)) > 0
        ):
            self.kill()

    def refresh(self) -> None:
        """Refresh pane attributes from tmux."""
        assert isinstance(self.pane_id, str)
        return super()._refresh(
            obj_key="pane_id",
            obj_id=self.pane_id,
            list_extra_args=("-a",),
        )

    @classmethod
    def from_pane_id(cls, server: Server, pane_id: str) -> Pane:
        """Create Pane from existing pane_id."""
        pane = fetch_obj(
            obj_key="pane_id",
            obj_id=pane_id,
            server=server,
            list_cmd="list-panes",
            list_extra_args=("-a",),
        )
        return cls(server=server, **pane)

    #
    # Relations
    #
    @property
    def window(self) -> Window:
        """Parent window of pane."""
        assert isinstance(self.window_id, str)
        from libtmux.window import Window

        return Window.from_window_id(server=self.server, window_id=self.window_id)

    @property
    def session(self) -> Session:
        """Parent session of pane."""
        return self.window.session

    """
    Commands (pane-scoped)
    """

    def cmd(
        self,
        cmd: str,
        *args: t.Any,
        target: str | int | None = None,
    ) -> tmux_cmd:
        """Execute tmux subcommand within pane context.

        Automatically binds target by adding  ``-t`` for object's pane ID to the
        command. Pass ``target`` to keyword arguments to override.

        Examples
        --------
        >>> pane.cmd('split-window', '-P').stdout[0]
        'libtmux...:...'

        From raw output to an enriched `Pane` object:

        >>> Pane.from_pane_id(pane_id=pane.cmd(
        ... 'split-window', '-P', '-F#{pane_id}').stdout[0], server=pane.server)
        Pane(%... Window(@... ...:..., Session($1 libtmux_...)))

        Parameters
        ----------
        target : str, optional
            Optional custom target override. By default, the target is the pane ID.

        Returns
        -------
        :meth:`server.cmd`
        """
        if target is None:
            target = self.pane_id

        return self.server.cmd(cmd, *args, target=target)

    """
    Commands (tmux-like)
    """

    def resize(
        self,
        /,
        # Adjustments
        adjustment_direction: ResizeAdjustmentDirection | None = None,
        adjustment: int | None = None,
        # Manual
        height: str | int | None = None,
        width: str | int | None = None,
        # Zoom
        zoom: bool | None = None,
        # Mouse
        mouse: bool | None = None,
        # Optional flags
        trim_below: bool | None = None,
    ) -> Pane:
        """Resize tmux pane.

        Parameters
        ----------
        adjustment_direction : ResizeAdjustmentDirection, optional
            direction to adjust, ``Up``, ``Down``, ``Left``, ``Right``.
        adjustment : ResizeAdjustmentDirection, optional

        height : int, optional
            ``resize-pane -y`` dimensions
        width : int, optional
            ``resize-pane -x`` dimensions

        zoom : bool
            expand pane

        mouse : bool
            resize via mouse

        trim_below : bool
            trim below cursor

        Raises
        ------
        :exc:`exc.LibTmuxException`,
        :exc:`exc.PaneAdjustmentDirectionRequiresAdjustment`,
        :exc:`exc.RequiresDigitOrPercentage`

        Returns
        -------
        :class:`Pane`

        Notes
        -----
        Three types of resizing are available:

        1. Adjustments: ``adjustment_direction`` and ``adjustment``.
        2. Manual resizing: ``height`` and / or ``width``.
        3. Zoom / Unzoom: ``zoom``.
        """
        tmux_args: tuple[str, ...] = ()

        # Adjustments
        if adjustment_direction:
            if adjustment is None:
                raise exc.PaneAdjustmentDirectionRequiresAdjustment
            tmux_args += (
                f"{RESIZE_ADJUSTMENT_DIRECTION_FLAG_MAP[adjustment_direction]}",
                str(adjustment),
            )
        elif height or width:
            # Manual resizing
            if height:
                if isinstance(height, str):
                    if height.endswith("%") and not has_gte_version("3.1"):
                        raise exc.VersionTooLow
                    if not height.isdigit() and not height.endswith("%"):
                        raise exc.RequiresDigitOrPercentage
                tmux_args += (f"-y{height}",)

            if width:
                if isinstance(width, str):
                    if width.endswith("%") and not has_gte_version("3.1"):
                        raise exc.VersionTooLow
                    if not width.isdigit() and not width.endswith("%"):
                        raise exc.RequiresDigitOrPercentage

                tmux_args += (f"-x{width}",)
        elif zoom:
            # Zoom / Unzoom
            tmux_args += ("-Z",)
        elif mouse:
            tmux_args += ("-M",)

        if trim_below:
            tmux_args += ("-T",)

        proc = self.cmd("resize-pane", *tmux_args)

        if proc.stderr:
            raise exc.LibTmuxException(proc.stderr)

        self.refresh()
        return self

    def capture_pane(
        self,
        start: t.Literal["-"] | int | None = None,
        end: t.Literal["-"] | int | None = None,
    ) -> str | list[str]:
        """Capture text from pane.

        ``$ tmux capture-pane`` to pane.
        ``$ tmux capture-pane -S -10`` to pane.
        ``$ tmux capture-pane`-E 3` to pane.
        ``$ tmux capture-pane`-S - -E -` to pane.

        Parameters
        ----------
        start: [str,int]
            Specify the starting line number.
            Zero is the first line of the visible pane.
            Positive numbers are lines in the visible pane.
            Negative numbers are lines in the history.
            `-` is the start of the history.
            Default: None
        end: [str,int]
            Specify the ending line number.
            Zero is the first line of the visible pane.
            Positive numbers are lines in the visible pane.
            Negative numbers are lines in the history.
            `-` is the end of the visible pane
            Default: None
        """
        cmd = ["capture-pane", "-p"]
        if start is not None:
            cmd.extend(["-S", str(start)])
        if end is not None:
            cmd.extend(["-E", str(end)])
        return self.cmd(*cmd).stdout

    def send_keys(
        self,
        cmd: str,
        enter: bool | None = True,
        suppress_history: bool | None = False,
        literal: bool | None = False,
    ) -> None:
        r"""``$ tmux send-keys`` to the pane.

        A leading space character is added to cmd to avoid polluting the
        user's history.

        Parameters
        ----------
        cmd : str
            Text or input into pane
        enter : bool, optional
            Send enter after sending the input, default True.
        suppress_history : bool, optional
            Prepend a space to command to suppress shell history, default False.

            .. versionchanged:: 0.14

               Default changed from True to False.
        literal : bool, optional
            Send keys literally, default True.

        Examples
        --------
        >>> pane = window.split(shell='sh')
        >>> pane.capture_pane()
        ['$']

        >>> pane.send_keys('echo "Hello world"', enter=True)

        >>> pane.capture_pane()
        ['$ echo "Hello world"', 'Hello world', '$']

        >>> print('\n'.join(pane.capture_pane()))  # doctest: +NORMALIZE_WHITESPACE
        $ echo "Hello world"
        Hello world
        $
        """
        prefix = " " if suppress_history else ""

        if literal:
            self.cmd("send-keys", "-l", prefix + cmd)
        else:
            self.cmd("send-keys", prefix + cmd)

        if enter:
            self.enter()

    @t.overload
    def display_message(
        self,
        cmd: str,
        get_text: t.Literal[True],
    ) -> str | list[str]: ...

    @t.overload
    def display_message(self, cmd: str, get_text: t.Literal[False]) -> None: ...

    def display_message(
        self,
        cmd: str,
        get_text: bool = False,
    ) -> str | list[str] | None:
        """Display message to pane.

        Displays a message in target-client status line.

        Parameters
        ----------
        cmd : str
            Special parameters to request from pane.
        get_text : bool, optional
            Returns only text without displaying a message in
            target-client status line.
        """
        if get_text:
            return self.cmd("display-message", "-p", cmd).stdout

        self.cmd("display-message", cmd)
        return None

    def kill(
        self,
        all_except: bool | None = None,
    ) -> None:
        """Kill :class:`Pane`.

        ``$ tmux kill-pane``.

        Examples
        --------
        Kill a pane:

        >>> pane_1 = pane.split()

        >>> pane_1 in window.panes
        True

        >>> pane_1.kill()

        >>> pane_1 not in window.panes
        True

        Kill all panes except the current one:

        >>> pane.window.resize(height=100, width=100)
        Window(@1 1...)

        >>> one_pane_to_rule_them_all = pane.split()

        >>> other_panes = pane.split(
        ...     ), pane.split()

        >>> all([p in window.panes for p in other_panes])
        True

        >>> one_pane_to_rule_them_all.kill(all_except=True)

        >>> all([p not in window.panes for p in other_panes])
        True

        >>> one_pane_to_rule_them_all in window.panes
        True
        """
        flags: tuple[str, ...] = ()

        if all_except:
            flags += ("-a",)

        proc = self.cmd(
            "kill-pane",
            *flags,
        )

        if proc.stderr:
            raise exc.LibTmuxException(proc.stderr)

    """
    Commands ("climber"-helpers)

    These are commands that climb to the parent scope's methods with
    additional scoped window info.
    """

    def select(self) -> Pane:
        """Select pane.

        Examples
        --------
        >>> pane = window.active_pane
        >>> new_pane = window.split()
        >>> pane.refresh()
        >>> active_panes = [p for p in window.panes if p.pane_active == '1']

        >>> pane in active_panes
        True
        >>> new_pane in active_panes
        False

        >>> new_pane.pane_active == '1'
        False

        >>> new_pane.select()
        Pane(...)

        >>> new_pane.pane_active == '1'
        True
        """
        proc = self.cmd("select-pane")

        if proc.stderr:
            raise exc.LibTmuxException(proc.stderr)

        self.refresh()

        return self

    def select_pane(self) -> Pane:
        """Select pane.

        Notes
        -----
        .. deprecated:: 0.30

           Deprecated in favor of :meth:`.select()`.
        """
        warnings.warn(
            "Pane.select_pane() is deprecated in favor of Pane.select()",
            category=DeprecationWarning,
            stacklevel=2,
        )
        assert isinstance(self.pane_id, str)
        pane = self.window.select_pane(self.pane_id)
        if pane is None:
            raise exc.PaneNotFound(pane_id=self.pane_id)
        return pane

    def split(
        self,
        /,
        target: int | str | None = None,
        start_directory: str | None = None,
        attach: bool = False,
        direction: PaneDirection | None = None,
        full_window_split: bool | None = None,
        zoom: bool | None = None,
        shell: str | None = None,
        size: str | int | None = None,
        environment: dict[str, str] | None = None,
    ) -> Pane:
        """Split window and return :class:`Pane`, by default beneath current pane.

        Parameters
        ----------
        target : optional
            Optional, custom *target-pane*, used by :meth:`Window.split`.
        attach : bool, optional
            make new window the current window after creating it, default
            True.
        start_directory : str, optional
            specifies the working directory in which the new window is created.
        direction : PaneDirection, optional
            split in direction. If none is specified, assume down.
        full_window_split: bool, optional
            split across full window width or height, rather than active pane.
        zoom: bool, optional
            expand pane
        shell : str, optional
            execute a command on splitting the window.  The pane will close
            when the command exits.

            NOTE: When this command exits the pane will close.  This feature
            is useful for long-running processes where the closing of the
            window upon completion is desired.
        size: int, optional
            Cell/row or percentage to occupy with respect to current window.
        environment: dict, optional
            Environmental variables for new pane. tmux 3.0+ only. Passthrough to ``-e``.

        Examples
        --------
        >>> (pane.at_left, pane.at_right,
        ...  pane.at_top, pane.at_bottom)
        (True, True,
        True, True)

        >>> new_pane = pane.split()

        >>> (new_pane.at_left, new_pane.at_right,
        ...  new_pane.at_top, new_pane.at_bottom)
        (True, True,
        False, True)

        >>> right_pane = pane.split(direction=PaneDirection.Right)

        >>> (right_pane.at_left, right_pane.at_right,
        ...  right_pane.at_top, right_pane.at_bottom)
        (False, True,
        True, False)

        >>> left_pane = pane.split(direction=PaneDirection.Left)

        >>> (left_pane.at_left, left_pane.at_right,
        ...  left_pane.at_top, left_pane.at_bottom)
        (True, False,
        True, False)

        >>> top_pane = pane.split(direction=PaneDirection.Above)

        >>> (top_pane.at_left, top_pane.at_right,
        ...  top_pane.at_top, top_pane.at_bottom)
        (False, False,
        True, False)

        >>> pane = session.new_window().active_pane

        >>> top_pane = pane.split(direction=PaneDirection.Above, full_window_split=True)

        >>> (top_pane.at_left, top_pane.at_right,
        ...  top_pane.at_top, top_pane.at_bottom)
        (True, True,
        True, False)

        >>> bottom_pane = pane.split(
        ... direction=PaneDirection.Below,
        ... full_window_split=True)

        >>> (bottom_pane.at_left, bottom_pane.at_right,
        ...  bottom_pane.at_top, bottom_pane.at_bottom)
        (True, True,
        False, True)
        """
        tmux_formats = ["#{pane_id}" + FORMAT_SEPARATOR]

        tmux_args: tuple[str, ...] = ()

        if direction:
            tmux_args += tuple(PANE_DIRECTION_FLAG_MAP[direction])
        else:
            tmux_args += tuple(PANE_DIRECTION_FLAG_MAP[PaneDirection.Below])

        if size is not None:
            if has_lt_version("3.1"):
                if isinstance(size, str) and size.endswith("%"):
                    tmux_args += (f"-p{str(size).rstrip('%')}",)
                else:
                    warnings.warn(
                        'Ignored size. Use percent in tmux < 3.1, e.g. "size=50%"',
                        stacklevel=2,
                    )
            else:
                tmux_args += (f"-l{size}",)

        if full_window_split:
            tmux_args += ("-f",)

        if zoom:
            tmux_args += ("-Z",)

        tmux_args += ("-P", "-F{}".format("".join(tmux_formats)))  # output

        if start_directory is not None:
            # as of 2014-02-08 tmux 1.9-dev doesn't expand ~ in new-window -c.
            start_path = pathlib.Path(start_directory).expanduser()
            tmux_args += (f"-c{start_path}",)

        if not attach:
            tmux_args += ("-d",)

        if environment:
            if has_gte_version("3.0"):
                for k, v in environment.items():
                    tmux_args += (f"-e{k}={v}",)
            else:
                logger.warning(
                    "Environment flag ignored, tmux 3.0 or newer required.",
                )

        if shell:
            tmux_args += (shell,)

        pane_cmd = self.cmd("split-window", *tmux_args, target=target)

        # tmux < 1.7. This is added in 1.7.
        if pane_cmd.stderr:
            if "pane too small" in pane_cmd.stderr:
                raise exc.LibTmuxException(pane_cmd.stderr)

            raise exc.LibTmuxException(
                pane_cmd.stderr,
                self.__dict__,
                self.window.panes,
            )

        pane_output = pane_cmd.stdout[0]

        pane_formatters = dict(zip(["pane_id"], pane_output.split(FORMAT_SEPARATOR)))

        return self.from_pane_id(server=self.server, pane_id=pane_formatters["pane_id"])

    """
    Commands (helpers)
    """

    def set_width(self, width: int) -> Pane:
        """Set pane width.

        Parameters
        ----------
        width : int
            pane width, in cells
        """
        self.resize_pane(width=width)
        return self

    def set_height(self, height: int) -> Pane:
        """Set pane height.

        Parameters
        ----------
        height : int
            height of pain, in cells
        """
        self.resize_pane(height=height)
        return self

    def enter(self) -> Pane:
        """Send carriage return to pane.

        ``$ tmux send-keys`` send Enter to the pane.
        """
        self.cmd("send-keys", "Enter")
        return self

    def clear(self) -> Pane:
        """Clear pane."""
        self.send_keys("reset")
        return self

    def reset(self) -> Pane:
        """Reset and clear pane history."""
        self.cmd("send-keys", r"-R \; clear-history")
        return self

    #
    # Dunder
    #
    def __eq__(self, other: object) -> bool:
        """Equal operator for :class:`Pane` object."""
        if isinstance(other, Pane):
            return self.pane_id == other.pane_id
        return False

    def __repr__(self) -> str:
        """Representation of :class:`Pane` object."""
        return f"{self.__class__.__name__}({self.pane_id} {self.window})"

    #
    # Aliases
    #
    @property
    def id(self) -> str | None:
        """Alias of :attr:`Pane.pane_id`.

        >>> pane.id
        '%1'

        >>> pane.id == pane.pane_id
        True
        """
        return self.pane_id

    @property
    def index(self) -> str | None:
        """Alias of :attr:`Pane.pane_index`.

        >>> pane.index
        '0'

        >>> pane.index == pane.pane_index
        True
        """
        return self.pane_index

    @property
    def height(self) -> str | None:
        """Alias of :attr:`Pane.pane_height`.

        >>> pane.height.isdigit()
        True

        >>> pane.height == pane.pane_height
        True
        """
        return self.pane_height

    @property
    def width(self) -> str | None:
        """Alias of :attr:`Pane.pane_width`.

        >>> pane.width.isdigit()
        True

        >>> pane.width == pane.pane_width
        True
        """
        return self.pane_width

    @property
    def at_top(self) -> bool:
        """Typed, converted wrapper around :attr:`Pane.pane_at_top`.

        >>> pane.pane_at_top
        '1'

        >>> pane.at_top
        True
        """
        return self.pane_at_top == "1"

    @property
    def at_bottom(self) -> bool:
        """Typed, converted wrapper around :attr:`Pane.pane_at_bottom`.

        >>> pane.pane_at_bottom
        '1'

        >>> pane.at_bottom
        True
        """
        return self.pane_at_bottom == "1"

    @property
    def at_left(self) -> bool:
        """Typed, converted wrapper around :attr:`Pane.pane_at_left`.

        >>> pane.pane_at_left
        '1'

        >>> pane.at_left
        True
        """
        return self.pane_at_left == "1"

    @property
    def at_right(self) -> bool:
        """Typed, converted wrapper around :attr:`Pane.pane_at_right`.

        >>> pane.pane_at_right
        '1'

        >>> pane.at_right
        True
        """
        return self.pane_at_right == "1"

    #
    # Legacy: Redundant stuff we want to remove
    #
    def split_window(
        self,
        target: int | str | None = None,
        attach: bool = False,
        start_directory: str | None = None,
        vertical: bool = True,
        shell: str | None = None,
        size: str | int | None = None,
        percent: int | None = None,  # deprecated
        environment: dict[str, str] | None = None,
    ) -> Pane:  # New Pane, not self
        """Split window at pane and return newly created :class:`Pane`.

        Parameters
        ----------
        attach : bool, optional
            Attach / select pane after creation.
        start_directory : str, optional
            specifies the working directory in which the new pane is created.
        vertical : bool, optional
            split vertically
        percent: int, optional
            percentage to occupy with respect to current pane
        environment: dict, optional
            Environmental variables for new pane. tmux 3.0+ only. Passthrough to ``-e``.

        Notes
        -----
        .. deprecated:: 0.33

           Deprecated in favor of :meth:`.split`.
        """
        warnings.warn(
            "Pane.split_window() is deprecated in favor of Pane.split()",
            category=DeprecationWarning,
            stacklevel=2,
        )
        if size is None and percent is not None:
            size = f"{str(percent).rstrip('%')}%"
        return self.split(
            target=target,
            attach=attach,
            start_directory=start_directory,
            direction=PaneDirection.Below if vertical else PaneDirection.Right,
            shell=shell,
            size=size,
            environment=environment,
        )

    def get(self, key: str, default: t.Any | None = None) -> t.Any:
        """Return key-based lookup. Deprecated by attributes.

        .. deprecated:: 0.16

           Deprecated by attribute lookup, e.g. ``pane['window_name']`` is now
           accessed via ``pane.window_name``.

        """
        warnings.warn(
            "Pane.get() is deprecated",
            category=DeprecationWarning,
            stacklevel=2,
        )
        return getattr(self, key, default)

    def __getitem__(self, key: str) -> t.Any:
        """Return item lookup by key. Deprecated in favor of attributes.

        .. deprecated:: 0.16

           Deprecated in favor of attributes. e.g. ``pane['window_name']`` is now
           accessed via ``pane.window_name``.

        """
        warnings.warn(
            f"Item lookups, e.g. pane['{key}'] is deprecated",
            category=DeprecationWarning,
            stacklevel=2,
        )
        return getattr(self, key)

    def resize_pane(
        self,
        # Adjustments
        adjustment_direction: ResizeAdjustmentDirection | None = None,
        adjustment: int | None = None,
        # Manual
        height: str | int | None = None,
        width: str | int | None = None,
        # Zoom
        zoom: bool | None = None,
        # Mouse
        mouse: bool | None = None,
        # Optional flags
        trim_below: bool | None = None,
    ) -> Pane:
        """Resize pane, deprecated by :meth:`Pane.resize`.

        .. deprecated:: 0.28

           Deprecated by :meth:`Pane.resize`.
        """
        warnings.warn(
            "Deprecated: Use Pane.resize() instead of Pane.resize_pane()",
            category=DeprecationWarning,
            stacklevel=2,
        )
        return self.resize(
            adjustment_direction=adjustment_direction,
            adjustment=adjustment,
            height=height,
            width=width,
            zoom=zoom,
            mouse=mouse,
            trim_below=trim_below,
        )
libtmux-0.45.0/src/libtmux/py.typed000066400000000000000000000000001475667375600172560ustar00rootroot00000000000000libtmux-0.45.0/src/libtmux/pytest_plugin.py000066400000000000000000000206151475667375600210550ustar00rootroot00000000000000"""libtmux pytest plugin."""

from __future__ import annotations

import contextlib
import functools
import getpass
import logging
import os
import typing as t

import pytest

from libtmux import exc
from libtmux.server import Server
from libtmux.test.constants import TEST_SESSION_PREFIX
from libtmux.test.random import get_test_session_name, namer

if t.TYPE_CHECKING:
    import pathlib

    from libtmux.session import Session

logger = logging.getLogger(__name__)
USING_ZSH = "zsh" in os.getenv("SHELL", "")


@pytest.fixture(scope="session")
def home_path(tmp_path_factory: pytest.TempPathFactory) -> pathlib.Path:
    """Temporary `/home/` path."""
    return tmp_path_factory.mktemp("home")


@pytest.fixture(scope="session")
def home_user_name() -> str:
    """Return default username to set for :func:`user_path` fixture."""
    return getpass.getuser()


@pytest.fixture(scope="session")
def user_path(home_path: pathlib.Path, home_user_name: str) -> pathlib.Path:
    """Ensure and return temporary user directory.

    Used by: :func:`config_file`, :func:`zshrc`

    Note: You will need to set the home directory, see :ref:`set_home`.
    """
    p = home_path / home_user_name
    p.mkdir()
    return p


@pytest.mark.skipif(USING_ZSH, reason="Using ZSH")
@pytest.fixture(scope="session")
def zshrc(user_path: pathlib.Path) -> pathlib.Path:
    """Suppress ZSH default message.

    Needs a startup file .zshenv, .zprofile, .zshrc, .zlogin.
    """
    p = user_path / ".zshrc"
    p.touch()
    return p


@pytest.fixture(scope="session")
def config_file(user_path: pathlib.Path) -> pathlib.Path:
    """Return fixture for ``.tmux.conf`` configuration.

    - ``base-index -g 1``

    These guarantee pane and windows targets can be reliably referenced and asserted.

    Note: You will need to set the home directory, see :ref:`set_home`.
    """
    c = user_path / ".tmux.conf"
    c.write_text(
        """
set -g base-index 1
    """,
        encoding="utf-8",
    )
    return c


@pytest.fixture
def clear_env(monkeypatch: pytest.MonkeyPatch) -> None:
    """Clear out any unnecessary environment variables that could interrupt tests.

    tmux show-environment tests were being interrupted due to a lot of crazy env vars.
    """
    for k in os.environ:
        if not any(
            needle in k.lower()
            for needle in [
                "window",
                "tmux",
                "pane",
                "session",
                "pytest",
                "path",
                "pwd",
                "shell",
                "home",
                "xdg",
                "disable_auto_title",
                "lang",
                "term",
            ]
        ):
            monkeypatch.delenv(k)


@pytest.fixture
def server(
    request: pytest.FixtureRequest,
    monkeypatch: pytest.MonkeyPatch,
    config_file: pathlib.Path,
) -> Server:
    """Return new, temporary :class:`libtmux.Server`.

    >>> from libtmux.server import Server

    >>> def test_example(server: Server) -> None:
    ...     assert isinstance(server, Server)
    ...     session = server.new_session('my session')
    ...     assert len(server.sessions) == 1
    ...     assert [session.name.startswith('my') for session in server.sessions]

    .. ::
        >>> locals().keys()
        dict_keys(...)

        >>> source = ''.join([e.source for e in request._pyfuncitem.dtest.examples][:3])
        >>> pytester = request.getfixturevalue('pytester')

        >>> pytester.makepyfile(**{'whatever.py': source})
        PosixPath(...)

        >>> result = pytester.runpytest('whatever.py', '--disable-warnings')
        ===...

        >>> result.assert_outcomes(passed=1)
    """
    server = Server(socket_name=f"libtmux_test{next(namer)}")

    def fin() -> None:
        server.kill()

    request.addfinalizer(fin)

    return server


@pytest.fixture
def session_params() -> dict[str, t.Any]:
    """Return new, temporary :class:`libtmux.Session`.

    >>> import pytest
    >>> from libtmux.session import Session

    >>> @pytest.fixture
    ... def session_params(session_params):
    ...     return {
    ...         'x': 800,
    ...         'y': 600,
    ...     }

    >>> def test_example(session: "Session") -> None:
    ...     assert isinstance(session.name, str)
    ...     assert session.name.startswith('libtmux_')
    ...     window = session.new_window(window_name='new one')
    ...     assert window.name == 'new one'

    .. ::
        >>> locals().keys()
        dict_keys(...)

        >>> source = ''.join([e.source for e in request._pyfuncitem.dtest.examples][:4])
        >>> pytester = request.getfixturevalue('pytester')

        >>> pytester.makepyfile(**{'whatever.py': source})
        PosixPath(...)

        >>> result = pytester.runpytest('whatever.py', '--disable-warnings')
        ===...

        >>> result.assert_outcomes(passed=1)
    """
    return {}


@pytest.fixture
def session(
    request: pytest.FixtureRequest,
    session_params: dict[str, t.Any],
    server: Server,
) -> Session:
    """Return new, temporary :class:`libtmux.Session`.

    >>> from libtmux.session import Session

    >>> def test_example(session: "Session") -> None:
    ...     assert isinstance(session.name, str)
    ...     assert session.name.startswith('libtmux_')
    ...     window = session.new_window(window_name='new one')
    ...     assert window.name == 'new one'

    .. ::
        >>> locals().keys()
        dict_keys(...)

        >>> source = ''.join([e.source for e in request._pyfuncitem.dtest.examples][:3])
        >>> pytester = request.getfixturevalue('pytester')

        >>> pytester.makepyfile(**{'whatever.py': source})
        PosixPath(...)

        >>> result = pytester.runpytest('whatever.py', '--disable-warnings')
        ===...

        >>> result.assert_outcomes(passed=1)
    """
    session_name = "tmuxp"

    if not server.has_session(session_name):
        server.new_session(
            session_name=session_name,
        )

    # find current sessions prefixed with tmuxp
    old_test_sessions = []
    for s in server.sessions:
        old_name = s.session_name
        if old_name is not None and old_name.startswith(TEST_SESSION_PREFIX):
            old_test_sessions.append(old_name)

    TEST_SESSION_NAME = get_test_session_name(server=server)

    session = server.new_session(
        session_name=TEST_SESSION_NAME,
        **session_params,
    )

    """
    Make sure that tmuxp can :ref:`test_builder_visually` and switches to
    the newly created session for that testcase.
    """
    session_id = session.session_id
    assert session_id is not None

    with contextlib.suppress(exc.LibTmuxException):
        server.switch_client(target_session=session_id)

    for old_test_session in old_test_sessions:
        logger.debug(f"Old test test session {old_test_session} found. Killing it.")
        server.kill_session(old_test_session)
    assert session.session_name == TEST_SESSION_NAME
    assert TEST_SESSION_NAME != "tmuxp"

    return session


@pytest.fixture
def TestServer(
    request: pytest.FixtureRequest,
) -> type[Server]:
    """Create a temporary tmux server that cleans up after itself.

    This is similar to the server pytest fixture, but can be used outside of pytest.
    The server will be killed when the test completes.

    Returns
    -------
    type[Server]
        A factory function that returns a Server with a unique socket_name

    Examples
    --------
    >>> server = Server()  # Create server instance
    >>> server.new_session()
    Session($... ...)
    >>> server.is_alive()
    True
    >>> # Each call creates a new server with unique socket
    >>> server2 = Server()
    >>> server2.socket_name != server.socket_name
    True
    """
    created_sockets: list[str] = []

    def on_init(server: Server) -> None:
        """Track created servers for cleanup."""
        created_sockets.append(server.socket_name or "default")

    def socket_name_factory() -> str:
        """Generate unique socket names."""
        return f"libtmux_test{next(namer)}"

    def fin() -> None:
        """Kill all servers created with these sockets."""
        for socket_name in created_sockets:
            server = Server(socket_name=socket_name)
            if server.is_alive():
                server.kill()

    request.addfinalizer(fin)

    return t.cast(
        "type[Server]",
        functools.partial(
            Server,
            on_init=on_init,
            socket_name_factory=socket_name_factory,
        ),
    )
libtmux-0.45.0/src/libtmux/server.py000066400000000000000000000606441475667375600174630ustar00rootroot00000000000000"""Wrapper for :term:`tmux(1)` server.

libtmux.server
~~~~~~~~~~~~~~

"""

from __future__ import annotations

import logging
import os
import pathlib
import shutil
import subprocess
import typing as t
import warnings

from libtmux._internal.query_list import QueryList
from libtmux.common import tmux_cmd
from libtmux.neo import fetch_objs
from libtmux.pane import Pane
from libtmux.session import Session
from libtmux.window import Window

from . import exc, formats
from .common import (
    EnvironmentMixin,
    PaneDict,
    SessionDict,
    WindowDict,
    has_gte_version,
    session_check_name,
)

if t.TYPE_CHECKING:
    import sys
    import types

    if sys.version_info >= (3, 10):
        from typing import Self, TypeAlias
    else:
        from typing_extensions import Self, TypeAlias

    DashLiteral: TypeAlias = t.Literal["-"]

logger = logging.getLogger(__name__)


class Server(EnvironmentMixin):
    """:term:`tmux(1)` :term:`Server` [server_manual]_.

    - :attr:`Server.sessions` [:class:`Session`, ...]

      - :attr:`Session.windows` [:class:`Window`, ...]

        - :attr:`Window.panes` [:class:`Pane`, ...]

          - :class:`Pane`

    When instantiated stores information on live, running tmux server.

    Parameters
    ----------
    socket_name : str, optional
    socket_path : str, optional
    config_file : str, optional
    colors : str, optional
    on_init : callable, optional
    socket_name_factory : callable, optional

    Examples
    --------
    >>> server
    Server(socket_name=libtmux_test...)

    >>> server.sessions
    [Session($1 ...)]

    >>> server.sessions[0].windows
    [Window(@1 1:..., Session($1 ...))]

    >>> server.sessions[0].active_window
    Window(@1 1:..., Session($1 ...))

    >>> server.sessions[0].active_pane
    Pane(%1 Window(@1 1:..., Session($1 ...)))

    The server can be used as a context manager to ensure proper cleanup:

    >>> with Server() as server:
    ...     session = server.new_session()
    ...     # Do work with the session
    ...     # Server will be killed automatically when exiting the context

    References
    ----------
    .. [server_manual] CLIENTS AND SESSIONS. openbsd manpage for TMUX(1)
           "The tmux server manages clients, sessions, windows and panes.
           Clients are attached to sessions to interact with them, either when
           they are created with the new-session command, or later with the
           attach-session command. Each session has one or more windows linked
           into it. Windows may be linked to multiple sessions and are made up
           of one or more panes, each of which contains a pseudo terminal."

       https://man.openbsd.org/tmux.1#CLIENTS_AND_SESSIONS.
       Accessed April 1st, 2018.
    """

    socket_name = None
    """Passthrough to ``[-L socket-name]``"""
    socket_path = None
    """Passthrough to ``[-S socket-path]``"""
    config_file = None
    """Passthrough to ``[-f file]``"""
    colors = None
    """``256`` or ``88``"""
    child_id_attribute = "session_id"
    """Unique child ID used by :class:`~libtmux.common.TmuxRelationalObject`"""
    formatter_prefix = "server_"
    """Namespace used for :class:`~libtmux.common.TmuxMappingObject`"""

    def __init__(
        self,
        socket_name: str | None = None,
        socket_path: str | pathlib.Path | None = None,
        config_file: str | None = None,
        colors: int | None = None,
        on_init: t.Callable[[Server], None] | None = None,
        socket_name_factory: t.Callable[[], str] | None = None,
        **kwargs: t.Any,
    ) -> None:
        EnvironmentMixin.__init__(self, "-g")
        self._windows: list[WindowDict] = []
        self._panes: list[PaneDict] = []

        if socket_path is not None:
            self.socket_path = socket_path
        elif socket_name is not None:
            self.socket_name = socket_name
        elif socket_name_factory is not None:
            self.socket_name = socket_name_factory()

        tmux_tmpdir = pathlib.Path(os.getenv("TMUX_TMPDIR", "/tmp"))
        socket_name = self.socket_name or "default"
        if (
            tmux_tmpdir is not None
            and self.socket_path is None
            and self.socket_name is None
            and socket_name != "default"
        ):
            self.socket_path = str(tmux_tmpdir / f"tmux-{os.geteuid()}" / socket_name)

        if config_file:
            self.config_file = config_file

        if colors:
            self.colors = colors

        if on_init is not None:
            on_init(self)

    def __enter__(self) -> Self:
        """Enter the context, returning self.

        Returns
        -------
        :class:`Server`
            The server instance
        """
        return self

    def __exit__(
        self,
        exc_type: type[BaseException] | None,
        exc_value: BaseException | None,
        exc_tb: types.TracebackType | None,
    ) -> None:
        """Exit the context, killing the server if it exists.

        Parameters
        ----------
        exc_type : type[BaseException] | None
            The type of the exception that was raised
        exc_value : BaseException | None
            The instance of the exception that was raised
        exc_tb : types.TracebackType | None
            The traceback of the exception that was raised
        """
        if self.is_alive():
            self.kill()

    def is_alive(self) -> bool:
        """Return True if tmux server alive.

        >>> tmux = Server(socket_name="no_exist")
        >>> assert not tmux.is_alive()
        """
        try:
            res = self.cmd("list-sessions")
        except Exception:
            return False
        return res.returncode == 0

    def raise_if_dead(self) -> None:
        """Raise if server not connected.

        >>> tmux = Server(socket_name="no_exist")
        >>> try:
        ...     tmux.raise_if_dead()
        ... except Exception as e:
        ...     print(type(e))
        
        """
        tmux_bin = shutil.which("tmux")
        if tmux_bin is None:
            raise exc.TmuxCommandNotFound

        cmd_args: list[str] = ["list-sessions"]
        if self.socket_name:
            cmd_args.insert(0, f"-L{self.socket_name}")
        if self.socket_path:
            cmd_args.insert(0, f"-S{self.socket_path}")
        if self.config_file:
            cmd_args.insert(0, f"-f{self.config_file}")

        subprocess.check_call([tmux_bin, *cmd_args])

    #
    # Command
    #
    def cmd(
        self,
        cmd: str,
        *args: t.Any,
        target: str | int | None = None,
    ) -> tmux_cmd:
        """Execute tmux command respective of socket name and file, return output.

        Examples
        --------
        >>> server.cmd('display-message', 'hi')
        

        New session:

        >>> server.cmd('new-session', '-d', '-P', '-F#{session_id}').stdout[0]
        '$2'

        >>> session.cmd('new-window', '-P').stdout[0]
        'libtmux...:2.0'

        Output of `tmux -L ... new-window -P -F#{window_id}` to a `Window` object:

        >>> Window.from_window_id(window_id=session.cmd(
        ... 'new-window', '-P', '-F#{window_id}').stdout[0], server=session.server)
        Window(@4 3:..., Session($1 libtmux_...))

        Create a pane from a window:

        >>> window.cmd('split-window', '-P', '-F#{pane_id}').stdout[0]
        '%5'

        Output of `tmux -L ... split-window -P -F#{pane_id}` to a `Pane` object:

        >>> Pane.from_pane_id(pane_id=window.cmd(
        ... 'split-window', '-P', '-F#{pane_id}').stdout[0], server=window.server)
        Pane(%... Window(@... ...:..., Session($1 libtmux_...)))

        Parameters
        ----------
        target : str, optional
            Optional custom target.

        Returns
        -------
        :class:`common.tmux_cmd`

        Notes
        -----
        .. versionchanged:: 0.8

            Renamed from ``.tmux`` to ``.cmd``.
        """
        svr_args: list[str | int] = [cmd]
        cmd_args: list[str | int] = []
        if self.socket_name:
            svr_args.insert(0, f"-L{self.socket_name}")
        if self.socket_path:
            svr_args.insert(0, f"-S{self.socket_path}")
        if self.config_file:
            svr_args.insert(0, f"-f{self.config_file}")
        if self.colors:
            if self.colors == 256:
                svr_args.insert(0, "-2")
            elif self.colors == 88:
                svr_args.insert(0, "-8")
            else:
                raise exc.UnknownColorOption

        cmd_args = ["-t", str(target), *args] if target is not None else [*args]

        return tmux_cmd(*svr_args, *cmd_args)

    @property
    def attached_sessions(self) -> list[Session]:
        """Return active :class:`Session`s.

        Examples
        --------
        >>> server.attached_sessions
        []

        Returns
        -------
        list of :class:`Session`
        """
        return self.sessions.filter(session_attached__noeq="1")

    def has_session(self, target_session: str, exact: bool = True) -> bool:
        """Return True if session exists.

        Parameters
        ----------
        target_session : str
            session name
        exact : bool
            match the session name exactly. tmux uses fnmatch by default.
            Internally prepends ``=`` to the session in ``$ tmux has-session``.
            tmux 2.1 and up only.

        Raises
        ------
        :exc:`exc.BadSessionName`

        Returns
        -------
        bool
        """
        session_check_name(target_session)

        if exact and has_gte_version("2.1"):
            target_session = f"={target_session}"

        proc = self.cmd("has-session", target=target_session)

        return bool(not proc.returncode)

    def kill(self) -> None:
        """Kill tmux server.

        >>> svr = Server(socket_name="testing")
        >>> svr
        Server(socket_name=testing)

        >>> svr.new_session()
        Session(...)

        >>> svr.is_alive()
        True

        >>> svr.kill()

        >>> svr.is_alive()
        False
        """
        self.cmd("kill-server")

    def kill_session(self, target_session: str | int) -> Server:
        """Kill tmux session.

        Parameters
        ----------
        target_session : str, optional
            target_session: str. note this accepts ``fnmatch(3)``. 'asdf' will
            kill 'asdfasd'.

        Returns
        -------
        :class:`Server`

        Raises
        ------
        :exc:`exc.BadSessionName`
        """
        proc = self.cmd("kill-session", target=target_session)

        if proc.stderr:
            raise exc.LibTmuxException(proc.stderr)

        return self

    def switch_client(self, target_session: str) -> None:
        """Switch tmux client.

        Parameters
        ----------
        target_session : str
            name of the session. fnmatch(3) works.

        Raises
        ------
        :exc:`exc.BadSessionName`
        """
        session_check_name(target_session)

        proc = self.cmd("switch-client", target=target_session)

        if proc.stderr:
            raise exc.LibTmuxException(proc.stderr)

    def attach_session(self, target_session: str | None = None) -> None:
        """Attach tmux session.

        Parameters
        ----------
        target_session : str
            name of the session. fnmatch(3) works.

        Raises
        ------
        :exc:`exc.BadSessionName`
        """
        session_check_name(target_session)
        proc = self.cmd("attach-session", target=target_session)

        if proc.stderr:
            raise exc.LibTmuxException(proc.stderr)

    def new_session(
        self,
        session_name: str | None = None,
        kill_session: bool = False,
        attach: bool = False,
        start_directory: str | None = None,
        window_name: str | None = None,
        window_command: str | None = None,
        x: int | DashLiteral | None = None,
        y: int | DashLiteral | None = None,
        environment: dict[str, str] | None = None,
        *args: t.Any,
        **kwargs: t.Any,
    ) -> Session:
        """Create new session, returns new :class:`Session`.

        Uses ``-P`` flag to print session info, ``-F`` for return formatting
        returns new Session object.

        ``$ tmux new-session -d`` will create the session in the background
        ``$ tmux new-session -Ad`` will move to the session name if it already
        exists. todo: make an option to handle this.

        Parameters
        ----------
        session_name : str, optional
            ::

                $ tmux new-session -s 
        attach : bool, optional
            create session in the foreground. ``attach=False`` is equivalent
            to::

                $ tmux new-session -d

        Other Parameters
        ----------------
        kill_session : bool, optional
            Kill current session if ``$ tmux has-session``.
            Useful for testing workspaces.
        start_directory : str, optional
            specifies the working directory in which the
            new session is created.
        window_name : str, optional
            ::

                $ tmux new-session -n 
        window_command : str, optional
            execute a command on starting the session.  The window will close
            when the command exits. NOTE: When this command exits the window
            will close.  This feature is useful for long-running processes
            where the closing of the window upon completion is desired.
        x : [int, str], optional
            Force the specified width instead of the tmux default for a
            detached session
        y : [int, str], optional
            Force the specified height instead of the tmux default for a
            detached session

        Returns
        -------
        :class:`Session`

        Raises
        ------
        :exc:`exc.BadSessionName`

        Examples
        --------
        Sessions can be created without a session name (0.14.2+):

        >>> server.new_session()
        Session($2 2)

        Creating them in succession will enumerate IDs (via tmux):

        >>> server.new_session()
        Session($3 3)

        With a `session_name`:

        >>> server.new_session(session_name='my session')
        Session($4 my session)
        """
        if session_name is not None:
            session_check_name(session_name)

            if self.has_session(session_name):
                if kill_session:
                    self.cmd("kill-session", target=session_name)
                    logger.info(f"session {session_name} exists. killed it.")
                else:
                    msg = f"Session named {session_name} exists"
                    raise exc.TmuxSessionExists(
                        msg,
                    )

        logger.debug(f"creating session {session_name}")

        env = os.environ.get("TMUX")

        if env:
            del os.environ["TMUX"]

        tmux_args: tuple[str | int, ...] = (
            "-P",
            "-F#{session_id}",  # output
        )

        if session_name is not None:
            tmux_args += (f"-s{session_name}",)

        if not attach:
            tmux_args += ("-d",)

        if start_directory:
            tmux_args += ("-c", start_directory)

        if window_name:
            tmux_args += ("-n", window_name)

        if x is not None:
            tmux_args += ("-x", x)

        if y is not None:
            tmux_args += ("-y", y)

        if environment:
            if has_gte_version("3.2"):
                for k, v in environment.items():
                    tmux_args += (f"-e{k}={v}",)
            else:
                logger.warning(
                    "Environment flag ignored, tmux 3.2 or newer required.",
                )

        if window_command:
            tmux_args += (window_command,)

        proc = self.cmd("new-session", *tmux_args)

        if proc.stderr:
            raise exc.LibTmuxException(proc.stderr)

        session_stdout = proc.stdout[0]

        if env:
            os.environ["TMUX"] = env

        session_formatters = dict(
            zip(["session_id"], session_stdout.split(formats.FORMAT_SEPARATOR)),
        )

        return Session.from_session_id(
            server=self,
            session_id=session_formatters["session_id"],
        )

    #
    # Relations
    #
    @property
    def sessions(self) -> QueryList[Session]:
        """Sessions contained in server.

        Can be accessed via
        :meth:`.sessions.get() ` and
        :meth:`.sessions.filter() `
        """
        sessions: list[Session] = []

        try:
            for obj in fetch_objs(
                list_cmd="list-sessions",
                server=self,
            ):
                sessions.append(Session(server=self, **obj))  # noqa: PERF401
        except Exception:
            pass

        return QueryList(sessions)

    @property
    def windows(self) -> QueryList[Window]:
        """Windows contained in server's sessions.

        Can be accessed via
        :meth:`.windows.get() ` and
        :meth:`.windows.filter() `
        """
        windows: list[Window] = [
            Window(server=self, **obj)
            for obj in fetch_objs(
                list_cmd="list-windows",
                list_extra_args=("-a",),
                server=self,
            )
        ]

        return QueryList(windows)

    @property
    def panes(self) -> QueryList[Pane]:
        """Panes contained in tmux server (across all windows in all sessions).

        Can be accessed via
        :meth:`.panes.get() ` and
        :meth:`.panes.filter() `
        """
        panes: list[Pane] = [
            Pane(server=self, **obj)
            for obj in fetch_objs(
                list_cmd="list-panes",
                list_extra_args=("-a",),
                server=self,
            )
        ]

        return QueryList(panes)

    #
    # Dunder
    #
    def __eq__(self, other: object) -> bool:
        """Equal operator for :class:`Server` object."""
        if isinstance(other, Server):
            return (
                self.socket_name == other.socket_name
                and self.socket_path == other.socket_path
            )
        return False

    def __repr__(self) -> str:
        """Representation of :class:`Server` object."""
        if self.socket_name is not None:
            return (
                f"{self.__class__.__name__}"
                f"(socket_name={getattr(self, 'socket_name', 'default')})"
            )
        if self.socket_path is not None:
            return f"{self.__class__.__name__}(socket_path={self.socket_path})"
        return (
            f"{self.__class__.__name__}(socket_path=/tmp/tmux-{os.geteuid()}/default)"
        )

    #
    # Legacy: Redundant stuff we want to remove
    #
    def kill_server(self) -> None:
        """Kill tmux server.

        Notes
        -----
        .. deprecated:: 0.30

           Deprecated in favor of :meth:`.kill()`.

        """
        warnings.warn(
            "Server.kill_server() is deprecated in favor of Server.kill()",
            category=DeprecationWarning,
            stacklevel=2,
        )
        self.cmd("kill-server")

    def _list_panes(self) -> list[PaneDict]:
        """Return list of panes in :py:obj:`dict` form.

        Retrieved from ``$ tmux(1) list-panes`` stdout.

        The :py:obj:`list` is derived from ``stdout`` in
        :class:`util.tmux_cmd` which wraps :py:class:`subprocess.Popen`.

        .. deprecated:: 0.16

           Deprecated in favor of :attr:`.panes`.

        """
        warnings.warn(
            "Server._list_panes() is deprecated",
            category=DeprecationWarning,
            stacklevel=2,
        )
        return [p.__dict__ for p in self.panes]

    def _update_panes(self) -> Server:
        """Update internal pane data and return ``self`` for chainability.

        .. deprecated:: 0.16

           Deprecated in favor of :attr:`.panes` and returning ``self``.

        Returns
        -------
        :class:`Server`
        """
        warnings.warn(
            "Server._update_panes() is deprecated",
            category=DeprecationWarning,
            stacklevel=2,
        )
        self._list_panes()
        return self

    def get_by_id(self, session_id: str) -> Session | None:
        """Return session by id. Deprecated in favor of :meth:`.sessions.get()`.

        .. deprecated:: 0.16

           Deprecated by :meth:`.sessions.get()`.

        """
        warnings.warn(
            "Server.get_by_id() is deprecated",
            category=DeprecationWarning,
            stacklevel=2,
        )
        return self.sessions.get(session_id=session_id, default=None)

    def where(self, kwargs: dict[str, t.Any]) -> list[Session]:
        """Filter through sessions, return list of :class:`Session`.

        .. deprecated:: 0.16

           Deprecated by :meth:`.session.filter()`.

        """
        warnings.warn(
            "Server.find_where() is deprecated",
            category=DeprecationWarning,
            stacklevel=2,
        )
        try:
            return self.sessions.filter(**kwargs)
        except IndexError:
            return []

    def find_where(self, kwargs: dict[str, t.Any]) -> Session | None:
        """Filter through sessions, return first :class:`Session`.

        .. deprecated:: 0.16

           Slated to be removed in favor of :meth:`.sessions.get()`.

        """
        warnings.warn(
            "Server.find_where() is deprecated",
            category=DeprecationWarning,
            stacklevel=2,
        )
        return self.sessions.get(default=None, **kwargs)

    def _list_windows(self) -> list[WindowDict]:
        """Return list of windows in :py:obj:`dict` form.

        Retrieved from ``$ tmux(1) list-windows`` stdout.

        The :py:obj:`list` is derived from ``stdout`` in
        :class:`common.tmux_cmd` which wraps :py:class:`subprocess.Popen`.

        .. deprecated:: 0.16

           Slated to be removed in favor of :attr:`.windows`.

        """
        warnings.warn(
            "Server._list_windows() is deprecated",
            category=DeprecationWarning,
            stacklevel=2,
        )
        return [w.__dict__ for w in self.windows]

    def _update_windows(self) -> Server:
        """Update internal window data and return ``self`` for chainability.

        .. deprecated:: 0.16

           Deprecated in favor of :attr:`.windows` and returning ``self``.

        """
        warnings.warn(
            "Server._update_windows() is deprecated",
            category=DeprecationWarning,
            stacklevel=2,
        )
        self._list_windows()
        return self

    @property
    def _sessions(self) -> list[SessionDict]:
        """Property / alias to return :meth:`~._list_sessions`.

        .. deprecated:: 0.16

           Slated to be removed in favor of :attr:`.sessions`.

        """
        warnings.warn(
            "Server._sessions is deprecated",
            category=DeprecationWarning,
            stacklevel=2,
        )
        return self._list_sessions()

    def _list_sessions(self) -> list[SessionDict]:
        """Return list of session object dictionaries.

        .. deprecated:: 0.16

           Slated to be removed in favor of :attr:`.sessions`.
        """
        warnings.warn(
            "Server._list_sessions() is deprecated",
            category=DeprecationWarning,
            stacklevel=2,
        )
        return [s.__dict__ for s in self.sessions]

    def list_sessions(self) -> list[Session]:
        """Return list of :class:`Session` from the ``tmux(1)`` session.

        .. deprecated:: 0.16

           Slated to be removed in favor of :attr:`.sessions`.

        Returns
        -------
        list of :class:`Session`
        """
        warnings.warn(
            "Server.list_sessions is deprecated",
            category=DeprecationWarning,
            stacklevel=2,
        )
        return self.sessions

    @property
    def children(self) -> QueryList[Session]:
        """Was used by TmuxRelationalObject (but that's longer used in this class).

        .. deprecated:: 0.16

           Slated to be removed in favor of :attr:`.sessions`.

        """
        warnings.warn(
            "Server.children is deprecated",
            category=DeprecationWarning,
            stacklevel=2,
        )
        return self.sessions
libtmux-0.45.0/src/libtmux/session.py000066400000000000000000000700201475667375600176250ustar00rootroot00000000000000"""Pythonization of the :term:`tmux(1)` session.

libtmux.session
~~~~~~~~~~~~~~~

"""

from __future__ import annotations

import dataclasses
import logging
import pathlib
import typing as t
import warnings

from libtmux._internal.query_list import QueryList
from libtmux.constants import WINDOW_DIRECTION_FLAG_MAP, WindowDirection
from libtmux.formats import FORMAT_SEPARATOR
from libtmux.neo import Obj, fetch_obj, fetch_objs
from libtmux.pane import Pane
from libtmux.window import Window

from . import exc
from .common import (
    EnvironmentMixin,
    WindowDict,
    handle_option_error,
    has_gte_version,
    has_version,
    session_check_name,
)

if t.TYPE_CHECKING:
    import sys
    import types

    from libtmux.common import tmux_cmd

    if sys.version_info >= (3, 11):
        from typing import Self
    else:
        from typing_extensions import Self

    from .server import Server


logger = logging.getLogger(__name__)


@dataclasses.dataclass()
class Session(Obj, EnvironmentMixin):
    """:term:`tmux(1)` :term:`Session` [session_manual]_.

    Holds :class:`Window` objects.

    Parameters
    ----------
    server : :class:`Server`

    Examples
    --------
    >>> session
    Session($1 ...)

    >>> session.windows
    [Window(@1 ...:..., Session($1 ...)]

    >>> session.active_window
    Window(@1 ...:..., Session($1 ...))

    >>> session.active_pane
    Pane(%1 Window(@1 ...:..., Session($1 ...)))

    The session can be used as a context manager to ensure proper cleanup:

    >>> with server.new_session() as session:
    ...     window = session.new_window()
    ...     # Do work with the window
    ...     # Session will be killed automatically when exiting the context

    References
    ----------
    .. [session_manual] tmux session. openbsd manpage for TMUX(1).
           "When tmux is started it creates a new session with a single window
           and displays it on screen..."

           "A session is a single collection of pseudo terminals under the
           management of tmux.  Each session has one or more windows linked to
           it."

       https://man.openbsd.org/tmux.1#DESCRIPTION. Accessed April 1st, 2018.
    """

    server: Server

    def __enter__(self) -> Self:
        """Enter the context, returning self.

        Returns
        -------
        :class:`Session`
            The session instance
        """
        return self

    def __exit__(
        self,
        exc_type: type[BaseException] | None,
        exc_value: BaseException | None,
        exc_tb: types.TracebackType | None,
    ) -> None:
        """Exit the context, killing the session if it exists.

        Parameters
        ----------
        exc_type : type[BaseException] | None
            The type of the exception that was raised
        exc_value : BaseException | None
            The instance of the exception that was raised
        exc_tb : types.TracebackType | None
            The traceback of the exception that was raised
        """
        if self.session_name is not None and self.server.has_session(self.session_name):
            self.kill()

    def refresh(self) -> None:
        """Refresh session attributes from tmux."""
        assert isinstance(self.session_id, str)
        return super()._refresh(
            obj_key="session_id",
            obj_id=self.session_id,
            list_cmd="list-sessions",
        )

    @classmethod
    def from_session_id(cls, server: Server, session_id: str) -> Session:
        """Create Session from existing session_id."""
        session = fetch_obj(
            obj_key="session_id",
            obj_id=session_id,
            list_cmd="list-sessions",
            server=server,
        )
        return cls(server=server, **session)

    #
    # Relations
    #
    @property
    def windows(self) -> QueryList[Window]:
        """Windows contained by session.

        Can be accessed via
        :meth:`.windows.get() ` and
        :meth:`.windows.filter() `
        """
        windows: list[Window] = [
            Window(server=self.server, **obj)
            for obj in fetch_objs(
                list_cmd="list-windows",
                list_extra_args=["-t", str(self.session_id)],
                server=self.server,
            )
            if obj.get("session_id") == self.session_id
        ]

        return QueryList(windows)

    @property
    def panes(self) -> QueryList[Pane]:
        """Panes contained by session's windows.

        Can be accessed via
        :meth:`.panes.get() ` and
        :meth:`.panes.filter() `
        """
        panes: list[Pane] = [
            Pane(server=self.server, **obj)
            for obj in fetch_objs(
                list_cmd="list-panes",
                list_extra_args=["-s", "-t", str(self.session_id)],
                server=self.server,
            )
            if obj.get("session_id") == self.session_id
        ]

        return QueryList(panes)

    #
    # Command
    #
    def cmd(
        self,
        cmd: str,
        *args: t.Any,
        target: str | int | None = None,
    ) -> tmux_cmd:
        """Execute tmux subcommand within session context.

        Automatically binds target by adding  ``-t`` for object's session ID to the
        command. Pass ``target`` to keyword arguments to override.

        Examples
        --------
        >>> session.cmd('new-window', '-P').stdout[0]
        'libtmux...:....0'

        From raw output to an enriched `Window` object:

        >>> Window.from_window_id(window_id=session.cmd(
        ... 'new-window', '-P', '-F#{window_id}').stdout[0], server=session.server)
        Window(@... ...:..., Session($1 libtmux_...))

        Parameters
        ----------
        target : str, optional
            Optional custom target override. By default, the target is the session ID.

        Returns
        -------
        :meth:`server.cmd`

        Notes
        -----
        .. versionchanged:: 0.34

           Passing target by ``-t`` is ignored. Use ``target`` keyword argument instead.

        .. versionchanged:: 0.8

            Renamed from ``.tmux`` to ``.cmd``.
        """
        if target is None:
            target = self.session_id
        return self.server.cmd(cmd, *args, target=target)

    """
    Commands (tmux-like)
    """

    def set_option(
        self,
        option: str,
        value: str | int,
        global_: bool = False,
    ) -> Session:
        """Set option ``$ tmux set-option