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.

Sign up for GitHub

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

Jump to bottom

Add Pylint as a python static code analyzer #298

Merged
merged 26 commits into from
Oct 31, 2022
Merged

Add Pylint as a python static code analyzer #298

merged 26 commits into from
Oct 31, 2022

Conversation

arm4b
Copy link
Member

@arm4b arm4b commented Sep 8, 2022 •
edited
Loading

This PR adds Pylint https://pylint.pycqa.org/en/latest/ as a static code analyser for the Python codebase, for quick spotting the common mistakes, errors and enhancing the python coding standards in a minimal automated way.

With #297, closes #271

Quick run:

pip3 install tox
tox -e pylint

arm4b and others added 12 commits September 9, 2022 13:54
@arm4b
Fix pylint R1722: use sys.exit
7b7f9b9
@arm4b
Fix pylint C0301 and C0209: usage of python f-strings and line length
ce8589a
@arm4b
Merge branch 'main' into feature/pylint
cf76ffd
@arm4b
Fix pylint W0611, C0411, C0410 import issues
e56a658 
Fix unsuded imports, import order.
Renamed entrypoint script plugins.py trying to import "plugins." module causing pylint error.
@arm4b
Merge branch 'feature/pylint' of https://github.com/bitovi/bitops int…
3b5521f 
…o feature/pylint
@arm4b
Fix python naming: pylint C0103, W0612
48f7222
@arm4b
Exclude pylint W0511,C0114 docstrings
1678f2c
@arm4b
Fix pylint: W0703, E1101 on exceptions
8f4de96
@arm4b
Fix pylint C0103, W1514: variable length, encoding
2c924ee
@arm4b
Fix pylint W1510: subprocess run check on failure
73ac90d
@arm4b
Fix pylint R1721, W0612, C0121, W0622, R1720, R1705, W4902
a46680c 
* Unnecessary use of a comprehension
* Unused variables
* singleton-comparison
* Using built-in python vars
* Unnecessary "else" after "raise"
* Unnecessary "elif" after "return"
* Using deprecated methods
@arm4b
Pytlint C0115,C0116: document python functions and classes
52da47b
@arm4b arm4b mentioned this pull request Oct 10, 2022
Merged
6 tasks
@arm4b arm4b mentioned this pull request Oct 20, 2022
Closed
@arm4b
Temporary silence pylint R0914
22f8c64 
Silence for now, refactor this function in the future.
Fix pylint R0914: Too many local variables (23/15) (too-many-locals)
See: #327
@arm4b arm4b mentioned this pull request Oct 20, 2022
Open
@arm4b
Temporary silence pylint R0914,R0912,R0915 in deploy_plugins.py
4ce4799 
Silence for now, refactor this function in the future.
> R0914: Too many local variables (36/15) (too-many-locals)
> R0912: Too many branches (19/12) (too-many-branches)
> R0915: Too many statements (104/50) (too-many-statements)

See: #328
@arm4b arm4b mentioned this pull request Oct 20, 2022
Open
@arm4b
Temporary silence pylint R0914,R0915 in install_plugins.py
aeb5718 
Silence for now, refactor this function in the future.
> R0914: Too many local variables (22/15) (too-many-locals)
> R0915: Too many statements (59/50) (too-many-statements)

See: #329
@arm4b
Reformat with black
59caf3e
@arm4b arm4b marked this pull request as ready for review October 20, 2022 17:41
@arm4b arm4b added the refactor label Oct 20, 2022
@arm4b
Copy link
Member Author

arm4b commented Oct 20, 2022

The overall cosmetic pylint refactoring is done and pylint check is now succeeding and is part of the CI.

However, some parts of the codebase will need more structural rework like extracting some huge functions into classes.
We temporary silence them for now to make pylint pass and make dedicated Issues to address them in the future:

^^ these would be also good first issues/PRs easier to tackle in between the tasks.

PhillypHenning
PhillypHenning requested changes Oct 20, 2022
View reviewed changes
scripts/plugins/doc.py Outdated Show resolved Hide resolved
scripts/plugins/settings.py Show resolved Hide resolved
scripts/plugins/settings.py Show resolved Hide resolved
scripts/plugins/utilities.py Show resolved Hide resolved
@arm4b arm4b added this to the v2.2.0 milestone Oct 31, 2022
@arm4b arm4b merged commit 1180052 into main Oct 31, 2022
@arm4b arm4b deleted the feature/pylint branch October 31, 2022 18:47
@arm4b arm4b mentioned this pull request Oct 31, 2022
Closed
2 tasks
PhillypHenning pushed a commit that referenced this pull request Nov 4, 2022
@mickmcgrath13
[WIP] closes #298 - add masking functions to be called in logger and …
d5f625e 
…directly (#345)

* add masking functions to be called in logger and directly

* black formating

* move logging masks to settings

* fix linting error

* black formating

* more linting errors
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PhillypHenning PhillypHenning PhillypHenning approved these changes

@ccapell ccapell Awaiting requested review from ccapell

@dylan-bitovi dylan-bitovi Awaiting requested review from dylan-bitovi

@mickmcgrath13 mickmcgrath13 Awaiting requested review from mickmcgrath13

Assignees
No one assigned
Labels
CI/CD feature refactor
Projects
None yet
Milestone
v2.2.0
Development

Successfully merging this pull request may close these issues.

Code Linting (Python)
2 participants
@arm4b @PhillypHenning