When to use typing.TYPE_CHECKING
When to use typing.TYPE_CHECKING
After learning about TYPE_CHECKING i made it a habit to put all imports that were only needed for type checking into an if TYPE_CHECKING: guard. But now I am wondering if that is actually intended to be used like that. Checking whether an import is only needed at type checking time can get quite tedious and sometimes you run into situations were you introduced some code that made the import a requirement at runtime.
How do you use TYPE_CHECKING? Whenever it is possible or only when using it actually solves a circular import?
I don’t like having to quote the types, so I use it exclusively for avoiding circular imports.
Why not use
from __future__ import annotations?Never heard of it. Thanks for the tip.
from __future__ import annotationsThanks for the tip
You still need to import the type before using it in a stringified type annotation for it to be valid though, so you'd need the import in an
if TYPE_CHECKING:block either way, no?
I only use it to avoid circular imports. Otherwise, I can import the type plainly.
That's a very cool feature, had no clue about it!
If it doesn't have any visible downsides, it's be nice use it whenever possible. This should provide the additional benefit of having the imports clearly separated.
The tediousness aspect of it makes me wonder though. I'd probably just only use it when I'm specifically importing something only for typing .
Maybe could be a cool feature request for an lsp as well.
Any time you need different behavior between static type checking and runtime.
in 3.10 I’m using it to work around issue with NamedTuple generics. typing_extensions.NamedTuple allows Generics at runtime but typing.NamedTuple doesn’t. But the type checker we are using doesn’t support typing_extensions.NamedTuple like it does for the typing version so we lie at type checking time to get the typing to make sense but have different runtime type because otherwise its a TypeError
A cheeky answer: whenever Ruff/flake8-type-checking tells me to. Though I'd only enable that check now that there's an autofix in Ruff as well.
You should have part of your test harness perform a separate import of every module. If your module is idempotent (most good code is) you could do this in a single process by cleaning
sys.modulesI guess ... but it still won't be part of yourpytestprocess.Static analyzers can only detect some cases, so can't be fully trusted.
I've also found there are a lot of cases where performant Python code has to be implemented in a distinct way from what the type-checker sees. You can do this with aggressive
type: ignorebut I often find it cleaner to use separateifblocks.