remove trailing whitespace

Author: ann-marie-ward

dash/development/_py_components_generation.py

@@ -429,7 +429,7 @@ def create_prop_docstring(
         break_long_words=False,
         break_on_hyphens=False,
     )
-    description = "\n{}  ".format(description) if description else ""
+    description = "\n{}".format(description) if description else ""
     colon = ":" if description else ""
     description = fix_keywords(description)
 
@@ -450,20 +450,21 @@ def create_prop_docstring(
 
         # captures optional nested dict description and puts the "or" condition on a new line
         if "| dict with keys:" in dict_descr:
-            dict_part1, dict_part2 = dict_descr.split("|", 1)
-            dict_part1 = dict_part1 + "  "
+            dict_part1, dict_part2 = dict_descr.split(" |", 1)
             dict_part2 = "".join([desc_indent, "Or", dict_part2])
-            dict_descr = "{}   \n\n  {}".format(dict_part1, dict_part2)
+            dict_descr = "{}\n\n  {}".format(dict_part1, dict_part2)
 
         # ensures indent is correct if there is a second nested list of dicts
         current_indent = dict_descr.lstrip("\n").find("-")
-        if current_indent == len(indent_spacing) + 4:
-            dict_descr = "".join("    " + line for line in dict_descr.splitlines(True))
+        if current_indent == len(indent_spacing):
+            dict_descr = "".join(
+                "\n\n    " + line for line in dict_descr.splitlines() if line != ""
+            )
 
         return (
             "\n{indent_spacing}- {name} ({dict_or_list}; {is_required}){colon}"
-            "{description}  "
-            "\n\n{intro} {dict_descr}".format(
+            "{description}"
+            "\n\n{intro}{dict_descr}".format(
                 indent_spacing=indent_spacing,
                 name=prop_name,
                 colon=colon,
@@ -491,8 +492,8 @@ def map_js_to_py_types_prop_types(type_object, indent_num):
     """Mapping from the PropTypes js type object to the Python type."""
 
     def shape_or_exact():
-        return "dict with keys:  \n{}".format(
-            "  \n".join(
+        return "dict with keys:\n{}".format(
+            "\n".join(
                 create_prop_docstring(
                     prop_name=prop_name,
                     type_object=prop,
@@ -576,8 +577,8 @@ def map_js_to_py_types_flow_types(type_object):
             else ""
         ),
         # React's PropTypes.shape
-        signature=lambda indent_num: "dict with keys:  \n{}".format(
-            "  \n".join(
+        signature=lambda indent_num: "dict with keys:\n{}".format(
+            "\n".join(
                 create_prop_docstring(
                     prop_name=prop["key"],
                     type_object=prop["value"],

tests/unit/development/__init__.py

@@ -31,7 +31,7 @@ def has_trailing_space(s):
     "- optionalAny (boolean | number | string | dict | list; optional)",
     "",
     "- optionalArray (list; optional):",
-    "    Description of optionalArray.  ",
+    "    Description of optionalArray.",
     "",
     "- optionalArrayOf (list of numbers; optional)",
     "",
@@ -49,41 +49,41 @@ def has_trailing_space(s):
     "",
     "- optionalObjectOf (dict with strings as keys and values of type number; optional)",
     "",
-    "- optionalObjectWithExactAndNestedDescription (dict; optional)  ",
+    "- optionalObjectWithExactAndNestedDescription (dict; optional)",
     "",
-    "    `optionalObjectWithExactAndNestedDescription` is a dict with keys:   ",
+    "    `optionalObjectWithExactAndNestedDescription` is a dict with keys:",
     "",
-    "    - color (string; optional)  ",
+    "    - color (string; optional)",
     "",
     "    - figure (dict; optional):",
-    "        Figure is a plotly graph object.    ",
+    "        Figure is a plotly graph object.",
     "",
-    "        `figure` is a dict with keys:   ",
+    "        `figure` is a dict with keys:",
     "",
     "        - data (list of dicts; optional):",
-    "            data is a collection of traces.    ",
+    "            data is a collection of traces.",
     "",
     "        - layout (dict; optional):",
-    "            layout describes the rest of the figure.    ",
+    "            layout describes the rest of the figure.",
     "",
     "    - fontSize (number; optional)",
     "",
-    "- optionalObjectWithShapeAndNestedDescription (dict; optional)  ",
+    "- optionalObjectWithShapeAndNestedDescription (dict; optional)",
     "",
-    "    `optionalObjectWithShapeAndNestedDescription` is a dict with keys:   ",
+    "    `optionalObjectWithShapeAndNestedDescription` is a dict with keys:",
     "",
-    "    - color (string; optional)  ",
+    "    - color (string; optional)",
     "",
     "    - figure (dict; optional):",
-    "        Figure is a plotly graph object.    ",
+    "        Figure is a plotly graph object.",
     "",
-    "        `figure` is a dict with keys:   ",
+    "        `figure` is a dict with keys:",
     "",
     "        - data (list of dicts; optional):",
-    "            data is a collection of traces.    ",
+    "            data is a collection of traces.",
     "",
     "        - layout (dict; optional):",
-    "            layout describes the rest of the figure.    ",
+    "            layout describes the rest of the figure.",
     "",
     "    - fontSize (number; optional)",
     "",

tests/unit/development/metadata_test.py

@@ -27,7 +27,7 @@ class Table(Component):
 - optionalAny (boolean | number | string | dict | list; optional)
 
 - optionalArray (list; optional):
-    Description of optionalArray.  
+    Description of optionalArray.
 
 - optionalArrayOf (list of numbers; optional)
 
@@ -45,41 +45,41 @@ class Table(Component):
 
 - optionalObjectOf (dict with strings as keys and values of type number; optional)
 
-- optionalObjectWithExactAndNestedDescription (dict; optional)  
+- optionalObjectWithExactAndNestedDescription (dict; optional)
 
-    `optionalObjectWithExactAndNestedDescription` is a dict with keys:   
+    `optionalObjectWithExactAndNestedDescription` is a dict with keys:
 
-    - color (string; optional)  
+    - color (string; optional)
 
     - figure (dict; optional):
-        Figure is a plotly graph object.    
+        Figure is a plotly graph object.
 
-        `figure` is a dict with keys:   
+        `figure` is a dict with keys:
 
         - data (list of dicts; optional):
-            data is a collection of traces.    
+            data is a collection of traces.
 
         - layout (dict; optional):
-            layout describes the rest of the figure.    
+            layout describes the rest of the figure.
 
     - fontSize (number; optional)
 
-- optionalObjectWithShapeAndNestedDescription (dict; optional)  
+- optionalObjectWithShapeAndNestedDescription (dict; optional)
 
-    `optionalObjectWithShapeAndNestedDescription` is a dict with keys:   
+    `optionalObjectWithShapeAndNestedDescription` is a dict with keys:
 
-    - color (string; optional)  
+    - color (string; optional)
 
     - figure (dict; optional):
-        Figure is a plotly graph object.    
+        Figure is a plotly graph object.
 
-        `figure` is a dict with keys:   
+        `figure` is a dict with keys:
 
         - data (list of dicts; optional):
-            data is a collection of traces.    
+            data is a collection of traces.
 
         - layout (dict; optional):
-            layout describes the rest of the figure.    
+            layout describes the rest of the figure.
 
     - fontSize (number; optional)
 

tests/unit/development/test_flow_metadata_conversions.py

@@ -28,17 +28,17 @@
             "optionalSignature(shape)",
             "\n".join(
                 [
-                    "dict with keys:  \n",
-                    "    - checked (boolean; optional)  \n",
-                    "    - children (a list of or a singular dash component, string or number; optional)  \n",
+                    "dict with keys:\n",
+                    "    - checked (boolean; optional)\n",
+                    "    - children (a list of or a singular dash component, string or number; optional)\n",
                     "    - customData (bool | number | str | dict | list; required):\n"
-                    "        A test description.    \n",
-                    "    - disabled (boolean; optional)  \n",
-                    "    - label (string; optional)  \n",
+                    "        A test description.\n",
+                    "    - disabled (boolean; optional)\n",
+                    "    - label (string; optional)\n",
                     "    - primaryText (string; required):\n"
-                    "        Another test description.    \n",
-                    "    - secondaryText (string; optional)  \n",
-                    "    - style (dict; optional)  \n",
+                    "        Another test description.\n",
+                    "    - secondaryText (string; optional)\n",
+                    "    - style (dict; optional)\n",
                     "    - value (bool | number | str | dict | list; required)",
                 ]
             ),
@@ -47,18 +47,18 @@
             "requiredNested",
             "\n".join(
                 [
-                    "dict with keys:  \n",
-                    "    - customData (dict; required)  \n\n"
-                    "        `customData` is a dict with keys:   \n",
-                    "        - checked (boolean; optional)  \n",
-                    "        - children (a list of or a singular dash component, string or number; optional)  \n",
-                    "        - customData (bool | number | str | dict | list; required)  \n",
-                    "        - disabled (boolean; optional)  \n",
-                    "        - label (string; optional)  \n",
-                    "        - primaryText (string; required)  \n",
-                    "        - secondaryText (string; optional)  \n",
-                    "        - style (dict; optional)  \n",
-                    "        - value (bool | number | str | dict | list; required)  \n",
+                    "dict with keys:\n",
+                    "    - customData (dict; required)\n\n"
+                    "        `customData` is a dict with keys:\n",
+                    "        - checked (boolean; optional)\n",
+                    "        - children (a list of or a singular dash component, string or number; optional)\n",
+                    "        - customData (bool | number | str | dict | list; required)\n",
+                    "        - disabled (boolean; optional)\n",
+                    "        - label (string; optional)\n",
+                    "        - primaryText (string; required)\n",
+                    "        - secondaryText (string; optional)\n",
+                    "        - style (dict; optional)\n",
+                    "        - value (bool | number | str | dict | list; required)\n",
                     "    - value (bool | number | str | dict | list; required)",
                 ]
             ),
@@ -76,72 +76,72 @@
     "- optionalArray (list; optional):",
     "    An array test with a particularly  long description that covers",
     "    several lines. It includes the newline character  and should span",
-    "    3 lines in total.  ",
+    "    3 lines in total.",
     "",
     "- optionalBoolean (boolean; default False):",
-    "    A boolean test.  ",
+    "    A boolean test.",
     "",
     "- optionalNode (a list of or a singular dash component, string or number; optional):",
-    "    A node test.  ",
+    "    A node test.",
     "",
     "- optionalSignature(shape) (dict; optional):",
-    "    This is a test of an object's shape.    ",
+    "    This is a test of an object's shape.",
     "",
-    "    `optionalSignature(shape)` is a dict with keys:   ",
+    "    `optionalSignature(shape)` is a dict with keys:",
     "",
-    "    - checked (boolean; optional)  ",
+    "    - checked (boolean; optional)",
     "",
-    "    - children (a list of or a singular dash component, string or number; optional)  ",
+    "    - children (a list of or a singular dash component, string or number; optional)",
     "",
     "    - customData (bool | number | str | dict | list; required):",
-    "        A test description.    ",
+    "        A test description.",
     "",
-    "    - disabled (boolean; optional)  ",
+    "    - disabled (boolean; optional)",
     "",
-    "    - label (string; optional)  ",
+    "    - label (string; optional)",
     "",
     "    - primaryText (string; required):",
-    "        Another test description.    ",
+    "        Another test description.",
     "",
-    "    - secondaryText (string; optional)  ",
+    "    - secondaryText (string; optional)",
     "",
-    "    - style (dict; optional)  ",
+    "    - style (dict; optional)",
     "",
     "    - value (bool | number | str | dict | list; required)",
     "",
     "- optionalString (string; default ''):",
-    "    A string that isn't required.  ",
+    "    A string that isn't required.",
     "",
-    "- requiredNested (dict; required)  ",
+    "- requiredNested (dict; required)",
     "",
-    "    `requiredNested` is a dict with keys:   ",
+    "    `requiredNested` is a dict with keys:",
     "",
-    "    - customData (dict; required)  ",
+    "    - customData (dict; required)",
     "",
-    "        `customData` is a dict with keys:   ",
+    "        `customData` is a dict with keys:",
     "",
-    "        - checked (boolean; optional)  ",
+    "        - checked (boolean; optional)",
     "",
-    "        - children (a list of or a singular dash component, string or number; optional)  ",
+    "        - children (a list of or a singular dash component, string or number; optional)",
     "",
-    "        - customData (bool | number | str | dict | list; required)  ",
+    "        - customData (bool | number | str | dict | list; required)",
     "",
-    "        - disabled (boolean; optional)  ",
+    "        - disabled (boolean; optional)",
     "",
-    "        - label (string; optional)  ",
+    "        - label (string; optional)",
     "",
-    "        - primaryText (string; required)  ",
+    "        - primaryText (string; required)",
     "",
-    "        - secondaryText (string; optional)  ",
+    "        - secondaryText (string; optional)",
     "",
-    "        - style (dict; optional)  ",
+    "        - style (dict; optional)",
     "",
-    "        - value (bool | number | str | dict | list; required)  ",
+    "        - value (bool | number | str | dict | list; required)",
     "",
     "    - value (bool | number | str | dict | list; required)",
     "",
     "- requiredString (string; required):",
-    "    A required string.  ",
+    "    A required string.",
     "",
     "- requiredUnion (string | number; required)",
 ]

tests/unit/development/test_generate_class_file.py

@@ -9,7 +9,7 @@
     generate_class_string,
     generate_class_file,
 )
-from . import _dir
+from . import _dir, has_trailing_space
 
 # Import string not included in generated class string
 import_string = (
@@ -67,6 +67,7 @@ def test_class_string(expected_class_string, component_class_string):
             expected_class_string.splitlines(), component_class_string.splitlines()
         )
     )
+    assert not has_trailing_space(component_class_string)
 
 
 def test_class_file(expected_class_string, written_class_string):
@@ -75,3 +76,4 @@ def test_class_file(expected_class_string, written_class_string):
             expected_class_string.splitlines(), written_class_string.splitlines()
         )
     )
+    assert not has_trailing_space(written_class_string)