Remove @dataclasses.dataclass from TaskProgressEvent#305
Merged
Abhijeet Prasad (AbhiPrasad) merged 1 commit intobraintrustdata:mainfrom Apr 16, 2026
Conversation
Fixes braintrustdata#293. TaskProgressEvent inherits from TypedDict, which uses an incompatible metaclass with @dataclasses.dataclass. The maintainer confirmed TypedDict is the intended form and the decorator is unnecessary.
Abhijeet Prasad (AbhiPrasad)
approved these changes
Apr 16, 2026
Abhijeet Prasad (AbhiPrasad)
merged commit 173a727
into
braintrustdata:main
84 checks passed
Will Frey (willfrey)
deleted the
fix/remove-dataclass-from-task-progress-event
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #293.
TaskProgressEventwas decorated with both@dataclasses.dataclassand inherited fromTypedDict. These use incompatible metaclass mechanisms —TypedDictuses its own metaclass to build the class dict, while@dataclasses.dataclassexpects a regular class and transforms its annotations into dataclass fields. The combination works accidentally at runtime but confuses static type checkers and is unnecessary.The maintainer confirmed that
TypedDictis the intended form. This PR removes the@dataclasses.dataclassdecorator, leavingclass TaskProgressEvent(TypedDict):unchanged.Test plan
@dataclasses.dataclassdecorators are affected (onlyTaskProgressEvent's was removed)TaskProgressEventand its subclassSSEProgressEventcontinue to work as plainTypedDictclasses