chosen by the user.
"""
+from hashlib import sha256
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 warnings import warn
if sys.version_info < (3, 8):
from typing_extensions import Final
class Preview(Enum):
"""Individual preview style features."""
+ string_processing = auto()
+
+
+class Deprecated(UserWarning):
+ """Visible deprecation warning."""
+
@dataclass
class Mode:
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
+ 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.
The argument is not checked and features are not differentiated.
They only exist to make development easier by clarifying intent.
"""
- return self.preview
+ if feature is Preview.string_processing:
+ return self.preview or self.experimental_string_processing
+ # TODO: Remove type ignore comment once preview contains more features
+ # than just ESP
+ return self.preview # type: ignore
def get_cache_key(self) -> str:
if self.target_versions:
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)