Merge pull request #1026 from syrupy-project/rename_methods

refactor: remove incorrect private underscore prefix from public methods

Author: noahnu

README.md

@@ -135,6 +135,7 @@ These are the cli options exposed to `pytest` by the plugin.
 | `--snapshot-patch-pycharm-diff`| Override PyCharm's default diffs viewer when looking at snapshot diffs. See [IDE Integrations](#ide-integrations)        | `False`                                                                                                      |
 | `--snapshot-diff-mode` | Configures how diffs are displayed on assertion failure. If working with very large snapshots, disabling the diff can improve performance. | `detailed` |
 | `--snapshot-ignore-file-extensions` | Comma separated list of file extensions to ignore when walking the file tree and discovering used/unused snapshots. | No extensions are ignored by default. |
+| `--snapshot-dirname` | Directory name to store snapshots in. | `__snapshots__` |
 
 ### Assertion Options
 

src/syrupy/__init__.py

@@ -11,6 +11,8 @@
 
 import pytest
 
+from syrupy.extensions.base import SnapshotCollectionStorage
+
 from .assertion import DiffMode, SnapshotAssertion
 from .constants import DISABLE_COLOR_ENV_VAR
 from .exceptions import FailedToLoadModuleMember
@@ -108,6 +110,12 @@ def pytest_addoption(parser: "pytest.Parser") -> None:
         help="Comma separated list of file extensions to ignore when discovering snapshots",
         type=lambda v: v.split(","),
     )
+    group.addoption(
+        "--snapshot-dirname",
+        dest="snapshot_dirname",
+        default="__snapshots__",
+        help="Directory name to use to store snapshots",
+    )
 
 
 def __terminal_color(
@@ -161,6 +169,10 @@ def pytest_sessionstart(session: Any) -> None:
     Initialize snapshot session before tests are collected and ran.
     https://docs.pytest.org/en/latest/reference.html#_pytest.hookspec.pytest_sessionstart
     """
+
+    # Override the snapshot dirname in the base SnapshotCollectionStorage class with the pytest config.
+    SnapshotCollectionStorage.snapshot_dirname = session.config.option.snapshot_dirname
+
     session.config._syrupy = SnapshotSession(
         pytest_session=session,
         ignore_file_extensions=session.config.option.ignore_file_extensions,

src/syrupy/constants.py

@@ -1,6 +1,5 @@
-SNAPSHOT_DIRNAME = "__snapshots__"
-SNAPSHOT_EMPTY_FOSSIL_KEY = "empty snapshot collection"
-SNAPSHOT_UNKNOWN_FOSSIL_KEY = "unknown snapshot collection"
+SNAPSHOT_EMPTY_COLLECTION_KEY = "empty snapshot collection"
+SNAPSHOT_UNKNOWN_COLLECTION_KEY = "unknown snapshot collection"
 
 EXIT_STATUS_FAIL_UNUSED = 1
 

src/syrupy/data.py

@@ -9,8 +9,8 @@
 )
 
 from .constants import (
-    SNAPSHOT_EMPTY_FOSSIL_KEY,
-    SNAPSHOT_UNKNOWN_FOSSIL_KEY,
+    SNAPSHOT_EMPTY_COLLECTION_KEY,
+    SNAPSHOT_UNKNOWN_COLLECTION_KEY,
 )
 
 if TYPE_CHECKING:
@@ -27,12 +27,12 @@ class Snapshot:
 
 @dataclass(frozen=True)
 class SnapshotEmpty(Snapshot):
-    name: str = SNAPSHOT_EMPTY_FOSSIL_KEY
+    name: str = SNAPSHOT_EMPTY_COLLECTION_KEY
 
 
 @dataclass(frozen=True)
 class SnapshotUnknown(Snapshot):
-    name: str = SNAPSHOT_UNKNOWN_FOSSIL_KEY
+    name: str = SNAPSHOT_UNKNOWN_COLLECTION_KEY
 
 
 @dataclass
@@ -54,8 +54,8 @@ def get(self, snapshot_name: str) -> Optional["Snapshot"]:
 
     def add(self, snapshot: "Snapshot") -> None:
         self._snapshots[snapshot.name] = snapshot
-        if snapshot.name != SNAPSHOT_EMPTY_FOSSIL_KEY:
-            self.remove(SNAPSHOT_EMPTY_FOSSIL_KEY)
+        if snapshot.name != SNAPSHOT_EMPTY_COLLECTION_KEY:
+            self.remove(SNAPSHOT_EMPTY_COLLECTION_KEY)
 
     def merge(self, snapshot_collection: "SnapshotCollection") -> None:
         for snapshot in snapshot_collection:

src/syrupy/extensions/amber/__init__.py

@@ -24,7 +24,7 @@ class AmberSnapshotExtension(AbstractSyrupyExtension):
     An amber snapshot file stores data in the following format:
     """
 
-    _file_extension = "ambr"
+    file_extension = "ambr"
 
     serializer_class: type["AmberDataSerializer"] = AmberDataSerializer
 
@@ -47,7 +47,7 @@ def delete_snapshots(
         else:
             Path(snapshot_location).unlink()
 
-    def _read_snapshot_collection(self, snapshot_location: str) -> "SnapshotCollection":
+    def read_snapshot_collection(self, snapshot_location: str) -> "SnapshotCollection":
         return self.serializer_class.read_file(snapshot_location)
 
     @classmethod
@@ -57,7 +57,7 @@ def __cacheable_read_snapshot(
     ) -> "SnapshotCollection":
         return cls.serializer_class.read_file(snapshot_location)
 
-    def _read_snapshot_data_from_location(
+    def read_snapshot_data_from_location(
         self, snapshot_location: str, snapshot_name: str, session_id: str
     ) -> Optional["SerializableData"]:
         snapshots = self.__cacheable_read_snapshot(
@@ -71,7 +71,7 @@ def _read_snapshot_data_from_location(
         return data
 
     @classmethod
-    def _write_snapshot_collection(
+    def write_snapshot_collection(
         cls, *, snapshot_collection: "SnapshotCollection"
     ) -> None:
         cls.serializer_class.write_file(snapshot_collection, merge=True)

src/syrupy/extensions/amber/serializer.py

@@ -39,7 +39,7 @@
     IterableEntries = tuple[
         Iterable["PropertyName"],
         "PropertyValueGetter",
-        "PropertyValueFilter" | None,
+        "PropertyValueFilter | None",
     ]
 
 
@@ -100,7 +100,7 @@ class Marker:
         Divider = "---"
 
     @classmethod
-    def _snapshot_sort_key(cls, snapshot: "Snapshot") -> Any:
+    def snapshot_sort_key(cls, snapshot: "Snapshot") -> Any:
         return snapshot.name
 
     @classmethod
@@ -120,7 +120,7 @@ def write_file(
             f.write(f"{cls._marker_prefix}{cls.Marker.Version}: {cls.VERSION}\n")
             for snapshot in sorted(
                 snapshot_collection,
-                key=cls._snapshot_sort_key,  # noqa: E501
+                key=cls.snapshot_sort_key,  # noqa: E501
             ):
                 snapshot_data = str(snapshot.data)
                 if snapshot_data is not None:
@@ -518,5 +518,5 @@ def __maybe_int(cls, part: str) -> tuple[int, str | int]:
             return (0, part)
 
     @classmethod
-    def _snapshot_sort_key(cls, snapshot: "Snapshot") -> Any:
+    def snapshot_sort_key(cls, snapshot: "Snapshot") -> Any:
         return [cls.__maybe_int(part) for part in snapshot.name.split(".")]

src/syrupy/extensions/base.py

@@ -14,7 +14,6 @@
 
 from syrupy.constants import (
     DISABLE_COLOR_ENV_VAR,
-    SNAPSHOT_DIRNAME,
     SYMBOL_CARRIAGE,
     SYMBOL_ELLIPSIS,
     SYMBOL_NEW_LINE,
@@ -71,7 +70,8 @@ def serialize(
 
 
 class SnapshotCollectionStorage(ABC):
-    _file_extension = ""
+    snapshot_dirname: str | Path = "__snapshots__"
+    file_extension = ""
 
     @classmethod
     def get_snapshot_name(
@@ -90,8 +90,8 @@ def get_location(
         cls, *, test_location: "PyTestLocation", index: "SnapshotIndex"
     ) -> str:
         """Returns full filepath where snapshot data is stored."""
-        basename = cls._get_file_basename(test_location=test_location, index=index)
-        fileext = f".{cls._file_extension}" if cls._file_extension else ""
+        basename = cls.get_file_basename(test_location=test_location, index=index)
+        fileext = f".{cls.file_extension}" if cls.file_extension else ""
         return str(
             Path(cls.dirname(test_location=test_location)).joinpath(
                 f"{basename}{fileext}"
@@ -100,7 +100,7 @@ def get_location(
 
     def is_snapshot_location(self, *, location: str) -> bool:
         """Checks if supplied location is valid for this snapshot extension"""
-        return location.endswith(self._file_extension)
+        return location.endswith(self.file_extension)
 
     def discover_snapshots(
         self,
@@ -117,7 +117,7 @@ def discover_snapshots(
             ignore_extensions=ignore_extensions,
         ):
             if self.is_snapshot_location(location=filepath):
-                snapshot_collection = self._read_snapshot_collection(
+                snapshot_collection = self.read_snapshot_collection(
                     snapshot_location=filepath
                 )
                 if not snapshot_collection.has_snapshots:
@@ -138,11 +138,11 @@ def read_snapshot(
     ) -> "SerializedData":
         """
         This method is _final_, do not override. You can override
-        `_read_snapshot_data_from_location` in a subclass to change behaviour.
+        `read_snapshot_data_from_location` in a subclass to change behaviour.
         """
         snapshot_location = self.get_location(test_location=test_location, index=index)
         snapshot_name = self.get_snapshot_name(test_location=test_location, index=index)
-        snapshot_data = self._read_snapshot_data_from_location(
+        snapshot_data = self.read_snapshot_data_from_location(
             snapshot_location=snapshot_location,
             snapshot_name=snapshot_name,
             session_id=session_id,
@@ -160,7 +160,7 @@ def write_snapshot(
     ) -> None:
         """
         This method is _final_, do not override. You can override
-        `_write_snapshot_collection` in a subclass to change behaviour.
+        `write_snapshot_collection` in a subclass to change behaviour.
         """
         if not snapshots:
             return
@@ -203,7 +203,7 @@ def write_snapshot(
         # Ensures the folder path for the snapshot file exists.
         Path(snapshot_location).parent.mkdir(parents=True, exist_ok=True)
 
-        cls._write_snapshot_collection(snapshot_collection=snapshot_collection)
+        cls.write_snapshot_collection(snapshot_collection=snapshot_collection)
 
     @abstractmethod
     def delete_snapshots(
@@ -216,7 +216,7 @@ def delete_snapshots(
         raise NotImplementedError
 
     @abstractmethod
-    def _read_snapshot_collection(
+    def read_snapshot_collection(
         self, *, snapshot_location: str
     ) -> "SnapshotCollection":
         """
@@ -225,7 +225,7 @@ def _read_snapshot_collection(
         raise NotImplementedError
 
     @abstractmethod
-    def _read_snapshot_data_from_location(
+    def read_snapshot_data_from_location(
         self, *, snapshot_location: str, snapshot_name: str, session_id: str
     ) -> Optional["SerializedData"]:
         """
@@ -235,7 +235,7 @@ def _read_snapshot_data_from_location(
 
     @classmethod
     @abstractmethod
-    def _write_snapshot_collection(
+    def write_snapshot_collection(
         cls, *, snapshot_collection: "SnapshotCollection"
     ) -> None:
         """
@@ -246,10 +246,10 @@ def _write_snapshot_collection(
     @classmethod
     def dirname(cls, *, test_location: "PyTestLocation") -> str:
         test_dir = Path(test_location.filepath).parent
-        return str(test_dir.joinpath(SNAPSHOT_DIRNAME))
+        return str(test_dir.joinpath(cls.snapshot_dirname))
 
     @classmethod
-    def _get_file_basename(
+    def get_file_basename(
         cls, *, test_location: "PyTestLocation", index: "SnapshotIndex"
     ) -> str:
         """Returns file basename without extension. Used to create full filepath."""

src/syrupy/extensions/image.py

@@ -12,11 +12,11 @@
 
 
 class PNGImageSnapshotExtension(SingleFileSnapshotExtension):
-    _file_extension = "png"
+    file_extension = "png"
 
 
 class SVGImageSnapshotExtension(SingleFileSnapshotExtension):
-    _file_extension = "svg"
+    file_extension = "svg"
 
     def serialize(self, data: "SerializableData", **kwargs: Any) -> bytes:
         return str(data).encode(TEXT_ENCODING)

src/syrupy/extensions/json/__init__.py

@@ -34,7 +34,7 @@
 class JSONSnapshotExtension(SingleFileSnapshotExtension):
     _max_depth: int = 99
     _write_mode = WriteMode.TEXT
-    _file_extension = "json"
+    file_extension = "json"
 
     @classmethod
     def sort(cls, iterable: Iterable[Any]) -> Iterable[Any]:

src/syrupy/extensions/single_file.py

@@ -40,7 +40,7 @@ def __str__(self) -> str:
 class SingleFileSnapshotExtension(AbstractSyrupyExtension):
     _text_encoding = TEXT_ENCODING
     _write_mode = WriteMode.BINARY
-    _file_extension = "raw"
+    file_extension = "raw"
 
     def serialize(
         self,
@@ -78,7 +78,7 @@ def delete_snapshots(
         Path(snapshot_location).unlink()
 
     @classmethod
-    def _get_file_basename(
+    def get_file_basename(
         cls, *, test_location: "PyTestLocation", index: "SnapshotIndex"
     ) -> str:
         return cls.get_snapshot_name(test_location=test_location, index=index)
@@ -88,18 +88,18 @@ def dirname(cls, *, test_location: "PyTestLocation") -> str:
         original_dirname = AbstractSyrupyExtension.dirname(test_location=test_location)
         return str(Path(original_dirname).joinpath(test_location.basename))
 
-    def _read_snapshot_collection(
+    def read_snapshot_collection(
         self, *, snapshot_location: str
     ) -> "SnapshotCollection":
-        file_ext_len = len(self._file_extension) + 1 if self._file_extension else 0
+        file_ext_len = len(self.file_extension) + 1 if self.file_extension else 0
         filename_wo_ext = snapshot_location[:-file_ext_len]
         basename = Path(filename_wo_ext).parts[-1]
 
         snapshot_collection = SnapshotCollection(location=snapshot_location)
         snapshot_collection.add(Snapshot(name=basename))
         return snapshot_collection
 
-    def _read_snapshot_data_from_location(
+    def read_snapshot_data_from_location(
         self, *, snapshot_location: str, snapshot_name: str, session_id: str
     ) -> Optional["SerializableData"]:
         try:
@@ -125,7 +125,7 @@ def get_write_encoding(cls) -> str | None:
         return None
 
     @classmethod
-    def _write_snapshot_collection(
+    def write_snapshot_collection(
         cls, *, snapshot_collection: "SnapshotCollection"
     ) -> None:
         filepath, data = (
@@ -148,7 +148,7 @@ def _write_snapshot_collection(
 
     @classmethod
     def __clean_filename(cls, filename: str) -> str:
-        max_filename_length = 255 - len(cls._file_extension or "")
+        max_filename_length = 255 - len(cls.file_extension or "")
         exclude_chars = '\\/?*:|"<>'
         exclude_categ = ("C",)
         cleaned_filename = "".join(
@@ -161,7 +161,7 @@ def __clean_filename(cls, filename: str) -> str:
 
 
 class SingleFileAmberSnapshotExtension(SingleFileSnapshotExtension):
-    _file_extension = "ambr"
+    file_extension = "ambr"
     _write_mode = WriteMode.TEXT
 
     def serialize(
@@ -176,7 +176,7 @@ def serialize(
             data, exclude=exclude, include=include, matcher=matcher
         )
 
-    def _read_snapshot_data_from_location(
+    def read_snapshot_data_from_location(
         self, *, snapshot_location: str, snapshot_name: str, session_id: str
     ) -> Optional["SerializableData"]:
         snapshot_collection = AmberDataSerializer.read_file(snapshot_location)
@@ -193,7 +193,7 @@ def _read_snapshot_data_from_location(
         return snapshot.data
 
     @classmethod
-    def _write_snapshot_collection(
+    def write_snapshot_collection(
         cls, *, snapshot_collection: "SnapshotCollection"
     ) -> None:
         AmberDataSerializer.write_file(snapshot_collection, merge=False)