python / python/mypy

`func-returns-value` false positive for union type?

Open
#19,433 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug topic-calls topic-union-types
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

func-returns-value seems to have an allowance for functions which themselves return None -- but not for functions which return a union with None

Bug Report

def returns_none() -> None: ...

def also_returns_none() -> None:
    return returns_none()  # ok

def also_returns_none_sometimes() -> int | None:
    return returns_none()  # E: func-returns-value

To Reproduce

(see above)

Expected Behavior

(no errors)

Actual Behavior

$ mypy t.py
t.py:7: error: "returns_none" does not return a value (it only ever returns None)  [func-returns-value]
Found 1 error in 1 file (checked 1 source file)

Your Environment

  • Mypy version used: 1.16.1
  • Mypy command-line flags: n/a
  • Mypy configuration options from mypy.ini (and other config files): n/a
  • Python version used: 3.12.3

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 report in t.py with Python 3.12.3 and run mypy t.py to confirm the diagnostic. Then trace the func-returns-value check for calls returning None versus int | None; done means the shown union-returning function produces no error while the existing diagnostic behavior remains correct.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.