python / python/mypy

Type refinement does not work with `None in [a, b, c]`, `any()`, or `all()` checks

Open
#17,149 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug topic-type-narrowing
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

When checking if multiple variables are not None using the syntax None in [a, b, c], mypy fails to refine the types of these variables to non-Optional types after this check. This issue persists even when using any() or all() for similar checks, preventing mypy from correctly inferring that the variables cannot be None past these checks, despite the code logically ensuring that these variables are not None.

Code to Reproduce:

from typing import Optional

def init_vars(
    a: Optional[str] = None,
    b: Optional[int] = None,
    c: Optional[int] = None,
) -> None:
    if None in [a, b, c]:
        raise ValueError("a, b, and c cannot be None")
    
    # Expected: a, b, c should not be Optional types beyond this point
    # Actual: mypy still treats a, b, c as Optional types
    print(a.upper())  # mypy error: Item "None" of "Optional[str]" has no attribute "upper"
    print(b + 1)      # mypy error: Unsupported operand type(s) for +: 'int' and 'NoneType'
    print(c + 1)      # mypy error: Unsupported operand type(s) for +: 'int' and 'NoneType'

And here is another example with the all function (with any it is quite similar):

def init_vars_with_all(
    a: Optional[str] = None,
    b: Optional[int] = None,
    c: Optional[int] = None,
) -> None:
    if not all(x is not None for x in [a, b, c]):
        raise ValueError("a, b, and c cannot be None")

    # Expected: a, b, c should not be Optional types beyond this point
    # Actual: mypy still treats a, b, c as Optional types
    print(a.upper())  # mypy error: same as above
    print(b + 1)      # mypy error: same as above
    print(c + 1)      # mypy error: same as above
Expected Behavior:

After the checks if None in [a, b, c]: or using all(), mypy should refine the types of a, b, and c to str, int, and int respectively, acknowledging that they cannot be None.

Actual Behavior:

mypy does not refine the types and continues to treat a, b, and c as Optional[str], Optional[int], and Optional[int] respectively. This results in type errors when attempting to use these variables in a context that does not allow None.

Additional Information:

mypy version: 1.9.0 compiled
Python version: 3.10
No flags or configurations are altering the default behavior of mypy in this instance.

This behavior suggests a limitation in mypy's type inference system when it comes to using collective None checks with list membership or aggregate functions like any() and all(). An enhancement to allow type refinement in such cases would significantly improve usability in scenarios involving initialization checks for multiple variables.

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 with the reproducing examples for None membership and all() checks, then trace mypy's type-refinement handling for these conditional expressions. Done means the reported variables are narrowed from Optional[str] and Optional[int] after the checks, without the shown errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.