python / python/mypy

Assigning a variable from either of two optional variables

Open
#11,404 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Bug Report

consider the following example:

from typing import Optional


def test_something(x: Optional[str] = None, y: Optional[str] = None) -> str:
    if not (x or y):
        return "early"

    other: str = x or y  # <<< mypy complains that other should be Optional[str]

    return other

am i not able to assume that other would be of type str given that if neither x nor y is given then the function would return early and the assignment of other would never happen? in other words, at the assignment of other, surely one or both of x or y would be of type str, therefore other would be of type str?

to further the argument, if i modify the example like so:

#!/usr/bin/env python3

from typing import Optional


def test_something(x: Optional[str] = None, y: Optional[str] = None) -> str:
    if not (x or y):
        return "early"

    other: str = x or y

    print(f"x = {x}")
    print(f"y = {y}")
    print(f"other class: {type(other)}")
    print()

    return other

test_something()
test_something(x="hello")
test_something(y="goodbye")
test_something(x="hello", y="goodbye")

and run it i get:

x = hello
y = None
other class: <class 'str'>

x = None
y = goodbye
other class: <class 'str'>

x = hello
y = goodbye
other class: <class 'str'>

To Reproduce

run mypy on the example above

Expected Behavior

mypy would not complain about typing other as str

Actual Behavior

running mypy on the above example yields:

.../test.py: note: In function "test_something":
.../test.py:8:18: error: Incompatible types in assignment (expression has type "Optional[str]", variable has type "str")  [assignment]
        other: str = x or y
                     ^
Found 1 error in 1 file (checked 1 source file)

Your Environment

  • Mypy version used: 0.910
  • Mypy command-line flags: none
  • Mypy configuration options from mypy.ini (and other config files):
strict = true
pretty = true
show_column_numbers = true
show_error_codes = true
show_error_context = true
  • Python version used: 3.7.9
  • Operating system and version: MacOSX 10.15.7 Catalina

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

Use the supplied Python reproducer as the first entry point and run mypy on the x or y assignment after the early return. Trace how this control flow is analyzed; done means the example accepts other as str without weakening the reported Optional behavior elsewhere.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.