RedHatInsights/insights-host-inventory

Ultimately fix code formatting

Glutexo opened this issue · 2 comments

The code is a formatting mess. Virtually every Python file is formatted completely randomly, only remotely adhering to PEP 8.

@jhjaggars suggested using Black, which is a reasonable choice. It’d be nice to use a linter to block pull requests from being merged, but as first step, we can at least:

  • Reformat existing code.
  • Don’t push unformatted code any more.
  • Don’t approve unformatted pull requests.

The first bullet point is the only one doable immediately to close this issue. I am aware that this would break all pull requests. Let’s take advantage of the fact that there are not many of them pending at the moment.

Side note: automate all the things. Run the linter and do not let through unformatted code. That sounds nice, but this should be a part of a whole CI bot running tests and stuff on every PR. But that doesn’t mean, we can’t spin up a simple linter before the bigger thing happens.

One more side note: Reformatting all the code may not be that catastrophic for the existing pull requests. If the same reformatting would be done on them, virtually all the conflicts should be resolved.