Shall we Black our Codebase?

tethysplatform / tethys

The Tethys Platform main Django website project repository.

http://tethysplatform.org/

BSD 2-Clause "Simplified" License

94 stars 51 forks source link

Shall we Black our Codebase? #876

Closed swainn closed 2 years ago

swainn commented 2 years ago

This PR includes the following:

Run Black Python code formatter on Tethys codebase
Update Flake8 configuration per Black recommendations
Enable the Black GitHub action in our CI (see below)

Note: as a side-effect of this change, the max line-length was changed to a soft 88 characters.

It's probably not prudent to look at every file in this PR (since it is pretty much every file in the repo), but it is useful to look at code you are familiar with to see how the formatting was changed.

sdc50 commented 2 years ago

@swainn I agree with most of the changes that Black makes. I think it sometimes makes things less readable (i.e. removing blank lines in the controller decorator signature, but I'm willing to live with a few disagreements.

coveralls commented 2 years ago

Coverage remained the same at 100.0% when pulling 0a2a7d6ff3eb21f3049a099949bba1bbe7396863 on blackify into 41bc27733d88794a5c2ab861a46de26f4e9b04eb on main.