fix: Report attributes who lost their value as "unset"

Issue #218: #218 PR #225: #225
mkdocstrings · Nov 11, 2023 · dfffa4b · dfffa4b
1 parent 6e55f3b
commit dfffa4b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/griffe/diff.py b/src/griffe/diff.py
@@ -415,7 +415,10 @@ def _attribute_incompatibilities(old_attribute: Attribute, new_attribute: Attrib
     # if old_attribute.annotation is not None and new_attribute.annotation is not None:
     #     if not is_subhint(new_attribute.annotation, old_attribute.annotation):
     if old_attribute.value != new_attribute.value:
-        yield AttributeChangedValueBreakage(new_attribute, old_attribute.value, new_attribute.value)
+        if new_attribute.value is None:
+            yield AttributeChangedValueBreakage(new_attribute, old_attribute.value, "unset")
+        else:
+            yield AttributeChangedValueBreakage(new_attribute, old_attribute.value, new_attribute.value)
 
 
 def _alias_incompatibilities(

diff --git a/tests/test_diff.py b/tests/test_diff.py
@@ -154,6 +154,11 @@
             "def a(x): ...",
             [BreakageKind.PARAMETER_REMOVED],
         ),
+        (
+            "class a:\n\tb: int | None = None",
+            "class a:\n\tb: int",
+            [BreakageKind.ATTRIBUTE_CHANGED_VALUE],
+        ),
         (
             "def a() -> int: ...",
             "def a() -> str: ...",