python / python/mypy

Type narrowing and PEP 634 pattern matching

Open
#17,622 0 comments 3 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

Feature

Narrowing a type in a case block that matches the True result of a type-narrowing expression.

Pitch

Hi all- I'd be curious to hear opinions on how realistic the above would be. Here's an example of something that would work if this were implemented:

a: str | None = "hello"

match a is not None:  # or `match isinstance(a, str)`, etc.
    case True:
        print("'a' is a string", a.encode())  # currently: Item "None" of "str | None" has no attribute "encode"
    case False:
        print("'a' is None")

My "pitch" is simply that this feels like it should work (even though it makes sense to me why it doesn't). I think this feeling comes from the fact that, at least on the surface:

if thing:
    blah()
else:
    whatev()

seems morally equivalent to

match thing:
    case True:
        blah()
    case False:
        whatev()

Since I don't have any background with mypy's internals, I'm hoping to hear from the team here how feasible this all sounds.


For context, I ran into this issue when I had a type-narrowing expression embedded in a larger scrutinee (in practice, I can't imagine using match over if if the only thing I were testing was the result of a single type-narrowing expression). Specifically, I was creating a decision table of sorts, and match seemed like a nice way to do that without having to repeat tests:

content: str | bytes
is_text_format: bool

match isinstance(content, str), is_text_format:
    case True, True:
        prepped = content
    case True, False:
        prepped = content.encode("utf-8")  # type narrowing useful here
    case False, True:
        prepped = content.decode("utf-8")  # and here
    case False, False:
        prepped = content

...

I'm sure there are better ways to tackle this bool-centric example, but I think the general question stands on its own outside my original context.


Thank you for your consideration!

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 two match examples in the issue and compare their requested narrowing behavior with current mypy diagnostics. No source file, test, or entry point is identified in the issue, so locating the pattern-matching and type-narrowing implementation would be part of the work. Done means True and False case branches narrow the matched expression consistently, including tuple scrutinees.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.