New rule in flake8-tidy-imports for banning specific function calls #16204
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kujenga
force-pushed
the
at/banned-function-rule
branch
from
31ef9e9 to
c541dea
Compare
…calls This commit introduces a new lint rule (TID254) that flags forbidden function calls, such as `os.system` and `os.popen`, in alignment with a project’s banned functions configuration. Highlights include: - Creating the `BannedFunction` rule to detect and report banned function calls. - Updating error code mappings to reference TID254. - Adding new configuration options (`banned_functions`) within `flake8_tidy_imports`. - Providing a new test fixture (`TID254.py`) and snapshot to verify detection. - Ensuring seamless integration with expression analysis in the AST checker.
kujenga
force-pushed
the
at/banned-function-rule
branch
from
c541dea to
f520766
Compare
|
MichaReiser
added
rule
|
We'll have to look into how this rule plays with the banned API rule and what happens if there are conflicting configurations or if it woudl be better to extend the existing banned api rule instead. |
|
I can definitely see that being a cleaner design! Trying to do this sort of thing with that rule, and being unable to do so, is what lead me down this path. I wasn't sure how backward compatibility might factor in with changing that one, but happy to re-work this if that seems like a better end state here! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This commit introduces a new lint rule (TID254) that flags forbidden function calls, such as
os.systemandos.popen, in alignment with a project’s banned functions configuration. Highlights include:BannedFunctionrule to detect and report banned function calls.banned_functions) withinflake8_tidy_imports.TID254.py) and snapshot to verify detection.This was requested here: #9236 and I have encountered some use cases for this as well.
While this is not technically part of the
flake8-tidy-importsmodule it seemed like the closest fit from the current set of them.n.b. I don't have a huge amount of rust experience, and this was implemented with significant assistance from llms so please let me know if anything looks off!
Test Plan
Tests were added modeled off of TID251 for banned APIs to cover a variety of cases as outlined in the test file.
I also verified this against another codebase with a release build of ruff and it seems to be working as expected.