WIP: Custom frozen dataclasses

[tony]

Resolves #588

Summary by Sourcery

Tests:

• Adds comprehensive tests for the frozen_dataclass decorator, covering initialization, immutability, inheritance, edge cases, nested mutability, bidirectional references, and mutation methods.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a frozen_dataclass decorator that allows creating immutable dataclasses that inherit from mutable ones. It includes comprehensive tests and configurations for mypy and ruff.

Class diagram for frozen_dataclass decorator

classDiagram
    class frozen_dataclass {
        +__init__(cls: type[_T]) type[_T]
    }
    class dataclasses.dataclass {
        +__init__(frozen: bool)
    }
    class cls {
        +__setattr__(name: str, value: t.Any) None
        +__delattr__(name: str) None
        -_frozen: bool
    }
    frozen_dataclass --|> dataclasses.dataclass: Uses
    frozen_dataclass --|> cls: Decorates

Loading

File-Level Changes

Change	Details	Files
Introduces a frozen_dataclass decorator to create immutable dataclasses inheriting from mutable ones.	Adds a frozen_dataclass decorator. Applies @dataclasses.dataclass(frozen=False) to preserve dataclass generation. Overrides __setattr__ and __delattr__ to prevent changes after initialization. Adds a _frozen attribute to control immutability. Includes documentation and examples for the decorator.	src/libtmux/_internal/frozen_dataclass.py
Adds tests for the frozen_dataclass decorator, covering initialization, immutability, inheritance, and edge cases.	Creates base and snapshot dataclasses for testing. Tests immutability by attempting to modify fields and verifying AttributeError exceptions. Tests inheritance from mutable base classes. Tests internal attribute modification. Tests nested mutability. Tests bidirectional references. Adds parametrized tests for dimensions and frozen flag behavior. Adds tests for mutation methods and inheritance behavior.	tests/_internal/test_frozen_dataclass.py
Configures mypy to ignore method-assign errors for the frozen_dataclass module.	Adds a mypy override to disable method-assign errors for the libtmux._internal.frozen_dataclass module.	pyproject.toml
Configures ruff to ignore B010 (set-attr-with-constant) errors for the frozen_dataclass module.	Adds a ruff ignore rule to disable B010 errors for the src/libtmux/_internal/frozen_dataclass.py module.	pyproject.toml

---

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

❌ Patch coverage is 82.32044% with 32 lines in your changes missing coverage. Please review.
✅ Project coverage is 52.82%. Comparing base (5a34cc5) to head (d18a0fd).

Files with missing lines	Patch %	Lines
src/libtmux/_internal/frozen_dataclass_sealable.py	78.78%	20 Missing and 8 partials ⚠️
src/libtmux/_internal/frozen_dataclass.py	91.66%	1 Missing and 1 partial ⚠️
.../_internal/frozen_dataclass_sealable/test_basic.py	92.00%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #586      +/-   ##
==========================================
+ Coverage   51.29%   52.82%   +1.53%     
==========================================
  Files          25       28       +3     
  Lines        3488     3669     +181     
  Branches      686      730      +44     
==========================================
+ Hits         1789     1938     +149     
- Misses       1404     1426      +22     
- Partials      295      305      +10     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[tony]

@sourcery-ai review

[sourcery-ai]

Hey @tony - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a note about the performance implications of using __setattr__ and __delattr__.
• It would be helpful to include a warning in the documentation about the potential for users to bypass the immutability by modifying the _frozen attribute.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟡 Testing: 1 issue found
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

issue (testing): Edge case: Unfreezing via _frozen attribute

Although tested, the ability to unfreeze by modifying _frozen is a security risk. Consider making _frozen a property with a private setter to prevent this or document this behavior clearly as a known limitation.