Repository navigation
Use require_serial: true as the default for our pre-commit hook, not -j1 - #95
Merged
Merged
Conversation
hugovk
approved these changes
Oct 16, 2023
Collaborator
Author
|
I'll do a patch release with this in it |
Collaborator
Author
Collaborator
Author
|
Looks like this approach is also what black does for its pre-commit hook (black being another Python tool that uses multiprocessing internally): https://github.com/psf/black-pre-commit-mirror/blob/main/.pre-commit-hooks.yaml |
4 of 5 tasks
This file contains hidden or 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
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.
Currently we have
[--jobs=1]as the default args for our pre-commit hook. This is problematic, however, as repos that overrideargsin their.pre-commit-config.yamlfiles (such as CPython) have to re-specify-j1in theirargs: the value they provide forargsoverrides the default we give here rather than extending it.This PR proposes that we don't give a default value for
args, and instead give a default value for therequire_serialkey. Testing locally, usingrequire_serial: truedoes seem to be slightly slower than using--jobs=1for me. But the difference is barely perceptible, and I think this is a big usability improvement: it means we don't have to document that, if you're overridingargsin your.pre-commit.config.yamlfile, you'll need to make sure to add--jobs=1in your override.