Update FAQ: Mention formatting of custom jupyter cell magic (#2982)

[etc/vim.git] / src / black / mode.py

diff --git a/src/black/mode.py b/src/black/mode.py
index c8c2bd4eb26b36bf2b7626e5cf0b5be83a9fc41a..6b74c14b6de42063f3c2555a068767a4461cd9bb 100644 (file)
--- a/src/black/mode.py
+++ b/src/black/mode.py
@@ -4,12 +4,14 @@ Mostly around Python language feature support per version and Black configuratio
 chosen by the user.
 """
 
 chosen by the user.
 """
 

+from hashlib import sha256

 import sys
 
 from dataclasses import dataclass, field
 import sys
 
 from dataclasses import dataclass, field

-from enum import Enum
+from enum import Enum, auto

 from operator import attrgetter
 from typing import Dict, Set
 from operator import attrgetter
 from typing import Dict, Set

+from warnings import warn

 
 if sys.version_info < (3, 8):
     from typing_extensions import Final
 
 if sys.version_info < (3, 8):
     from typing_extensions import Final


@@ -124,6 +126,14 @@ def supports_feature(target_versions: Set[TargetVersion], feature: Feature) -> b
 class Preview(Enum):
     """Individual preview style features."""
 
 class Preview(Enum):
     """Individual preview style features."""
 

+    string_processing = auto()
+    remove_redundant_parens = auto()
+    one_element_subscript = auto()
+
+
+class Deprecated(UserWarning):
+    """Visible deprecation warning."""
+

 
 @dataclass
 class Mode:
 
 @dataclass
 class Mode:


@@ -134,8 +144,17 @@ class Mode:
     is_ipynb: bool = False
     magic_trailing_comma: bool = True
     experimental_string_processing: bool = False
     is_ipynb: bool = False
     magic_trailing_comma: bool = True
     experimental_string_processing: bool = False

+    python_cell_magics: Set[str] = field(default_factory=set)

     preview: bool = False
 
     preview: bool = False
 

+    def __post_init__(self) -> None:
+        if self.experimental_string_processing:
+            warn(
+                "`experimental string processing` has been included in `preview`"
+                " and deprecated. Use `preview` instead.",
+                Deprecated,
+            )
+

     def __contains__(self, feature: Preview) -> bool:
         """
         Provide `Preview.FEATURE in Mode` syntax that mirrors the ``preview`` flag.
     def __contains__(self, feature: Preview) -> bool:
         """
         Provide `Preview.FEATURE in Mode` syntax that mirrors the ``preview`` flag.


@@ -143,6 +162,8 @@ class Mode:
         The argument is not checked and features are not differentiated.
         They only exist to make development easier by clarifying intent.
         """
         The argument is not checked and features are not differentiated.
         They only exist to make development easier by clarifying intent.
         """

+        if feature is Preview.string_processing:
+            return self.preview or self.experimental_string_processing

         return self.preview
 
     def get_cache_key(self) -> str:
         return self.preview
 
     def get_cache_key(self) -> str:


@@ -162,5 +183,6 @@ class Mode:
             str(int(self.magic_trailing_comma)),
             str(int(self.experimental_string_processing)),
             str(int(self.preview)),
             str(int(self.magic_trailing_comma)),
             str(int(self.experimental_string_processing)),
             str(int(self.preview)),

+            sha256((",".join(sorted(self.python_cell_magics))).encode()).hexdigest(),

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