Skip to content
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

Soft comparison of --required-version #2832

Merged
merged 10 commits into from Jan 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.md
Expand Up @@ -5,6 +5,7 @@
### Configuration

- Do not format `__pypackages__` directories by default (#2836)
- Add support for specifying stable version with `--required-version` (#2832).

## 22.1.0

Expand Down
9 changes: 7 additions & 2 deletions src/black/__init__.py
Expand Up @@ -291,7 +291,8 @@ def validate_regex(
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)."
" across many environments e.g. with a pyproject.toml file). It can be"
" either a major version number or an exact version."
),
)
@click.option(
Expand Down Expand Up @@ -474,7 +475,11 @@ def main(
out(f"Using configuration in '{config}'.", fg="blue")

error_msg = "Oh no! 💥 💔 💥"
if required_version and required_version != __version__:
if (
required_version
and required_version != __version__
and required_version != __version__.split(".")[0]
):
err(
f"{error_msg} The required version `{required_version}` does not match"
f" the running version `{__version__}`!"
Expand Down
14 changes: 14 additions & 0 deletions tests/test_black.py
Expand Up @@ -1198,6 +1198,20 @@ def test_required_version_matches_version(self) -> None:
ignore_config=True,
)

def test_required_version_matches_partial_version(self) -> None:
self.invokeBlack(
["--required-version", black.__version__.split(".")[0], "-c", "0"],
exit_code=0,
ignore_config=True,
)

def test_required_version_does_not_match_on_minor_version(self) -> None:
self.invokeBlack(
["--required-version", black.__version__.split(".")[0] + ".999", "-c", "0"],
exit_code=1,
ignore_config=True,
)

def test_required_version_does_not_match_version(self) -> None:
result = BlackRunner().invoke(
black.main,
Expand Down