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

Print the filepaths of checked files when the verbose option is activated #9357

Open
Kristinita opened this issue Jan 11, 2024 · 0 comments · May be fixed by #9375
Open

Print the filepaths of checked files when the verbose option is activated #9357

Kristinita opened this issue Jan 11, 2024 · 0 comments · May be fixed by #9375
Labels
Enhancement ✨ Improvement to a component Good first issue Friendly and approachable by new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation
Milestone

Comments

@Kristinita
Copy link

Kristinita commented Jan 11, 2024

1. Summary

It would be nice if Pylint would print the filepaths of the files it checked to the console. This can be implemented, for example, by adding:

  1. The desired behavior if the user uses a CLI argument --verbose
  2. A new CLI argument, with a name like --print-filepaths

If requested behavior is already possible, please add to the documentation what needs to be done to get it.

2. Example of desired behavior

The same as implemented, for example, in pydocstyle:

# [INFO] No pydocstyle output if all docstrings in all files are valid
pydocstyle .

# [INFO] Print filepaths all checked files if “--verbose” argument enabled
pydocstyle . --verbose

Checking file .\pelicanconf.py.
Checking file .\pelican_settings_loader.py.
Checking file .\publishconf.py.
Checking file .\jinja_filters\jinja_filter_all.py.
Checking file .\jinja_filters\jinja_filter_any.py.
Checking file .\personal-plugins\autotitle\autotitle.py.
Checking file .\personal-plugins\autotitle\__init__.py.
Checking file .\personal-plugins\putkiry\putkiry.py.
Checking file .\personal-plugins\putkiry\__init__.py.

3. Reasons why the feature is needed

  1. Checking whether the user has configured Pylint options ignore, ignore-paths and ignore-patterns correctly.
  2. Checking that Pylint actually checks all files necessary for the user. For example, earlier Pylint don’t supported analyzing directories with no __init__ files in them. Pylint may not analyze some directories/files, but the user may not understand this.

4. Not helped

I couldn’t find how I can get the desired behavior in:

  1. “Pylint output” page of Pylint documentation
  2. pylintrc example on this repository
  3. Google. I found a 2017 answer on Stack Overflow, “This currently isn’t possible” to a similar question.

Thanks.

@Pierre-Sassoulas Pierre-Sassoulas added Enhancement ✨ Improvement to a component Needs PR This issue is accepted, sufficiently specified and now needs an implementation Good first issue Friendly and approachable by new contributors labels Jan 11, 2024
@Pierre-Sassoulas Pierre-Sassoulas changed the title question/feature request(report): print filepaths of checked files Print the filepaths of checked files when the verbose option is activated Jan 11, 2024
@qequ qequ linked a pull request Jan 22, 2024 that will close this issue
@Pierre-Sassoulas Pierre-Sassoulas added this to the 3.1.0 milestone Jan 22, 2024
@Pierre-Sassoulas Pierre-Sassoulas removed this from the 3.1.0 milestone Feb 23, 2024
@Pierre-Sassoulas Pierre-Sassoulas added this to the 3.2.0 milestone May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement ✨ Improvement to a component Good first issue Friendly and approachable by new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants