Context managers

[tony]

Changes

Added context manager support for all main tmux objects:

• 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:

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.

Summary by Sourcery

Add context managers for Server, Session, Window, and Pane objects to automatically kill them when exiting a with block.

New Features:

• Add context manager support to Server, Session, Window, and Pane objects. This allows for automatic cleanup of these objects when exiting a with block. For example, a pane created within a with block will be automatically killed when the block is exited, even if an exception occurs within the block. This simplifies resource management and prevents resource leaks in scripts and applications using libtmux. The context managers return the object itself, allowing for convenient usage within the with block. For instance, with window.split() as pane: creates a new pane and assigns it to the variable pane for use within the block, and then kills the pane upon exiting the block.

Tests:

• Add tests for the context manager functionality of Server, Session, Window, and Pane objects. These tests verify that the objects are correctly cleaned up when exiting the with block, both under normal conditions and when exceptions are raised within the block. The tests cover scenarios where the objects are created within the with block and where they are created outside the block and then entered. They also check that the objects are not killed if they are already closed before exiting the block.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request implements context managers for the Server, Session, Window, and Pane objects in libtmux. This allows these objects to be used in 'with' statements, ensuring that they are automatically killed when the context is exited. Tests have been added to verify this functionality.

Updated class diagram for Pane

classDiagram
    class Pane {
        -pane_id: str | None
        -window: Window
        -server: Server
        +__enter__(): Self
        +__exit__(exc_type: type[BaseException] | None, exc_value: BaseException | None, exc_tb: types.TracebackType | None): None
        +refresh(): None
    }

Loading

Updated class diagram for Window

classDiagram
    class Window {
        -window_id: str | None
        -session: Session
        -server: Server
        +__enter__(): Self
        +__exit__(exc_type: type[BaseException] | None, exc_value: BaseException | None, exc_tb: types.TracebackType | None): None
        +refresh(): None
    }

Loading

Updated class diagram for Server

classDiagram
    class Server {
        +__enter__(): Self
        +__exit__(exc_type: type[BaseException] | None, exc_value: BaseException | None, exc_tb: types.TracebackType | None): None
        +is_alive(): bool
    }

Loading

Updated class diagram for Session

classDiagram
    class Session {
        -session_id: str | None
        -server: Server
        +__enter__(): Self
        +__exit__(exc_type: type[BaseException] | None, exc_value: BaseException | None, exc_tb: types.TracebackType | None): None
        +refresh(): None
    }

Loading

File-Level Changes

Change	Details	Files
Implementation of context managers for Server, Session, Window, and Pane objects to ensure proper cleanup.	Added enter and exit methods to Server, Session, Window, and Pane classes. The enter method returns the instance itself. The exit method kills the object (server, session, window, or pane) if it still exists when the context is exited.	src/libtmux/pane.py src/libtmux/window.py src/libtmux/server.py src/libtmux/session.py
Added tests to verify the context manager functionality for Server, Session, Window, and Pane objects.	Added test_server_context_manager to test Server context manager. Added test_session_context_manager to test Session context manager. Added test_window_context_manager to test Window context manager. Added test_pane_context_manager to test Pane context manager.	tests/test_pane.py tests/test_server.py tests/test_session.py tests/test_window.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[codecov]

Codecov Report

Attention: Patch coverage is 94.33962% with 3 lines in your changes missing coverage. Please review.

Project coverage is 88.84%. Comparing base (9018da6) to head (92660e4).
Report is 5 commits behind head on master.

Files with missing lines	Patch %	Lines
src/libtmux/pane.py	83.33%	0 Missing and 1 partial ⚠️
src/libtmux/session.py	83.33%	0 Missing and 1 partial ⚠️
src/libtmux/window.py	83.33%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #566      +/-   ##
==========================================
+ Coverage   88.77%   88.84%   +0.07%     
==========================================
  Files          36       36              
  Lines        4027     4080      +53     
  Branches      372      376       +4     
==========================================
+ Hits         3575     3625      +50     
  Misses        310      310              
- Partials      142      145       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.