Add option to require a specific version to be running

CHANGES.md

@@ -6,6 +6,7 @@
 
 - Correct max string length calculation when there are string operators (#2292)
 - Fixed option usage when using the `--code` flag (#2259)
+- Add `--revision` option to require a specific version to be running (#2300)
 
 ## 21.5b2
 

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
 ```
 
-### Getting the version
+### Versions
 
 You can check the version of _Black_ you have installed using the `--version` flag.
 
@@ -176,6 +176,19 @@ $ black --version
 black, version 21.5b0
 ```
 
+An option to requiring a specific version to be running is also provided.
+
+```console
+$ black --revision 21.5b2 -c "format = 'this'"
+format = "this"
+$ black --revision 31.5b2 -c "still = 'beta?!'"
+Oh no! 💥 💔 💥 The required revision 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. Setting this option can be done 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

src/black/__init__.py

@@ -249,6 +249,14 @@ def validate_regex(
     is_flag=True,
     help="If --fast given, skip temporary sanity checks. [default: --safe]",
 )
+@click.option(
+    "--revision",
+    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,
@@ -359,6 +367,7 @@ def main(
     experimental_string_processing: bool,
     quiet: bool,
     verbose: bool,
+    revision: str,
     include: Pattern,
     exclude: Optional[Pattern],
     extend_exclude: Optional[Pattern],
@@ -368,6 +377,17 @@ def main(
     config: Optional[str],
 ) -> None:
     """The uncompromising code formatter."""
+    error_msg = "Oh no! 💥 💔 💥"
+    if revision and revision != __version__:
+        msg = (
+            f"{error_msg} The required revision `{revision}` does not match"
+            f" the running version `{__version__}`!"
+        )
+        if ctx.default_map and revision == ctx.default_map.get("revision", None):
+            msg += f"\n(configuration read from `{config}`)"
+        err(msg)
+        ctx.exit(1)
+
     write_back = WriteBack.from_configuration(check=check, diff=diff, color=color)
     if target_version:
         versions = set(target_version)
@@ -436,9 +456,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)
     ctx.exit(report.return_code)
 
 

tests/test_black.py

@@ -1796,6 +1796,14 @@ def test_invalid_cli_regex(self) -> None:
         for option in ["--include", "--exclude", "--extend-exclude", "--force-exclude"]:
             self.invokeBlack(["-", option, "**()(!!*)"], exit_code=2)
 
+    def test_revision_matches_version(self) -> None:
+        self.invokeBlack(
+            ["--revision", black.__version__], exit_code=0, ignore_config=True
+        )
+
+    def test_revision_does_not_match_version(self) -> None:
+        self.invokeBlack(["--revision", "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"