python-attrs / python-attrs/attrs

Type checking unexpectedly passing when misusing `default` and `converter`

Open
#604 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Bug Typing
Dominant language
Python
Stars
5.8k
Forks
480
Avg merge
2h 15m
Merged PRs (30d)
2

Description

I was playing around with type annotations and Attrs, and I think I may have found an issue.

Given the following Python 2/3 script:

from __future__ import absolute_import

from pprint import pprint as pp

import attr


def _convert_int(val):
    # type: (int) -> int
    if val <= 0:
        return -1
    return val


@attr.s
class A(object):
    x = attr.ib(default=0, converter=_convert_int, type=int)
    y = attr.ib(default=None, converter=_convert_int, type=int)  # `default` is incompatible with our declared `type`


def main():
    # type: () -> None
    a1 = A(5, 5)        # correct: type checks
    pp(a1)
    a2 = A(5, None)     # correct: doesn't type check
    pp(a2)
    a3 = A(5)           # incorrect: type checks but shouldn't!
    pp(a3)


if __name__ == '__main__':
    main()

I'd expect MyPy to complain about the relationship between default and converter for y. Nevertheless, I'm getting:

image

Which is one error less than expected.

Should I perhaps report this to MyPy or Typeshed as well/instead?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the Python 2/3 reproducer and checking the reported MyPy diagnostics for A, especially the y attribute using default=None and _convert_int. Trace whether the missing error belongs to attrs' generated typing information or to MyPy/Typeshed, and consider the issue done when the ownership and a regression check for this case are established.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.