Auto-format python code with 'black' #743
Conversation
For formatting the code.
|
I suggest excluding all files in |
With black line-length configuration for the project. Otherwise it uses 88 which is less than our project standard as checked by flake8.
Excluding the parser files which are auto-generated once upon a time possibly best left out for the moment.
We'd rather black had control over all formatting issues so we disable flake8 warnings about formatting.
|
Thanks for the review. I've changed it to leave out the parser folders for the moment. I can't clearly remember my thinking around the generated files. I believe I once wanted to be free to regenerate them but found enough issues due to either the xml or the generation script that things seemed to need to be fixed in place and that overriding them in say, subclasses, would end up duplicating a lot of the logic. That said, it has been a long time so revisiting it as a concept might be nice. |
Via the Makefile as we've done for the other checks.
|
I'm going to merge this on the basis that auto-formatters are increasingly best practice and black seems popular enough. |
This PR shows what it would look like to format the code base with black. Since using elm-format and prettier I've become a big fan of auto-formatters. Sometimes the result isn't ideal but generally you get use to it and being able to relax and just let it happen is great.
Happy to have thoughts and feedback on this.
A significant downside is that it is likely to create conflicts for any currently open branches/PRs. I would suggest we focus on merging anything that we're keen on and then reset this branch & re-run black afterwards.
Closes #736