Add option to require a specific version to be running (#2300)

Closes #1246: This PR adds a new option (and automatically a toml entry, hooray for existing configuration management 🎉) to require a specific version of Black to be running.

For example: `black --required-version 20.8b -c "format = 'this'"`

Execution fails straight away if it doesn't match `__version__`.

diff --git a/CHANGES.md b/CHANGES.md
index e4fa25c90f4efa7fa045a589fcafadaeace377eb..16d9ebc3fe5fbaf50ae4e4e14c61644ff8e56894 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -7,6 +7,7 @@
 - Correct max string length calculation when there are string operators (#2292)
 - Fixed option usage when using the `--code` flag (#2259)
 - Do not call `uvloop.install()` when _Black_ is used as a library (#2303)
 - Correct max string length calculation when there are string operators (#2292)
 - Fixed option usage when using the `--code` flag (#2259)
 - Do not call `uvloop.install()` when _Black_ is used as a library (#2303)

+- Added `--required-version` option to require a specific version to be running (#2300)

 
 ## 21.5b2
 
 
 ## 21.5b2
 

diff --git a/docs/usage_and_configuration/the_basics.md b/docs/usage_and_configuration/the_basics.md
index c5e17e5a5218f26344eaa2655630138468bba339..474ad669cd10992131bcc22f58248bd6dd2574e6 100644 (file)
--- a/docs/usage_and_configuration/the_basics.md
+++ b/docs/usage_and_configuration/the_basics.md
@@ -167,7 +167,7 @@ $ black src/ -q
 error: cannot format src/black_primer/cli.py: Cannot parse: 5:6: mport asyncio
 ```
 
 error: cannot format src/black_primer/cli.py: Cannot parse: 5:6: mport asyncio
 ```
 

-### Getting the version
+### Versions

 
 You can check the version of _Black_ you have installed using the `--version` flag.
 
 
 You can check the version of _Black_ you have installed using the `--version` flag.
 


@@ -176,6 +176,19 @@ $ black --version
 black, version 21.5b0
 ```
 
 black, version 21.5b0
 ```
 

+An option to require a specific version to be running is also provided.
+
+```console
+$ black --required-version 21.5b2 -c "format = 'this'"
+format = "this"
+$ black --required-version 31.5b2 -c "still = 'beta?!'"
+Oh no! 💥 💔 💥 The required version does not match the running version!
+```
+
+This is useful for example when running _Black_ in multiple environments that haven't
+necessarily installed the correct version. This option can be set in a configuration
+file for consistent results across environments.
+

 ## Configuration via a file
 
 _Black_ is able to read project-specific default values for its command line options
 ## Configuration via a file
 
 _Black_ is able to read project-specific default values for its command line options

diff --git a/src/black/__init__.py b/src/black/__init__.py
index d95e9b13bb92b80cdab097c2ec840d4fbf13d52a..a985926afa52384d414e0073e8d7a48c11632b43 100644 (file)
--- a/src/black/__init__.py
+++ b/src/black/__init__.py
@@ -241,6 +241,14 @@ def validate_regex(
     is_flag=True,
     help="If --fast given, skip temporary sanity checks. [default: --safe]",
 )
     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,
 @click.option(
     "--include",
     type=str,


@@ -351,6 +359,7 @@ def main(
     experimental_string_processing: bool,
     quiet: bool,
     verbose: bool,
     experimental_string_processing: bool,
     quiet: bool,
     verbose: bool,

+    required_version: str,

     include: Pattern,
     exclude: Optional[Pattern],
     extend_exclude: Optional[Pattern],
     include: Pattern,
     exclude: Optional[Pattern],
     extend_exclude: Optional[Pattern],


@@ -360,6 +369,17 @@ def main(
     config: Optional[str],
 ) -> None:
     """The uncompromising code formatter."""
     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)
     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,
     )
         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.
 
     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:
             )
 
     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:
         if code is None:

-            click.secho(str(report), err=True)
+            click.echo(str(report), err=True)

     ctx.exit(report.return_code)
 
 
     ctx.exit(report.return_code)
 
 

diff --git a/tests/test_black.py b/tests/test_black.py
index f0a14aa2da4ead177d897ef9402a33ea1d0e46ea..455cb33e8276206e595ac3b8ec8d9a16fcce0ccf 100644 (file)
--- a/tests/test_black.py
+++ b/tests/test_black.py
@@ -1796,6 +1796,16 @@ class BlackTestCase(BlackBaseTestCase):
         for option in ["--include", "--exclude", "--extend-exclude", "--force-exclude"]:
             self.invokeBlack(["-", option, "**()(!!*)"], exit_code=2)
 
         for option in ["--include", "--exclude", "--extend-exclude", "--force-exclude"]:
             self.invokeBlack(["-", option, "**()(!!*)"], exit_code=2)
 

+    def test_required_version_matches_version(self) -> None:
+        self.invokeBlack(
+            ["--required-version", black.__version__], exit_code=0, ignore_config=True
+        )
+
+    def test_required_version_does_not_match_version(self) -> None:
+        self.invokeBlack(
+            ["--required-version", "20.99b"], exit_code=1, ignore_config=True
+        )
+

     def test_preserves_line_endings(self) -> None:
         with TemporaryDirectory() as workspace:
             test_file = Path(workspace) / "test.py"
     def test_preserves_line_endings(self) -> None:
         with TemporaryDirectory() as workspace:
             test_file = Path(workspace) / "test.py"