Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

List of rules requiring file traversal #10143

Open
purajit opened this issue Dec 19, 2024 · 1 comment
Open

List of rules requiring file traversal #10143

purajit opened this issue Dec 19, 2024 · 1 comment

Comments

@purajit
Copy link
Contributor

purajit commented Dec 19, 2024

Question

Is there a list of all the rules pylint runs that requires file traversal, like cyclic-imports?
If not, is there a way to analyze the codebase to get that information, even if not simple? (For
instance, is there a known list of helper functions that traverse files that I can use to find all
checkers that call it?)

Essentially, I'm trying to see if I can run pylint in two ways: run pylint on only changed files
for a "quick" check, and run specifically the traversal-dependent rules on the entire repo.

Similarly, a list of rules that are known to be "heavy" (slower/requiring more CPU or memory than
average) would be very useful for the same reason.

Documentation for future user

For documentation, having annotations in https://pylint.pycqa.org/en/latest/user_guide/checkers/features.html
would be the ideal place.

This would also feature as a handy list of "issues you might miss if you don't run pylint comprehensively".

Additional context

No response

@purajit purajit added Documentation 📗 Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling Question labels Dec 19, 2024
@Pierre-Sassoulas Pierre-Sassoulas removed the Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling label Dec 19, 2024
@Pierre-Sassoulas
Copy link
Member

Thank you for opening the issue. No such option or list exist but it would indeed be useful. (Because other linter like flake8 and ruff only analyses file per file, many users are probably interested in only running pylint's multifile checks.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants