Skip to content

Revise pylint configuration (and linter choice) #1178

@lukpueh

Description

@lukpueh

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 in in-toto.

Current behavior:

  • pylintrc unnecessarily lists defaults making it hard to read/maintain
  • pylintrc does not encode our code style guidelines
  • (travis/tox automated testing does not run pylint over test code)

Expected behavior:

  1. Decide on style guidelines (Decide on style guideline #1128)
  2. Encode chosen guidelines in a new pylintrc-file (see tuf/api: Expose tuf.api as a package (take 2) #1177 for WIP preparatory work)
  3. Use new pylintrc for new code including tests
    Note: It is probably not worth fixing the potentially many linter issues in code that might not survive the upcoming refactor.
  4. (orthogonal) review and adopt other code quality tools (e.g. @trishankatdatadog has positively mentioned black and lgtm).

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions