Merge pull request #64577 from Calinou/improve-dictionary-printing

Improve dictionary printing to avoid confusion with arrays

core/variant/variant.cpp

@@ -1835,11 +1835,13 @@ String Variant::stringify(int recursion_count) const {
 		case DICTIONARY: {
 			const Dictionary &d = *reinterpret_cast<const Dictionary *>(_data._mem);
 			if (recursion_count > MAX_RECURSION) {
-				ERR_PRINT("Max recursion reached");
-				return "{...}";
+				ERR_PRINT("Maximum dictionary recursion reached!");
+				return "{ ... }";
 			}
 
-			String str("{");
+			// Add leading and trailing space to Dictionary printing. This distinguishes it
+			// from array printing on fonts that have similar-looking {} and [] characters.
+			String str("{ ");
 			List<Variant> keys;
 			d.get_key_list(&keys);
 
@@ -1858,9 +1860,9 @@ String Variant::stringify(int recursion_count) const {
 				if (i > 0) {
 					str += ", ";
 				}
-				str += pairs[i].key + ":" + pairs[i].value;
+				str += pairs[i].key + ": " + pairs[i].value;
 			}
-			str += "}";
+			str += " }";
 
 			return str;
 		} break;
@@ -1894,7 +1896,7 @@ String Variant::stringify(int recursion_count) const {
 		case ARRAY: {
 			Array arr = operator Array();
 			if (recursion_count > MAX_RECURSION) {
-				ERR_PRINT("Max recursion reached");
+				ERR_PRINT("Maximum array recursion reached!");
 				return "[...]";
 			}
 

modules/gdscript/tests/scripts/parser/features/dictionary.out

@@ -7,8 +7,8 @@ null
 false
 empty array
 zero Vector2i
-{22:{4:["nesting", "arrays"]}}
-{4:["nesting", "arrays"]}
+{ 22: { 4: ["nesting", "arrays"] } }
+{ 4: ["nesting", "arrays"] }
 ["nesting", "arrays"]
 nesting
 arrays

modules/gdscript/tests/scripts/parser/features/dictionary_lua_style.out

@@ -1,2 +1,2 @@
 GDTEST_OK
-{"a":1, "b":2, "with spaces":3, "2":4}
+{ "a": 1, "b": 2, "with spaces": 3, "2": 4 }

modules/gdscript/tests/scripts/parser/features/dictionary_mixed_syntax.out

@@ -1,2 +1,2 @@
 GDTEST_OK
-{"hello":{"world":{"is":"beautiful"}}}
+{ "hello": { "world": { "is": "beautiful" } } }

modules/gdscript/tests/scripts/parser/features/nested_dictionary.out

@@ -1,5 +1,5 @@
 GDTEST_OK
-{8:{"key":"value"}}
-{"key":"value"}
+{ 8: { "key": "value" } }
+{ "key": "value" }
 value
 value

modules/gdscript/tests/scripts/runtime/features/chain_assignment_works.out

@@ -1,6 +1,6 @@
 GDTEST_OK
-{1:(2, 0)}
-{3:(4, 0)}
+{ 1: (2, 0) }
+{ 3: (4, 0) }
 [[(5, 0)]]
 [[(6, 0)]]
 [[(7, 0)]]

modules/gdscript/tests/scripts/runtime/features/stringify.out

@@ -21,7 +21,7 @@ hello/world
 RID(0)
 Node::get_name
 Node::[signal]property_list_changed
-{"hello":123}
+{ "hello": 123 }
 ["hello", 123]
 [255, 0, 1]
 [-1, 0, 1]