-
Notifications
You must be signed in to change notification settings - Fork 275
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
Revise pylint configuration (and linter choice) #1178
Comments
#1294 suggests our current Tox configuration is not correctly linting the new code (in tuf/api/), even though we have a Pylint statement in Tox and a minimal configuration file for the new style. |
tox is linting the code but I noticed that different pylint versions produce different warnings with current rc file. I'll comment #1294 now back to this ticket, It made sense to align to default configuration, now if there is a need to enforce custom ones , may I suggest that we progressively pick and adapt relevant lines from generated template: |
Thanks for chiming in, @rzr!
Yes, that's a great idea! Same should go for adopting the rules in the code. See e.g. https://github.com/in-toto/in-toto/pull/296/commits, where I grouped changes by rule and commit, which IMO makes review a lot easier. Regarding #1294 (comment) ...
No, not at all! :) I have planned to work on this in the near future, but I'd definitely appreciate help. (cc @fepitre + in-toto/apt-transport-in-toto#36 (comment)) Please note that both revised linter and auto-formatter config should align with our new python style guide. |
Fixed in #1314 and follow up PRs, we now use a minimally configured |
Description of issue or feature request:
TUF uses a
pylint
config file that seems to have been copied in verbatim from PyCQA/pylint, listing all defaults explicitly, and adding only a few customizations, which neither fully encode our current style guidelines, nor the style guidelines we plan to adopt (~TBD) for new code.Note: The same issue exists in
securesystemslib
, and existed but was fixed inin-toto
.Current behavior:
pylintrc
unnecessarily lists defaults making it hard to read/maintainpylintrc
does not encode our code style guidelinespylint
over test code)Expected behavior:
pylintrc
-file (see tuf/api: Expose tuf.api as a package (take 2) #1177 for WIP preparatory work)pylintrc
for new code including testsNote: It is probably not worth fixing the potentially many linter issues in code that might not survive the upcoming refactor.
black
andlgtm
).The text was updated successfully, but these errors were encountered: