WIP: Snapshot

[tony]

Architecture

It's meant for Python 3.9+ to create immutable "snapshots" of libtmux objects, two rules:

1. Python 3.9+ friendly
2. type completion / static type analysis friendly
3. can inherit fields from their parent object. e.g. PaneSnapshot can inherit Pane's fields.
4. can set bidirectional dependencies, e.g. set server and server_snapshot in __post_init__ before freezing / sealing

There is a faux-frozen=True faker called frozen_dataclass_sealable that can imitate frozen behavior, but circumvent some limitations:

1. frozen=True in vanilla dataclasses can't be mixed with non-frozen dataclass. We want immutable snapshots of a mutable object!
2. The snapshots need bidirectional references of their server and parent object, so those fields need to temporarily mutable - initially - until seal()ed at __post_init__.

Summary by Sourcery

Introduces snapshot functionality for tmux objects, allowing read-only copies of the server, sessions, windows, and panes. These snapshots preserve the object structure and relationships while preventing modifications or tmux command execution. Also adds functionality to filter snapshots and convert them to dictionaries.

New Features:

• Adds ServerSnapshot, SessionSnapshot, WindowSnapshot, and PaneSnapshot classes for creating read-only snapshots of tmux objects.
• Implements snapshot filtering to prune the snapshot tree based on a filter function.
• Provides functionality to convert snapshots to dictionaries, avoiding circular references for serialization.
• Adds a function to filter a snapshot to contain only active sessions, windows and panes.
• Adds a test script to demonstrate the snapshot functionality, including creation, read-only enforcement, filtering, and serialization.

Summary by Sourcery

Implements snapshot functionality for tmux objects, allowing read-only copies of the server, sessions, windows, and panes. These snapshots preserve the object structure and relationships while preventing modifications or tmux command execution. Also adds functionality to filter snapshots and convert them to dictionaries.

New Features:

• Adds ServerSnapshot, SessionSnapshot, WindowSnapshot, and PaneSnapshot classes for creating read-only snapshots of tmux objects.
• Implements snapshot filtering to prune the snapshot tree based on a filter function.
• Provides functionality to convert snapshots to dictionaries, avoiding circular references for serialization.
• Adds a function to filter a snapshot to contain only active sessions, windows and panes.
• Adds a test script to demonstrate the snapshot functionality, including creation, read-only enforcement, filtering, and serialization.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces snapshot functionality for libtmux, allowing users to create immutable copies of tmux server, session, window, and pane objects. It also includes functionality for filtering snapshots and converting them to dictionaries. The implementation uses dataclasses and a custom frozen_dataclass_sealable decorator to achieve immutability after initialization. Additionally, the pull request fixes a typo in the split_window method and removes example code from the send_keys method in the Pane class.

Updated class diagram for ServerSnapshot

classDiagram
    class ServerSnapshot {
        -server: Server
        -_is_snapshot: bool
        -created_at: datetime
        -sessions_snapshot: list[SessionSnapshot]
        -panes_snapshot: list[PaneSnapshot]
        +cmd(cmd: str, *args: t.Any, **kwargs: t.Any) : None
        +sessions() : QueryList[SessionSnapshot]
        +windows() : QueryList[WindowSnapshot]
        +panes() : QueryList[PaneSnapshot]
        +is_alive() : bool
        +raise_if_dead() : None
        +from_server(server: Server, include_content: bool) : ServerSnapshot
    }
    ServerSnapshot -- SessionSnapshot : contains
    ServerSnapshot -- PaneSnapshot : contains

Loading

Updated class diagram for SessionSnapshot

classDiagram
    class SessionSnapshot {
        -server: Server
        -_is_snapshot: bool
        -windows_snapshot: list[WindowSnapshot]
        -created_at: datetime
        -server_snapshot: ServerSnapshot
        +cmd(cmd: str, *args: t.Any, **kwargs: t.Any) : None
        +windows() : QueryList[WindowSnapshot]
        +get_server() : ServerSnapshot
        +active_window() : WindowSnapshot
        +active_pane() : PaneSnapshot
        +from_session(session: Session, capture_content: bool, server_snapshot: ServerSnapshot) : SessionSnapshot
    }
    SessionSnapshot -- WindowSnapshot : contains

Loading

Updated class diagram for WindowSnapshot

classDiagram
    class WindowSnapshot {
        -server: Server
        -_is_snapshot: bool
        -panes_snapshot: list[PaneSnapshot]
        -created_at: datetime
        -session_snapshot: SessionSnapshot
        +cmd(cmd: str, *args: t.Any, **kwargs: t.Any) : None
        +panes() : QueryList[PaneSnapshot]
        +session() : SessionSnapshot
        +active_pane() : PaneSnapshot
        +from_window(window: Window, capture_content: bool, session_snapshot: SessionSnapshot) : WindowSnapshot
    }
    WindowSnapshot -- PaneSnapshot : contains

Loading

Updated class diagram for PaneSnapshot

classDiagram
    class PaneSnapshot {
        -server: Server
        -_is_snapshot: bool
        -pane_content: list[str]
        -created_at: datetime
        -window_snapshot: WindowSnapshot
        +cmd(cmd: str, *args: t.Any, **kwargs: t.Any) : None
        +content() : list[str]
        +capture_pane(start: int, end: int) : list[str]
        +window() : WindowSnapshot
        +session() : SessionSnapshot
        +from_pane(pane: Pane, capture_content: bool, window_snapshot: WindowSnapshot) : PaneSnapshot
    }

Loading

File-Level Changes

Change	Details	Files
Introduces snapshot functionality for tmux objects, enabling the creation of read-only copies of the server, sessions, windows, and panes.	Adds ServerSnapshot, SessionSnapshot, WindowSnapshot, and PaneSnapshot classes. Implements snapshot filtering to prune the snapshot tree based on a filter function. Provides functionality to convert snapshots to dictionaries, avoiding circular references for serialization. Adds a function to filter a snapshot to contain only active sessions, windows and panes. Adds a test script to demonstrate the snapshot functionality, including creation, read-only enforcement, filtering, and serialization.	src/libtmux/snapshot.py tests/test_snapshot.py
Implements a frozen_dataclass_sealable decorator to create sealable dataclasses, allowing for temporary mutability during initialization before becoming immutable.	Introduces Sealable base class and frozen_dataclass_sealable decorator. Adds metadata to dataclass fields to allow mutability during initialization. Implements seal() method to prevent further modifications.	src/libtmux/snapshot.py
Updates mypy configuration to ignore certain errors in the snapshot module.	Adds a mypy override to disable the override error code for the libtmux.snapshot module.	pyproject.toml
Modifies the split_window method in Pane class to correct a documentation error.	Fixes a typo in the docstring of the split_window method, changing 'window' to 'pane'.	src/libtmux/pane.py
Updates the send_keys method in Pane class to remove the example code.	Removes the example code from the docstring of the send_keys method.	src/libtmux/pane.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.