fix magic comma and experimental string cache flags (#2131)

* fix magic comma and experimental string cache flags

* more changelog

* Update CHANGES.md

Co-authored-by: Cooper Lees <me@cooperlees.com>
* fix tests

Co-authored-by: Cooper Lees <me@cooperlees.com>

diff --git a/CHANGES.md b/CHANGES.md
index e313a44474d87fb79631608baa08e5e2c9070c08..aa08396e49196111a5876e926c4a96ae45a7b51a 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -1,5 +1,13 @@
 ## Change Log
 
 ## Change Log
 

+### Unreleased
+
+#### _Black_
+
+- Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
+  in the name of the cache file. Without this fix, changes in these flags would not take
+  effect if the cache had already been populated. (#2131)
+

 ### 21.4b0
 
 #### _Black_
 ### 21.4b0
 
 #### _Black_

diff --git a/src/black/__init__.py b/src/black/__init__.py
index 08267d50f89c3b50dec0e08d62e0cd9cc28ecf0e..00d3729c8354496812f9250d1f6f6f5530572cbe 100644 (file)
--- a/src/black/__init__.py
+++ b/src/black/__init__.py
@@ -273,9 +273,9 @@ class Mode:
     target_versions: Set[TargetVersion] = field(default_factory=set)
     line_length: int = DEFAULT_LINE_LENGTH
     string_normalization: bool = True
     target_versions: Set[TargetVersion] = field(default_factory=set)
     line_length: int = DEFAULT_LINE_LENGTH
     string_normalization: bool = True

+    is_pyi: bool = False

     magic_trailing_comma: bool = True
     experimental_string_processing: bool = False
     magic_trailing_comma: bool = True
     experimental_string_processing: bool = False

-    is_pyi: bool = False

 
     def get_cache_key(self) -> str:
         if self.target_versions:
 
     def get_cache_key(self) -> str:
         if self.target_versions:


@@ -290,6 +290,8 @@ class Mode:
             str(self.line_length),
             str(int(self.string_normalization)),
             str(int(self.is_pyi)),
             str(self.line_length),
             str(int(self.string_normalization)),
             str(int(self.is_pyi)),

+            str(int(self.magic_trailing_comma)),
+            str(int(self.experimental_string_processing)),

         ]
         return ".".join(parts)
 
         ]
         return ".".join(parts)
 

diff --git a/tests/test_black.py b/tests/test_black.py
index 8733b7a63ad092a4f0f16a17283b33e9ccebb8c2..88ea31777fbb4142753f916d97bae74e2c6a26b6 100644 (file)
--- a/tests/test_black.py
+++ b/tests/test_black.py
@@ -379,11 +379,12 @@ class BlackTestCase(BlackBaseTestCase):
     @patch("black.dump_to_file", dump_to_stderr)
     def test_string_quotes(self) -> None:
         source, expected = read_data("string_quotes")
     @patch("black.dump_to_file", dump_to_stderr)
     def test_string_quotes(self) -> None:
         source, expected = read_data("string_quotes")

-        actual = fs(source)
+        mode = black.Mode(experimental_string_processing=True)
+        actual = fs(source, mode=mode)

         self.assertFormatEqual(expected, actual)
         black.assert_equivalent(source, actual)
         self.assertFormatEqual(expected, actual)
         black.assert_equivalent(source, actual)

-        black.assert_stable(source, actual, DEFAULT_MODE)
-        mode = replace(DEFAULT_MODE, string_normalization=False)
+        black.assert_stable(source, actual, mode)
+        mode = replace(mode, string_normalization=False)

         not_normalized = fs(source, mode=mode)
         self.assertFormatEqual(source.replace("\\\n", ""), not_normalized)
         black.assert_equivalent(source, not_normalized)
         not_normalized = fs(source, mode=mode)
         self.assertFormatEqual(source.replace("\\\n", ""), not_normalized)
         black.assert_equivalent(source, not_normalized)

diff --git a/tests/test_format.py b/tests/test_format.py
index eabec8c72191b634c4ae1ddbba9a443ead8c9de9..e1335aedf43411e9247a7d7f933deae4f56aa62c 100644 (file)
--- a/tests/test_format.py
+++ b/tests/test_format.py
@@ -16,7 +16,6 @@ from tests.util import (
 SIMPLE_CASES = [
     "beginning_backslash",
     "bracketmatch",
 SIMPLE_CASES = [
     "beginning_backslash",
     "bracketmatch",

-    "cantfit",

     "class_blank_parentheses",
     "class_methods_new_line",
     "collections",
     "class_blank_parentheses",
     "class_methods_new_line",
     "collections",


@@ -26,7 +25,6 @@ SIMPLE_CASES = [
     "comments4",
     "comments5",
     "comments6",
     "comments4",
     "comments5",
     "comments6",

-    "comments7",

     "comments_non_breaking_space",
     "comment_after_escaped_newline",
     "composition",
     "comments_non_breaking_space",
     "comment_after_escaped_newline",
     "composition",


@@ -48,11 +46,7 @@ SIMPLE_CASES = [
     "function2",
     "function_trailing_comma",
     "import_spacing",
     "function2",
     "function_trailing_comma",
     "import_spacing",

-    "long_strings",
-    "long_strings__edge_case",
-    "long_strings__regression",

     "numeric_literals_py2",
     "numeric_literals_py2",

-    "percent_precedence",

     "python2",
     "python2_unicode_literals",
     "remove_parens",
     "python2",
     "python2_unicode_literals",
     "remove_parens",


@@ -62,6 +56,15 @@ SIMPLE_CASES = [
     "tupleassign",
 ]
 
     "tupleassign",
 ]
 

+EXPERIMENTAL_STRING_PROCESSING_CASES = [
+    "cantfit",
+    "comments7",
+    "long_strings",
+    "long_strings__edge_case",
+    "long_strings__regression",
+    "percent_precedence",
+]
+

 
 SOURCES = [
     "tests/test_black.py",
 
 SOURCES = [
     "tests/test_black.py",


@@ -86,19 +89,23 @@ class TestSimpleFormat(BlackBaseTestCase):
     @parameterized.expand(SIMPLE_CASES)
     @patch("black.dump_to_file", dump_to_stderr)
     def test_simple_format(self, filename: str) -> None:
     @parameterized.expand(SIMPLE_CASES)
     @patch("black.dump_to_file", dump_to_stderr)
     def test_simple_format(self, filename: str) -> None:

-        source, expected = read_data(filename)
-        actual = fs(source)
-        self.assertFormatEqual(expected, actual)
-        black.assert_equivalent(source, actual)
-        black.assert_stable(source, actual, DEFAULT_MODE)
+        self.check_file(filename, DEFAULT_MODE)
+
+    @parameterized.expand(EXPERIMENTAL_STRING_PROCESSING_CASES)
+    @patch("black.dump_to_file", dump_to_stderr)
+    def test_experimental_format(self, filename: str) -> None:
+        self.check_file(filename, black.Mode(experimental_string_processing=True))

 
     @parameterized.expand(SOURCES)
     @patch("black.dump_to_file", dump_to_stderr)
     def test_source_is_formatted(self, filename: str) -> None:
         path = THIS_DIR.parent / filename
 
     @parameterized.expand(SOURCES)
     @patch("black.dump_to_file", dump_to_stderr)
     def test_source_is_formatted(self, filename: str) -> None:
         path = THIS_DIR.parent / filename

-        source, expected = read_data(str(path), data=False)
-        actual = fs(source, mode=DEFAULT_MODE)
+        self.check_file(str(path), DEFAULT_MODE, data=False)
+        self.assertFalse(ff(path))
+
+    def check_file(self, filename: str, mode: black.Mode, *, data: bool = True) -> None:
+        source, expected = read_data(filename, data=data)
+        actual = fs(source, mode=mode)

         self.assertFormatEqual(expected, actual)
         black.assert_equivalent(source, actual)
         self.assertFormatEqual(expected, actual)
         black.assert_equivalent(source, actual)

-        black.assert_stable(source, actual, DEFAULT_MODE)
-        self.assertFalse(ff(path))
+        black.assert_stable(source, actual, mode)

diff --git a/tests/util.py b/tests/util.py
index da65ed0cc931ef00c71aab999c8b56fe750dd4fa..ad9866975acfdffcd3407dcba7e9209b94918021 100644 (file)
--- a/tests/util.py
+++ b/tests/util.py
@@ -12,7 +12,7 @@ EMPTY_LINE = "# EMPTY LINE WITH WHITESPACE" + " (this comment will be removed)"
 DETERMINISTIC_HEADER = "[Deterministic header]"
 
 
 DETERMINISTIC_HEADER = "[Deterministic header]"
 
 

-DEFAULT_MODE = black.FileMode(experimental_string_processing=True)
+DEFAULT_MODE = black.Mode()

 ff = partial(black.format_file_in_place, mode=DEFAULT_MODE, fast=True)
 fs = partial(black.format_str, mode=DEFAULT_MODE)
 
 ff = partial(black.format_file_in_place, mode=DEFAULT_MODE, fast=True)
 fs = partial(black.format_str, mode=DEFAULT_MODE)