python / python/mypy

Not reporting any error when function returns bool type while expecting str type

Open
#9,194 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Hi

I noticed a situation where I wasn't getting a type error from mypy when I would have expected to get one.

Below is the code I have. I purposefully set the return type to str because I wanted to see a mypy error, and specifically I expected the error to be that I had set the wrong return type (e.g. as the code is doing a comparison, which will thus return a bool type, I expected mypy to say the return type should be of type bool):

def is_dev() -> str:
    return settings.get("environment") == "dev"

In that code snippet you'll see settings.get(...), which is a function that returns a string, and we compare that string against another string.

Note: as settings.get is custom code, mypy knows nothing about what type is being returned.

My hypothesis is that because my specific example uses code that mypy can't identify the type for (i.e. settings.get()), mypy just goes ahead and ignores any other possible type check errors (such as me specifying the return type as str).

If that's expected of mypy then fine, but it just confused me.

I'm using mypy version 0.782 and Python version 3.7.7.

I'm running mypy in two places:

  1. vim integration (e.g. mypy --ignore-missing-imports --strict-equality)
  2. tox (e.g. mypy --ignore-missing-imports --package foo)

Note: I've tried also changing to --no-strict-equality and it makes no difference.

Thank you for any guidance you can give me.

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

Reproduce the reported function with mypy 0.782, Python 3.7.7, and the listed --strict-equality and --ignore-missing-imports options, then compare the diagnostics with the expected return-type error. Trace the type-checking path for return expressions and unknown types; done means the behavior is corrected or clearly documented with a regression test.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.