Quality: SingleResult dataclass fields default to None but typed as non-Optional — will crash on attribute access#288
Open
kumburovicbranko682-boop wants to merge 1 commit into
Conversation
…non-optional — will crash on attribute access The `SingleResult` dataclass declares `example: Example` and `result: RunResult` but defaults both to `None`. The `# type: ignore[assignment]` silences the type checker but does not fix the runtime problem: any code that constructs `SingleResult()` without explicitly setting both fields and then accesses `sr.example.name` or `sr.result.exit_code` will crash with `AttributeError: 'NoneType' object has no attribute 'name'`. The sibling class `RunResult` demonstrates the correct pattern — every field has a concrete default. `Example` requires three non-defaulted args (name, path, cwd), so the author punted with `None`. Callers have no type-level signal that these fields can be absent. Affected files: models.py Signed-off-by: kumburovicbranko682-boop <295886834+kumburovicbranko682-boop@users.noreply.github.com>
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
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.
✨ Code Quality
Problem
The
SingleResultdataclass declaresexample: Exampleandresult: RunResultbut defaults both toNone. The# type: ignore[assignment]silences the type checker but does not fix the runtime problem: any code that constructsSingleResult()without explicitly setting both fields and then accessessr.example.nameorsr.result.exit_codewill crash withAttributeError: 'NoneType' object has no attribute 'name'. The sibling classRunResultdemonstrates the correct pattern — every field has a concrete default.Examplerequires three non-defaulted args (name, path, cwd), so the author punted withNone. Callers have no type-level signal that these fields can be absent.Severity:
highFile:
sdk/python/validation/models.pySolution
from typing import Optional
@DataClass
class SingleResult:
"""Result of running one example with one model (single-run mode)."""
Then guard all consumers:
if single_result.example is not None:
...
Changes
sdk/python/validation/models.py(modified)Testing
🤖 About this PR
This pull request was generated by ContribAI, an AI agent
that helps improve open source projects. The change was:
If you have questions or feedback about this PR, please comment below.
We appreciate your time reviewing this contribution!
Closes #287