Move Black to pre-commit #503
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arturdryomov
commented
Dec 16, 2024
| @@ -27,27 +27,30 @@ | |||
| readme = f.read() | |||
|
|
|||
| kerberos_require = ["requests_kerberos"] | |||
| gssapi_require = ["" | |||
There was a problem hiding this comment.
Not sure about the purpose of "" here. Perhaps it should be removed?
| "pytest-runner", | ||
| "pre-commit", | ||
| "black", | ||
| "isort", |
There was a problem hiding this comment.
Both isort and black are here but were never enforced. Neither were mentioned in the development documentation as well.
There was a problem hiding this comment.
might want to look at #227 for context.
The TL;DR version was:
- While standard code format is nice black often makes changes to the detriment of readability
- If we ever do this we need to figure out a way to be history preserving (probably via blame-ignore config - jvanzyl/provisio@a4cdb8d)
- black and isort running in pre-commit makes iteration slower sometimes since you are prevented from committing or running ci just because of style issues
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Moves the Black formatter from test dependencies (see comments below) to
pre-commitso it can be enforced during local workflows and CI checks as well.Release notes
This is not user-visible or docs only and no release notes are required.