python / python/mypy

Warn that annotations could be if TYPE_CHECKING

Open
#11,129 1 comment 1 reaction 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

Would it be possible to get mypy to list all imports that are only used for annotations that are not in an if TYPE_CHECKING check?

It would be very useful to cleanup imports and head off potential circular import issues coming from annotation imports.

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

No files, tests, or entry points are named. Start by locating how mypy analyzes imports used only in annotations and how diagnostics are configured; done means a warning can list imports that are not guarded by TYPE_CHECKING, with tests covering the intended cases.

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
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.