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

[Feature] Add filepaths checked to verbose msg #9375

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

qequ
Copy link
Contributor

@qequ qequ commented Jan 22, 2024

Type of Changes

Type
πŸ› Bug fix
βœ“ ✨ New feature
πŸ”¨ Refactoring
πŸ“œ Docs

Description

Update the verbose output of the linter by including the filenames of the files that have been checked. Previously, the verbose output only included the count of checked and skipped files. With this change, users can now see exactly which files have been processed by the linter.

Closes #9357

This comment has been minimized.

@Pierre-Sassoulas Pierre-Sassoulas added the Enhancement ✨ Improvement to a component label Jan 22, 2024
@Pierre-Sassoulas Pierre-Sassoulas added this to the 3.1.0 milestone Jan 22, 2024
Copy link
Collaborator

@DanielNoord DanielNoord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would probably make sense to store this in _stats. The data is probably already there, we just need to print it.

I do think this is a good change though 😊

@qequ
Copy link
Contributor Author

qequ commented Jan 26, 2024

@DanielNoord I've moved the names set to the LinterStats class. Don't know if there is other way but currently the information of modules that the stats class has it's not straightforward readable. e.g. if we run pylint over a directory ex_pylint with two files ex1.py, `ex2.py the keys of by_module dict contains the files checked but also other data.

dict_keys(['/home/user/pylint/pylintrc', 'Command line', 'Command line or configuration file', 'ex_pylint', 'ex_pylint.ex1', 'ex_pylint.ex2'])

This comment has been minimized.

Copy link
Collaborator

@DanielNoord DanielNoord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Copy link
Collaborator

@DanielNoord DanielNoord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good. We know only need a changelog entry and update some failing tests.

@Pierre-Sassoulas Pierre-Sassoulas added the Waiting on author Indicate that maintainers are waiting for a message of the author label Feb 6, 2024
@Pierre-Sassoulas Pierre-Sassoulas removed this from the 3.1.0 milestone Feb 23, 2024

This comment has been minimized.

@github-actions github-actions bot added the Needs take over πŸ›ŽοΈ Orignal implementer went away but the code could be salvaged. label Apr 20, 2024
@Pierre-Sassoulas Pierre-Sassoulas removed Work in progress Waiting on author Indicate that maintainers are waiting for a message of the author labels Apr 22, 2024
@Pierre-Sassoulas Pierre-Sassoulas removed the Needs take over πŸ›ŽοΈ Orignal implementer went away but the code could be salvaged. label May 3, 2024
@Pierre-Sassoulas Pierre-Sassoulas self-assigned this May 3, 2024
@Pierre-Sassoulas Pierre-Sassoulas added this to the 3.2.0 milestone May 3, 2024

This comment has been minimized.

This comment has been minimized.

@Pierre-Sassoulas
Copy link
Member

I'm working on this, please do not merge. I don't think the verbose output should be generated AT the end but during collection instead. But there's a mess of duplication to deal with.

Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See previous comment

Copy link

codecov bot commented May 12, 2024

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 95.83%. Comparing base (3c8be8e) to head (f6d7a21).
Report is 219 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #9375      +/-   ##
==========================================
+ Coverage   95.81%   95.83%   +0.01%     
==========================================
  Files         173      174       +1     
  Lines       18825    18890      +65     
==========================================
+ Hits        18038    18104      +66     
+ Misses        787      786       -1     
Files with missing lines Coverage Ξ”
pylint/lint/pylinter.py 96.45% <100.00%> (+0.01%) ⬆️
pylint/utils/linterstats.py 98.80% <100.00%> (+<0.01%) ⬆️

... and 20 files with indirect coverage changes

Copy link
Contributor

πŸ€– According to the primer, this change has no effect on the checked open source code. πŸ€–πŸŽ‰

This comment was generated for commit f6d7a21

@Pierre-Sassoulas Pierre-Sassoulas modified the milestones: 3.2.0, 3.3.0 May 13, 2024
@DanielNoord DanielNoord removed their request for review May 17, 2024 07:24
@Pierre-Sassoulas Pierre-Sassoulas modified the milestones: 3.3.0, 3.4.0 Sep 20, 2024
@jacobtylerwalls jacobtylerwalls modified the milestones: 3.4.0, 4.0.0 Sep 25, 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Print the filepaths of checked files when the verbose option is activated
4 participants