Formatting with black

[mostafa]

@thomaspatzke

I suggest black for formatting the entire codebase. Is it opinionated, yet produces visually clean code. Note that running black on the codebase kinda wipes the git history.

WDYT?

[thomaspatzke]

The git history argument kept me from doing this, but it doesn't seems to be 100% valid anymore, at least not for git blame, which is the most important, I believe.

On the other side I'm really annoyed by myself that I use different coding styles depending on mood and planet constellations 🤣

I think I will give it a try. What do you think about gray? Could be a soft move, but I think it's more a compromise.

[mostafa]

I just heard about gray and it seems interesting. It look much like golangci-lint. Yet, git-blame natively supports ignoring the history of certain commits, as already mentioned in black docs. From the looks of it, we have two options:

1. Using Git-blame with blame.ignoreRevsFile set, that can be used to ignore certain revision in the history and it receives a .git-blame-ignore-revs files that must contain commit SHAs. Apparently, GitHub added support for the feature back in 2022, which was in beta, but is now available to everyone. It is documented here.
2. Using Git-black, which does the same thing in a different way.

I personally think that black leaves no room for errors, yet gray is backed by powerful QA tools. Either way, I can make a PR to see if the git-blame-history-feature actually works.

[mostafa]

@thomaspatzke

I created a PR to fix this. I also added pre-commit hooks to run black before committing code locally.

[thomaspatzke]

Invaluable knowledge if you try to rebase/merge larger changes after reformatting was committed.

[mostafa]

I suppose this can be closed now. Thanks for merging it.