Merge pull request #282 from 15r10nk/declare-unmanaged

feat: exposed declare_unmanaged

Author: 15r10nk

changelog.d/20250805_075651_15r10nk-git_declare_unmanaged.md

@@ -0,0 +1,41 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+For top level release notes, leave all the headers commented out.
+-->
+
+<!--
+### Removed
+
+- A bullet item for the Removed category.
+
+-->
+### Added
+
+- exposed `@declare_unmanaged` which allows you to create your own unmanaged types.
+
+<!--
+### Changed
+
+- A bullet item for the Changed category.
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category.
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed category.
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security category.
+
+-->

docs/eq_snapshot.md

@@ -58,6 +58,31 @@ These types are:
 * [snapshots](#inner-snapshots) inside snapshots and
 * [f-strings](#f-strings).
 
+You can also create your own unmanaged types with `@declare_unmanaged`
+
+<!-- inline-snapshot: create fix first_block outcome-passed=1 -->
+``` python
+from inline_snapshot import declare_unmanaged, snapshot
+
+
+@declare_unmanaged
+class AllEqual:
+    def __init__(self, value):
+        self.value = value
+
+    def __eq__(self, other):
+        return all(o == self.value for o in other)
+
+
+def test_all_equal():
+    assert {"text": "hello", "values": [1, 1, 1]} == snapshot(
+        {"text": "hello", "values": AllEqual(snapshot(1))}
+    )
+```
+
+You have to put `AllEqual` manually into the snapshot and inline-snapshot will not touch it in the future when it has to fix the code, but it will change the value in the snapshot argument of `AllEqual`, because this is another snapshot.
+This allows you to specify what should be under your control and which code should be controlled and changed by inline-snapshot.
+
 inline-snapshot is able to handle these types within the following containers:
 
 * list

src/inline_snapshot/__init__.py

@@ -14,6 +14,7 @@
 from ._is import Is
 from ._types import Category
 from ._types import Snapshot
+from ._unmanaged import declare_unmanaged
 
 __all__ = [
     "snapshot",
@@ -31,6 +32,7 @@
     "TextDiff",
     "BinaryDiff",
     "external_file",
+    "declare_unmanaged",
 ]
 
 __version__ = "0.26.0"