Infer type of `attrs.fields(type(attrs_instance))`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Feature
mypy currently infers the type of attrs.fields(foo) as Any, where foo is an instance of an attrs class. Is it possible to have mypy infer the correct type?
With this setup:
import attrs
from attrs import define
@define
class Foo:
bar: int
foo = Foo(1)
mypy infers the correct type for attrs.fields(Foo):
fields = attrs.fields(Foo)
reveal_type(fields)
reveal_type(fields.bar)
reveal_type(fields.not_bar)
"""
demo.py:13: note: Revealed type is "tuple[attr.Attribute[builtins.int], fallback=demo.Foo.__demo_Foo_AttrsAttributes__]"
demo.py:14: note: Revealed type is "attr.Attribute[builtins.int]"
demo.py:15: error: "__demo_Foo_AttrsAttributes__" has no attribute "not_bar" [attr-defined]
demo.py:15: note: Revealed type is "Any"
Found 1 error in 1 file (checked 1 source file)
"""
but mypy infers attrs.fields(type(foo)) as Any:
fields = attrs.fields(type(foo))
reveal_type(fields)
reveal_type(fields.bar)
reveal_type(fields.not_bar)
"""
demo.py:13: note: Revealed type is "Any"
demo.py:14: note: Revealed type is "Any"
demo.py:15: note: Revealed type is "Any"
Success: no issues found in 1 source file
"""
Pitch
Passing the class to attrs.fields() is the documented usage.
If you pass type(attrs_instance) instead, mypy quietly treats the type as Any (even under strict mode), so it cannot catch attr-defined errors when you access a non-existent field.
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
Reproduce the two attrs.fields cases from the issue, including the reveal_type checks for fields.bar and fields.not_bar, under strict mode. Trace mypy's handling of attrs.fields(type(foo)); done means the instance-derived form receives the same useful field type as attrs.fields(Foo) and rejects the nonexistent field.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100