New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add option to require a specific version to be running #2300
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -241,6 +241,14 @@ def validate_regex( | |
is_flag=True, | ||
help="If --fast given, skip temporary sanity checks. [default: --safe]", | ||
) | ||
@click.option( | ||
"--required-version", | ||
type=str, | ||
help=( | ||
"Require a specific version of Black to be running (useful for unifying results" | ||
" across many environments e.g. with a pyproject.toml file)." | ||
), | ||
) | ||
@click.option( | ||
"--include", | ||
type=str, | ||
|
@@ -351,6 +359,7 @@ def main( | |
experimental_string_processing: bool, | ||
quiet: bool, | ||
verbose: bool, | ||
required_version: str, | ||
include: Pattern, | ||
exclude: Optional[Pattern], | ||
extend_exclude: Optional[Pattern], | ||
|
@@ -360,6 +369,17 @@ def main( | |
config: Optional[str], | ||
) -> None: | ||
"""The uncompromising code formatter.""" | ||
if config and verbose: | ||
out(f"Using configuration from {config}.", bold=False, fg="blue") | ||
|
||
error_msg = "Oh no! 💥 💔 💥" | ||
if required_version and required_version != __version__: | ||
err( | ||
f"{error_msg} The required version `{required_version}` does not match" | ||
f" the running version `{__version__}`!" | ||
) | ||
ctx.exit(1) | ||
|
||
write_back = WriteBack.from_configuration(check=check, diff=diff, color=color) | ||
if target_version: | ||
versions = set(target_version) | ||
|
@@ -374,8 +394,6 @@ def main( | |
magic_trailing_comma=not skip_magic_trailing_comma, | ||
experimental_string_processing=experimental_string_processing, | ||
) | ||
if config and verbose: | ||
out(f"Using configuration from {config}.", bold=False, fg="blue") | ||
|
||
if code is not None: | ||
# Run in quiet mode by default with -c; the extra output isn't useful. | ||
|
@@ -428,9 +446,9 @@ def main( | |
) | ||
|
||
if verbose or not quiet: | ||
out("Oh no! 💥 💔 💥" if report.return_code else "All done! ✨ 🍰 ✨") | ||
out(error_msg if report.return_code else "All done! ✨ 🍰 ✨") | ||
if code is None: | ||
click.secho(str(report), err=True) | ||
click.echo(str(report), err=True) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is a bit unrelated but noticed that styling isn't used here, so I changed it. |
||
ctx.exit(report.return_code) | ||
|
||
|
||
|
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed the previous printing of config file location on fail, I think it's better to leave it to --verbose.