0.4.2 - fix the test of the docstring

Fix: The comparison of the docstring may fail because different versions of `dash` may produce docstrings in different order. Make the docstring comparison more robust.

Author: cainmagi

Changelog.md

@@ -13,6 +13,7 @@
 #### :wrench: Fix
 
 1. Fix: Improve the sanitization of the input data. Previously, the sanitization does not work correctly if the `data` is specified by `None`.
+2. Fix: The comparison of the docstring may fail because different versions of `dash` may produce docstrings in different order. Make the docstring comparison more robust.
 
 #### :floppy_disk: Change
 

dash_json_grid/__init__.py

@@ -142,15 +142,15 @@ class DashJsonGrid(_DashJsonGrid, _MixinDataRoute, _MixinFile):
 
         `loading_state` is a dict with keys:
 
-        - component_name (string; optional):
-            Holds the name of the component that is loading.
-
         - is_loading (boolean; optional):
             Determines if the component is loading or not.
 
         - prop_name (string; optional):
             Holds which property is loading.
 
+        - component_name (string; optional):
+            Holds the name of the component that is loading.
+
     - search_text (string; optional):
         The text that needs to be searched in the JSON data.
 
@@ -180,42 +180,42 @@ class DashJsonGrid(_DashJsonGrid, _MixinDataRoute, _MixinFile):
         - bgColor (string; optional):
             Background color of the whole grid view.
 
-        - booleanColor (string; optional):
-            Text color of boolean variables.
-
         - borderColor (string; optional):
             Border color of the whole grid view.
 
         - cellBorderColor (string; optional):
             Background color of table cells.
 
-        - indexColor (string; optional):
-            Text color of sequence indicies.
-
         - keyColor (string; optional):
             Text color of mapping keys.
 
+        - indexColor (string; optional):
+            Text color of sequence indicies.
+
         - numberColor (string; optional):
             Text color of numeric values.
 
-        - objectColor (string; optional):
-            Text color of unrecognized objects.
-
-        - searchHighlightBgColor (string; optional):
-            Background color of the part highlighted by the search.
-
-        - selectHighlightBgColor (string; optional):
-            Background color when this part is highlighted by the
-            selection.
+        - booleanColor (string; optional):
+            Text color of boolean variables.
 
         - stringColor (string; optional):
             Text color of strings.
 
+        - objectColor (string; optional):
+            Text color of unrecognized objects.
+
         - tableHeaderBgColor (string; optional):
             Background color of the table header.
 
         - tableIconColor (string; optional):
-            Text color of the icon in the table header."""
+            Text color of the icon in the table header.
+
+        - selectHighlightBgColor (string; optional):
+            Background color when this part is highlighted by the
+            selection.
+
+        - searchHighlightBgColor (string; optional):
+            Background color of the part highlighted by the search."""
 
 
 for _component in __all__:

tests/utils.py

@@ -20,8 +20,10 @@
 
 try:
     from typing import Sequence, Mapping
+    from typing import FrozenSet
 except ImportError:
     from collections.abc import Sequence, Mapping
+    from builtins import frozenset as FrozenSet
 
 
 from dash.testing.composite import DashComposite
@@ -82,7 +84,7 @@ def is_mapping_with_keys(val: Any, keys: Sequence[Any]) -> bool:
     return set(val.keys()) == set(keys)
 
 
-def docstring_space_remove(obj: Any) -> str:
+def docstring_space_remove(obj: Any) -> FrozenSet[str]:
     """Get the docstring of an object, with the leading/trailing spaces removed.
 
     Arguments
@@ -98,10 +100,10 @@ def docstring_space_remove(obj: Any) -> str:
     """
     doc = getattr(obj, "__doc__", None)
     if not doc:
-        return ""
+        return frozenset(("",))
     if not isinstance(doc, str):
-        return ""
-    return "".join(line.strip() for line in doc.splitlines())
+        return frozenset(("",))
+    return frozenset(line.strip() for line in doc.splitlines())
 
 
 class attribute_value_neq: