import-outside-top-level (PLC0415) is incompatible with flake8-tidy-imports.banned-module-level-imports #12803
Description
Reframed issue:
import-outside-top-level (PLC0415) and banned-module-level-imports (TID253) are incompatible together.
ruff.toml
[lint]
preview = true
extend-select = [
"TID253", # banned-module-level-imports, see banned-module-level-imports below
"PLC0415", # import-outside-top-level
]
[lint.flake8-tidy-imports]
# Modules we want setuptools to be able to work without requiring
banned-module-level-imports = [
"ctypes", # see #4461 for example
"typing_extensions", # Useful for development, shouldn't be required at runtime
# platform-specific imports
"winreg",
]Code:
import winreg # raises TID253
def win_only_method():
import winreg # raises PLC0415
print(winreg)Original issue
- List of keywords you searched for before creating this issue. Write them down here so that others can find this issue more easily and help provide feedback.
PLC0415, top level module import, banned api - The current Ruff version (
ruff --version): ruff 0.5.5
I came across a use-case where it would be preferable to check that certain imports are never imported directly at the module level. This is mainly for dependencies that should stay optional, or that are known to be be ostly and only useful in specific codepaths.
For example, setuptools could configure ctypes, typing_extensions, and more, to ensure that they're never unconditionally imported.
A check that the import is behind a conditional (if-else, try-except) or in a function, should be sufficient.
This is similar in idea to the https://docs.astral.sh/ruff/rules/#flake8-type-checking-tch (TCH001, TCH002, TCH003) rules.
This would conflict with https://docs.astral.sh/ruff/rules/import-outside-top-level/ (PLC0415). My original idea was to suggest an ignore list for PLC0415, but I think this could be pushed further with a rule that actually enforces it.
If this idea is rejected, I'd still like an ignore/allowlist for PLC0415 .