Type of default value for `attrs.field()` is revealed as `Union[builtins.int, None]`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Bug Report
Default (default=) value for attrs.field() type is revealed as Union[builtins.int, None] where the Union with None is unexpected. While this used to be revealed as Any, this shows up as a regression, bisected to https://github.com/python/mypy/commit/391ed853f (PR https://github.com/python/mypy/pull/15021, mypy master, unreleased).
To Reproduce
import attrs
@attrs.define()
class MyDataClass:
some_int_field: int = attrs.field(default=123)
# Somewhere else in the project I would like to reference that default:
reveal = attrs.fields(MyDataClass).some_int_field.default
reveal_type(reveal)
assignment_to_int_fails: int = attrs.fields(MyDataClass).some_int_field.default
Expected Behavior
$ mypy --strict myfile.py
myfile.py:9:13: note: Revealed type is "builtins.int"
Success: no issues found in 1 source file
Actual Behavior
on master (tested 9edda9a79790d8f7263234eca9509657ea0c37f0):
$ mypy --strict --show-error-context --show-column-numbers myfile.py
myfile.py:9:13: note: Revealed type is "Union[builtins.int, None]"
myfile.py:11:32: error: Incompatible types in assignment (expression has type "int | None", variable has type "int") [assignment]
Found 1 error in 1 file (checked 1 source file)
(my project fails, suspected mypy bug / imperfect type inference)
On 1.5.1:
$ mypy --strict myfile.py
myfile.py:9:13: note: Revealed type is "Any"
Success: no issues found in 1 source file
(my project passes, albeit without a proper type check)
Your Environment
- Mypy version used: master (1.5.1 = OK, introduced with https://github.com/python/mypy/commit/391ed853f)
- Mypy command-line flags:
--strict --show-error-context --show-column-numbers - Mypy configuration options from
mypy.ini(and other config files): n/a - Python version used: 3.11.5
Project to test on if you want (100% mypy-strict compatible on 1.5.1 and master otherwise): https://github.com/gertvdijk/PyKMP
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the minimal attrs example in the issue and run it under mypy master with --strict, comparing the behavior from version 1.5.1. Read bisected commit 391ed853f and PR #15021 to trace the regression. Done means the default is revealed as int and the assignment passes without errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- compilers, devtools
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100