Skip to content

Fix dataclass_transform base frozen inheritance - #11993

Open
自分 (2Zest) wants to merge 4 commits into
microsoft:mainfrom
2Zest:fix/dataclass-transform-neutral-frozen-11988
Open

自分 (2Zest) wants to merge 4 commits into
microsoft:mainfrom
2Zest:fix/dataclass-transform-neutral-frozen-11988

Conversation

@2Zest

Copy link
Copy Markdown

Fixes #11988

Summary

Classes decorated with dataclass_transform are neither frozen nor non-frozen according to the typing specification. When such a class was used as a base, Pyright still treated its effective frozen_default as an actual frozen dataclass and rejected a non-frozen subclass.

This change excludes dataclass-transform classes (including classes whose metaclass carries the transform) from frozen-base compatibility checks while preserving the existing checks for concrete generated dataclasses.

Tests

  • Added dataclassTransform5.py covering both non-frozen and frozen subclasses of nested dataclass_transform classes.
  • Added the corresponding DataclassTransform5 type-evaluator test.

Local static validation: git diff --check passes. The repository's Node dependencies were not installed in this environment, so the TypeScript test and lint commands could not be run locally.

AI assistance: OpenAI Codex assisted with investigation, implementation, and test authoring.

@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

自分 (@2Zest) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@heejaechang

Copy link
Copy Markdown
Collaborator

🟢 Pyright CLI QA — 50592437 — verdict: green

Automated CLI checks compared this change with its base revision.
10 focused check(s) completed.

No new behavior difference was detected.

@bschnurr

Copy link
Copy Markdown
Member

I pushed d9c672c to this branch. It adds # pyright: ignore[reportMissingModuleSource] to the typing_extensions import in dataclassTransform5.py. On Windows CI that import produced one extra warning and failed DataclassTransform5; other samples use the same suppression. Behavior review: the intended false positives are gone, and the concrete-base and decorator checks are unchanged.

🤖 AI-assisted review posted on behalf of Bill Schnurr (@bschnurr).

@rchiodo Rich Chiodo (rchiodo) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Skipping the direct neutral provider seems to also skip a concrete frozen ancestor:

from dataclasses import dataclass
from typing import cast, dataclass_transform

@dataclass_transform(frozen_default=True)
class Meta(type):
    def __new__(cls, name, bases, namespace, *, frozen=True, provider=False):
        result = super().__new__(cls, name, bases, namespace)
        if not provider:
            dataclass(cast(type, result), frozen=frozen)
        return result

@dataclass(frozen=True)
class Frozen:
    value: int = 0

class Neutral(Frozen, metaclass=Meta, provider=True): pass
class Mutable(Neutral, frozen=False): pass

On base, the error at Mutable comes from treating Neutral as frozen, not from walking through it to Frozen. Head (d9c672c) reports no error, while CPython 3.14.3 raises TypeError: cannot inherit non-frozen dataclass from a frozen one. Neutral should be neutral, but Frozen still matters.

The no-concrete-ancestor control is rejected by base and accepted by head (the intended benefit), and a frozen descendant of a frozen ancestor passes on both. Could we keep those behaviors while checking concrete ancestors through the neutral class? I don't have a tested fix.

The reverse direction is an existing gap, not a new regression:

from dataclasses import dataclass
from typing import dataclass_transform

@dataclass_transform()
class Meta(type): pass

@dataclass
class Mutable:
    value: int

class Neutral(Mutable, metaclass=Meta):
    def __init_subclass__(cls, *, frozen: bool = False) -> None:
        super().__init_subclass__()
        dataclass(cls, frozen=frozen)

class Bad(Neutral, frozen=True): pass

Both revisions accept this, but CPython raises TypeError: cannot inherit frozen dataclass from a non-frozen one. Could we cover both ancestry directions while making this change?

The provider class itself is another existing case:

from dataclasses import dataclass
from typing import dataclass_transform

@dataclass_transform()
class Meta(type): pass

@dataclass(frozen=True)
class Frozen:
    value: int

class Neutral(Frozen, metaclass=Meta): pass

print(Neutral(1).value)

Both revisions reject this, but CPython constructs it and prints 1. Per the typing spec, a class directly specifying a transform-decorated metaclass is neither frozen nor non-frozen. Could we consider respecting that neutrality for the class itself, not just descendants?

@bschnurr

Copy link
Copy Markdown
Member

I independently replayed the frozen-ancestor finding on d9c672c integrated with d95fe63b. All five focused DataclassTransform tests pass, but the finding still holds: a mutable subclass of a neutral provider with a concrete frozen ancestor loses reportGeneralTypeIssues, and CPython 3.14.7 raises TypeError. The intended control (neutral provider with no concrete frozen ancestor) is accepted on the PR, and a frozen descendant of the concrete frozen ancestor is accepted on both. I'd keep the neutral-provider fix but preserve the concrete ancestor's frozen constraint.

@github-actions

Copy link
Copy Markdown
Contributor

According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅

@github-actions

Copy link
Copy Markdown
Contributor

Compared candidate 2386f17e76eb8ecd1173eaee957f0b0b2d561749 against its first parent 7e29199f7b3c5bddeda6956588a15552398a66ad.

Release history charts were not rendered for this run. See the workflow run for details.

Type checker benchmark

🟢 No performance regressions detected.

Regression threshold: 20.0%
Statistic: median
Variance guard: >1.0s time and >100.0 MB memory

Package Checker Files checked Time Time delta Peak memory Memory delta Status
ansible pyright 583 24.151s -0.0% 1076.4 MB +0.1% 🟢 Pass
click pyright 17 2.439s +1.3% 357.4 MB -0.1% 🟢 Pass
homeassistant pyright 9850 157.887s -0.1% 6002.3 MB -1.7% 🟢 Pass
numpy pyright 356 29.829s +1.3% 1343.3 MB +7.8% 🟢 Pass
pandas pyright 1459 141.144s +0.6% 3452.0 MB -0.7% 🟢 Pass
pytest pyright 243 12.074s -0.8% 867.3 MB +0.2% 🟢 Pass
requests pyright 19 1.950s -0.4% 344.2 MB +0.3% 🟢 Pass
torch pyright 2400 141.183s -0.1% 4609.8 MB +0.0% 🟢 Pass
transformers pyright 2901 128.929s +1.7% 4910.5 MB +1.0% 🟢 Pass

Pyright stats

Package Parsed/bound Checked Find Read Tokenize Parse Imports Bind Check Cycles
ansible 988 583 0.050s 0.107s 0.427s 0.793s 0.253s 1.107s 20.443s 0.000s
click 111 17 0.000s 0.013s 0.080s 0.160s 0.037s 0.220s 1.667s 0.000s
homeassistant 11154 9850 0.737s 0.863s 3.133s 5.847s 2.200s 7.917s 133.567s 0.000s
numpy 606 356 0.010s 0.053s 0.273s 0.533s 0.200s 0.760s 27.353s 0.000s
pandas 1899 1459 0.070s 0.213s 1.277s 2.507s 0.273s 2.617s 134.603s 0.000s
pytest 545 243 0.020s 0.047s 0.360s 0.450s 0.097s 0.653s 10.073s 0.000s
requests 167 19 0.000s 0.013s 0.090s 0.167s 0.043s 0.227s 1.133s 0.000s
torch 3078 2400 0.147s 0.437s 2.083s 3.210s 0.620s 4.887s 127.313s 0.000s
transformers 3536 2901 0.170s 0.397s 2.150s 3.730s 1.057s 9.383s 114.260s 0.000s

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Class with @dataclass_transform is assumed to be frozen when inheriting from other class with @dataclass_transform

4 participants