Soft comparison of --required-version (#2832)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Felix Hildén <felix.hilden@gmail.com>

diff --git a/CHANGES.md b/CHANGES.md
index a840e013041d6de802f76cef9b2f95dcaee0fbe2..7d74e56ce4e194074748c5571a53fb1b42798bc5 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -5,6 +5,7 @@
 ### Configuration
 
 - Do not format `__pypackages__` directories by default (#2836)
 ### Configuration
 
 - Do not format `__pypackages__` directories by default (#2836)

+- Add support for specifying stable version with `--required-version` (#2832).

 
 ## 22.1.0
 
 
 ## 22.1.0
 

diff --git a/src/black/__init__.py b/src/black/__init__.py
index 6a703e450462220d960fa5ae7b7f6cac6a058bff..8c28b6ba18b9dfa82e2a985297d13287bd9e2779 100644 (file)
--- a/src/black/__init__.py
+++ b/src/black/__init__.py
@@ -291,7 +291,8 @@ def validate_regex(
     type=str,
     help=(
         "Require a specific version of Black to be running (useful for unifying results"
     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(
     ),
 )
 @click.option(


@@ -474,7 +475,11 @@ def main(
                 out(f"Using configuration in '{config}'.", fg="blue")
 
     error_msg = "Oh no! 💥 💔 💥"
                 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__}`!"
         err(
             f"{error_msg} The required version `{required_version}` does not match"
             f" the running version `{__version__}`!"

diff --git a/tests/test_black.py b/tests/test_black.py
index 2dd284f2cd6ed176f030e986f1aacaf13d4dc823..b04c0a66fe9e4120c69121c8fd7dbbf033dec4dd 100644 (file)
--- a/tests/test_black.py
+++ b/tests/test_black.py
@@ -1198,6 +1198,20 @@ class BlackTestCase(BlackBaseTestCase):
             ignore_config=True,
         )
 
             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,
     def test_required_version_does_not_match_version(self) -> None:
         result = BlackRunner().invoke(
             black.main,