gdharness 1.3.42 → 1.3.44

package/build/godot/operations/classdb_queries.gd

@@ -3,10 +3,8 @@ extends RefCounted
 const GdhRead = preload("reading.gd")
 const GdhLog = preload("logger.gd")
 const GdhSerialisation = preload("serialisation.gd")
-
 # How far below the closest name another may score and still be offered beside it.
 const CLOSE_TO_THE_BEST: float = 0.2
-
 # The base classes each category name stands for. Kept to the list the tool's schema offers, which
 # a case holds: the schema offered physics3d and ui, which this refused, and physics answered the 3D
 # bodies alone beside physics2d and physics3d.
@@ -74,7 +72,9 @@ func query_classes(params: Dictionary) -> Dictionary:
 	if not category.is_empty():
 		bases = CATEGORY_BASES.get(category.to_lower(), [])
 		if bases.is_empty():
-			return _log.failure("Unknown category: " + category + ". Valid: " + str(CATEGORY_BASES.keys()))
+			return _log.failure(
+				"Unknown category: " + category + ". Valid: " + str(CATEGORY_BASES.keys())
+			)
 
 	var all_classes: PackedStringArray = ClassDB.get_class_list()
 	all_classes.sort()
@@ -107,7 +107,13 @@ func query_classes(params: Dictionary) -> Dictionary:
 		own.append(_project_entry(name, declared))
 
 	_log.info(
-		"Found " + str(filtered_classes.size()) + " classes (out of " + str(all_classes.size()) + " total)"
+		(
+			"Found "
+			+ str(filtered_classes.size())
+			+ " classes (out of "
+			+ str(all_classes.size())
+			+ " total)"
+		)
 	)
 
 	return {
@@ -127,7 +133,13 @@ func query_class_info(params: Dictionary) -> Dictionary:
 	var include_inherited: bool = GdhRead.as_bool(params.get("include_inherited", false))
 
 	_log.info(
-		"Querying class info for: " + class_name_str + " (include_inherited: " + str(include_inherited) + ")"
+		(
+			"Querying class info for: "
+			+ class_name_str
+			+ " (include_inherited: "
+			+ str(include_inherited)
+			+ ")"
+		)
 	)
 
 	if not ClassDB.class_exists(class_name_str):
@@ -171,7 +183,7 @@ func query_class_info(params: Dictionary) -> Dictionary:
 		"properties": properties,
 		"signals_count": signals.size(),
 		"signals": signals,
-		"enums": enums
+		"enums": enums,
 	}
 	if include_inherited:
 		answer["inherited"] = _inherited_names(class_name_str)
@@ -283,24 +295,28 @@ static func _project_entry(name: String, declared: Dictionary) -> Dictionary:
 
 ## Why [param wanted] has no answer here. A class_name a project script declares is not in ClassDB,
 ## and "Class not found" for one read as though the project had no such class. [param declared] is
-## what the project's scripts declare on disk, class to path, rather than the engine's list, which is
-## the class cache: that lags the scripts, and a class written a moment ago was refused as declared
-## nowhere.
+## what the project's scripts declare on disk, class to path, rather than the engine's list, which
+## is the class cache: that lags the scripts, and a class written a moment ago was refused as
+## declared nowhere.
 func _not_found(wanted: String, declared: Dictionary, answers_own: bool = false) -> Dictionary:
 	if declared.has(wanted):
-		return _log.failure(
-			(
+		return (
+			_log
+			. failure(
 				(
-					"%s is not an engine class: it is the class_name %s declares, and editor_classes reads "
-					+ "the engine's ClassDB only. script_info structure on that script, with "
-					+ "includeInherited, answers what it declares and what it inherits."
+					(
+						"%s is not an engine class: it is the class_name %s declares, and "
+						+ "editor_classes reads the engine's ClassDB only. script_info structure "
+						+ "on that script, with includeInherited, answers what it declares and "
+						+ "what it inherits."
+					)
+					% [wanted, str(_entry_of(wanted, declared).get("path", ""))]
 				)
-				% [wanted, str(_entry_of(wanted, declared).get("path", ""))]
 			)
 		)
-	# The usual miss is a spelling, one letter off a class the engine has or one the project declares.
-	# Ranked as one pool and kept near the best, since a project class a letter off came behind three
-	# engine classes that shared only "Texture" with it.
+	# The usual miss is a spelling, one letter off a class the engine has or one the project
+	# declares. Ranked as one pool and kept near the best, since a project class a letter off came
+	# behind three engine classes that shared only "Texture" with it.
 	var pool: PackedStringArray = ClassDB.get_class_list()
 	pool.append_array(PackedStringArray(declared.keys()))
 	var close: PackedStringArray = GdhRead.nearest(wanted, pool)
@@ -310,8 +326,9 @@ func _not_found(wanted: String, declared: Dictionary, answers_own: bool = false)
 	for name: String in close:
 		if name.to_lower().similarity(wanted.to_lower()) < best - CLOSE_TO_THE_BEST:
 			continue
-		# Similarity counts shared letter pairs, so a word the two names share passes it: NoSuchClass
-		# was offered ClassDB. A spelling is a few letters off, a swap of two among them.
+		# Similarity counts shared letter pairs, so a word the two names share passes it:
+		# NoSuchClass was offered ClassDB. A spelling is a few letters off, a swap of two among
+		# them.
 		if _edits(name.to_lower(), wanted.to_lower()) > maxi(2, floori(wanted.length() / 3.0)):
 			continue
 		if declared.has(name):
@@ -338,15 +355,22 @@ func _not_found(wanted: String, declared: Dictionary, answers_own: bool = false)
 		)
 	if answers_own:
 		return _log.failure(
-			"Class not found: %s.%s Neither the engine nor a project script declares it." % [wanted, offered]
+			(
+				"Class not found: %s.%s Neither the engine nor a project script declares it."
+				% [wanted, offered]
+			)
 		)
-	return _log.failure(
-		(
+	return (
+		_log
+		. failure(
 			(
-				"Class not found: %s.%s editor_classes reads the engine's ClassDB, so a class_name a "
-				+ "project script declares is not in it either; script_info structure reads one."
+				(
+					"Class not found: %s.%s editor_classes reads the engine's ClassDB, so a "
+					+ "class_name a project script declares is not in it either; script_info "
+					+ "structure reads one."
+				)
+				% [wanted, offered]
 			)
-			% [wanted, offered]
 		)
 	)
 
@@ -358,7 +382,9 @@ static func _edits(from: String, to: String) -> int:
 		var here: PackedInt32Array = PackedInt32Array([row])
 		for column: int in range(1, to.length() + 1):
 			var changed: int = above[column - 1] + (0 if from[row - 1] == to[column - 1] else 1)
-			var _added: bool = here.append(mini(changed, mini(above[column] + 1, here[column - 1] + 1)))
+			var _added: bool = here.append(
+				mini(changed, mini(above[column] + 1, here[column - 1] + 1))
+			)
 		above = here
 	return above[to.length()]
 
@@ -376,39 +402,49 @@ func _member_of(class_name_str: String, member: String) -> Dictionary:
 	while not current.is_empty():
 		for m: Dictionary in _methods_of(current):
 			if m["name"] == member:
-				found.append({"kind": "method", "declared_in": current, "member": m})
+				found.append({ "kind": "method", "declared_in": current, "member": m })
 		for p: Dictionary in _properties_of(current):
 			if p["name"] == member:
-				found.append({"kind": "property", "declared_in": current, "member": p})
+				found.append({ "kind": "property", "declared_in": current, "member": p })
 		for s: Dictionary in _signals_of(current):
 			if s["name"] == member:
-				found.append({"kind": "signal", "declared_in": current, "member": s})
+				found.append({ "kind": "signal", "declared_in": current, "member": s })
 		for e: String in ClassDB.class_get_enum_list(current, true):
 			if e == member:
 				var values: Dictionary = {}
 				for c: String in ClassDB.class_get_enum_constants(current, e, true):
 					values[c] = ClassDB.class_get_integer_constant(current, c)
 				found.append(
-					{"kind": "enum", "declared_in": current, "member": {"name": e, "values": values}}
+					{
+						"kind": "enum",
+						"declared_in": current,
+						"member": { "name": e, "values": values },
+					}
 				)
 		for c: String in ClassDB.class_get_integer_constant_list(current, true):
 			if c == member:
 				var value: int = ClassDB.class_get_integer_constant(current, c)
 				found.append(
-					{"kind": "constant", "declared_in": current, "member": {"name": c, "value": value}}
+					{
+						"kind": "constant",
+						"declared_in": current,
+						"member": { "name": c, "value": value },
+					}
 				)
 		current = ClassDB.get_parent_class(current)
 
 	if found.is_empty():
 		var alike: Array[String] = _members_alike(class_name_str, member)
 		var hint: String = (
-			"" if alike.is_empty() else " Members with names containing it: " + ", ".join(alike) + "."
+			""
+			if alike.is_empty()
+			else " Members with names containing it: " + ", ".join(alike) + "."
 		)
 		return _log.failure(
 			"%s and its ancestors declare no member named %s.%s" % [class_name_str, member, hint]
 		)
 
-	return {"class_name": class_name_str, "member": member, "found": found}
+	return { "class_name": class_name_str, "member": member, "found": found }
 
 
 # The names, across a class and its ancestors, that contain the asked-for one, case-insensitively.
@@ -531,7 +567,7 @@ func _methods_of(class_name_str: String) -> Array[Dictionary]:
 					"type": a.get("type", 0),
 					"type_name": _type_name(a, "Variant"),
 					"class_name": a.get("class_name", ""),
-					"hint_string": a.get("hint_string", "")
+					"hint_string": a.get("hint_string", ""),
 				}
 			)
 		var return_info: Dictionary = m.get("return", {})
@@ -545,13 +581,14 @@ func _methods_of(class_name_str: String) -> Array[Dictionary]:
 					{
 						"type": return_info.get("type", 0),
 						"type_name": _type_name(return_info, "void"),
-						"class_name": return_info.get("class_name", "")
+						"class_name": return_info.get("class_name", ""),
 					},
 					"flags": m.get("flags", 0),
 					"flag_names": _flag_names(GdhRead.as_int(m.get("flags", 0))),
-					# As values, tagged the way every other answer tags one: JSON writes a Vector2i it is
-					# handed as its text, so TileMapLayer.set_cell's default atlas coords read "(-1, -1)".
-					"default_args": _values.serialize_value(m.get("default_args", []))
+					# As values, tagged the way every other answer tags one: JSON writes a Vector2i
+					# it is handed as its text, so TileMapLayer.set_cell's default atlas coords read
+					# "(-1, -1)".
+					"default_args": _values.serialize_value(m.get("default_args", [])),
 				}
 			)
 		)
@@ -579,7 +616,11 @@ static func _type_name(info: Dictionary, nil_name: String) -> String:
 	if type == TYPE_OBJECT and not named.is_empty():
 		return named
 	if type == TYPE_NIL:
-		return "Variant" if GdhRead.as_int(info.get("usage", 0)) & PROPERTY_USAGE_NIL_IS_VARIANT else nil_name
+		return (
+			"Variant"
+			if GdhRead.as_int(info.get("usage", 0)) & PROPERTY_USAGE_NIL_IS_VARIANT
+			else nil_name
+		)
 	return type_string(type)
 
 
@@ -589,7 +630,11 @@ func _properties_of(class_name_str: String) -> Array[Dictionary]:
 	for p: Dictionary in ClassDB.class_get_property_list(class_name_str, true):
 		# A category, group or subgroup is an editor heading rather than a property.
 		var usage: int = GdhRead.as_int(p.get("usage", 0))
-		if usage & PROPERTY_USAGE_CATEGORY or usage & PROPERTY_USAGE_GROUP or usage & PROPERTY_USAGE_SUBGROUP:
+		if (
+			usage & PROPERTY_USAGE_CATEGORY
+			or usage & PROPERTY_USAGE_GROUP
+			or usage & PROPERTY_USAGE_SUBGROUP
+		):
 			continue
 		properties.append(
 			{
@@ -599,7 +644,7 @@ func _properties_of(class_name_str: String) -> Array[Dictionary]:
 				"class_name": p.get("class_name", ""),
 				"hint": p.get("hint", 0),
 				"hint_string": p.get("hint_string", ""),
-				"usage": usage
+				"usage": usage,
 			}
 		)
 
@@ -618,9 +663,9 @@ func _signals_of(class_name_str: String) -> Array[Dictionary]:
 					"name": a.get("name", ""),
 					"type": a.get("type", 0),
 					"type_name": _type_name(a, "Variant"),
-					"class_name": a.get("class_name", "")
+					"class_name": a.get("class_name", ""),
 				}
 			)
-		signals.append({"name": s.get("name", ""), "args": sig_args})
+		signals.append({ "name": s.get("name", ""), "args": sig_args })
 
 	return signals

package/build/godot/operations/declared_values.gd

@@ -1,11 +1,9 @@
 @tool
 extends RefCounted
-
 ## What a property declares beyond its type: the values of its enum and the range it is exported
 ## with, for taking a value by name and for saying when a value written lies outside them.
 
 const GdhRead = preload("reading.gd")
-
 ## The section of layer_names in project.godot naming the layers of each layers hint.
 const LAYER_NAMES: Dictionary[int, String] = {
 	PROPERTY_HINT_LAYERS_2D_PHYSICS: "2d_physics",
@@ -27,7 +25,7 @@ static func layers_in(hint: int, mask: int) -> Array[Dictionary]:
 	for layer: int in range(1, MASK_LAYERS + 1):
 		if mask & (1 << (layer - 1)) == 0:
 			continue
-		var entry: Dictionary = {"layer": layer}
+		var entry: Dictionary = { "layer": layer }
 		var name: String = str(
 			ProjectSettings.get_setting("layer_names/%s/layer_%d" % [LAYER_NAMES[hint], layer], "")
 		)
@@ -119,10 +117,12 @@ static func engine_constants(target: Object, property: String) -> Dictionary:
 ## names by it, as [true, number], or [false, why] naming the values, with [param holder] naming the
 ## target in the refusal. [false, ""] for a word that is a number, which converts as one.
 ##
-## An enum is written by the name of a value as well as its number, since the name is what the script
-## and the inspector show and the number is only where the value happens to sit. Tried as the script
-## spells it, then as the hint does, then as the engine's constant.
-static func enum_by_name(target: Object, declared: Dictionary, word: String, holder: String) -> Array:
+## An enum is written by the name of a value as well as its number, since the name is what the
+## script and the inspector show and the number is only where the value happens to sit. Tried as the
+## script spells it, then as the hint does, then as the engine's constant.
+static func enum_by_name(
+	target: Object, declared: Dictionary, word: String, holder: String
+) -> Array:
 	var property: String = str(declared.get("name", ""))
 	var choices: Dictionary = enum_of(target, declared)
 	var chosen: Variant = enum_named(choices, word)
@@ -144,7 +144,9 @@ static func enum_refusal(
 ) -> String:
 	var ways: String = "by name or by number"
 	if not constants.is_empty():
-		ways = "by name, by number or by the engine's constant, such as %s" % str(constants.keys()[0])
+		ways = (
+			"by name, by number or by the engine's constant, such as %s" % str(constants.keys()[0])
+		)
 	var said: String = (
 		"%s.%s is an enum, and %s is none of its values: send %s %s"
 		% [holder, property, word, _listed(choices), ways]
@@ -163,7 +165,10 @@ static func enum_argument_refusal(
 	called: String, index: int, named: String, word: String, choices: Dictionary
 ) -> String:
 	var said: String = (
-		"%s takes the enum %s as argument %d, and %s is none of its values: send %s by name or by number"
+		(
+			"%s takes the enum %s as argument %d, and %s is none of its values: send %s by name or "
+			+ "by number"
+		)
 		% [called, named, index + 1, word, _listed(choices)]
 	)
 	var close: PackedStringArray = GdhRead.nearest(word, PackedStringArray(choices.keys()))
@@ -174,7 +179,9 @@ static func enum_argument_refusal(
 
 ## Why [param value], given as argument [param index] for the enum [param named], is none of its
 ## [param choices], or "" when it is one. The engine passes any number on.
-static func outside_enum_argument(index: int, named: String, value: Variant, choices: Dictionary) -> String:
+static func outside_enum_argument(
+	index: int, named: String, value: Variant, choices: Dictionary
+) -> String:
 	if typeof(value) != TYPE_INT or choices.values().has(value):
 		return ""
 	return (
@@ -235,7 +242,10 @@ static func outside(target: Object, declared: Dictionary, value: Variant, shown:
 	var hint: int = GdhRead.as_int(declared.get("hint", PROPERTY_HINT_NONE))
 	var hint_string: String = str(declared.get("hint_string", ""))
 	var property: String = str(declared.get("name", ""))
-	if hint == PROPERTY_HINT_ENUM and (typeof(value) == TYPE_STRING or typeof(value) == TYPE_STRING_NAME):
+	if (
+		hint == PROPERTY_HINT_ENUM
+		and (typeof(value) == TYPE_STRING or typeof(value) == TYPE_STRING_NAME)
+	):
 		var names: PackedStringArray = PackedStringArray(enum_values(hint_string).keys())
 		if names.is_empty() or names.has(str(value)):
 			return ""
@@ -308,15 +318,17 @@ static func _listed(choices: Dictionary) -> String:
 	return ", ".join(listed)
 
 
-## A range's end as the script wrote it: the engine's hint gives @export_range(0, 10) as 0.0 and 10.0.
+## A range's end as the script wrote it: the engine's hint gives @export_range(0, 10) as 0.0 and
+## 10.0.
 static func _bound(end: float) -> String:
 	return str(int(end)) if end == floorf(end) and absf(end) < 1e15 else str(end)
 
 
 ## Puts back on [param built] what its script set as it was attached and was not among
-## [param wanted], to the defaults it declares, outside the editor. Attaching runs the script's _init
-## there, which the editor never runs for a script that is not a tool, so a resource_name _init chose
-## was saved as if asked for. A property whose default the engine cannot report is left as made.
+## [param wanted], to the defaults it declares, outside the editor. Attaching runs the script's
+## _init there, which the editor never runs for a script that is not a tool, so a resource_name
+## _init chose was saved as if asked for. A property whose default the engine cannot report is left
+## as made.
 static func unmade(built: Resource, wanted: Dictionary) -> void:
 	var attached: Variant = built.get_script()
 	if Engine.is_editor_hint() or not attached is Script:
@@ -445,17 +457,25 @@ static func runs_script_code(target: Object, name: String) -> bool:
 ## the buses are read from the AudioServer, which holds the project's layout; "the engine changed or
 ## refused the value" left a caller to guess the bus did not exist.
 static func not_held(
-	holder: String, engine_class: String, property: String, declared: Dictionary, given: Array, held: String
+	holder: String,
+	engine_class: String,
+	property: String,
+	declared: Dictionary,
+	given: Array,
+	held: String
 ) -> String:
 	var value: Variant = given[0]
-	var said: String = "%s.%s was given %s and holds %s after it was set" % [holder, property, given[1], held]
+	var said: String = (
+		"%s.%s was given %s and holds %s after it was set" % [holder, property, given[1], held]
+	)
 	var type: int = GdhRead.as_int(declared.get("type", TYPE_NIL))
 	var hint: int = GdhRead.as_int(declared.get("hint", PROPERTY_HINT_NONE))
 	if hint in LAYER_NAMES and typeof(value) == TYPE_INT:
 		return (
 			(
-				"%s: it is a mask of the %s layers, one bit each from layer 1 (1) to layer %d (%d), so it "
-				+ "takes 0 to %d and the engine keeps only those bits. Nothing was written."
+				"%s: it is a mask of the %s layers, one bit each from layer 1 (1) to layer %d "
+				+ "(%d), so it takes 0 to %d and the engine keeps only those bits. Nothing was "
+				+ "written."
 			)
 			% [
 				said,
@@ -477,22 +497,28 @@ static func not_held(
 		return said + ": the engine changed or refused the value, so nothing was written."
 	var close: PackedStringArray = GdhRead.nearest(str(value), names)
 	var nearest: String = (
-		"%s %s" % ["is" if close.size() == 1 else "are", ", ".join(close)] if not close.is_empty() else ""
+		"%s %s" % ["is" if close.size() == 1 else "are", ", ".join(close)]
+		if not close.is_empty()
+		else ""
 	)
 	if bus:
 		# Not "holds Master after it was set": the getter answers the first bus for any name the
 		# layout lacks, and nothing was kept.
 		return (
 			(
-				"%s.bus takes the name of one of the project's audio buses, and %s is none of them, so it "
-				+ "would play on %s; %s. project_info include audio_buses lists them, and "
-				+ "project_settings add_audio_bus adds one. Nothing was written."
+				"%s.bus takes the name of one of the project's audio buses, and %s is none of "
+				+ "them, so it would play on %s; %s. project_info include audio_buses lists them, "
+				+ "and project_settings add_audio_bus adds one. Nothing was written."
 			)
 			% [
 				holder,
 				given[1],
 				AudioServer.get_bus_name(0),
-				"the buses are " + ", ".join(names) if nearest.is_empty() else "the nearest " + nearest
+				(
+					"the buses are " + ", ".join(names)
+					if nearest.is_empty()
+					else "the nearest " + nearest
+				),
 			]
 		)
 	return (
@@ -500,7 +526,11 @@ static func not_held(
 		% [
 			said,
 			given[1],
-			"it lists " + ", ".join(names) if nearest.is_empty() else "the nearest it lists " + nearest
+			(
+				"it lists " + ", ".join(names)
+				if nearest.is_empty()
+				else "the nearest it lists " + nearest
+			),
 		]
 	)
 
@@ -513,7 +543,9 @@ static func held_by_children(node: Node, property: String) -> String:
 	var holders: PackedStringArray = []
 	for child: Node in node.get_children():
 		if property in child:
-			var _added: bool = holders.append("%s (a %s)" % [root.get_path_to(child), child.get_class()])
+			var _added: bool = holders.append(
+				"%s (a %s)" % [root.get_path_to(child), child.get_class()]
+			)
 	if holders.is_empty():
 		return ""
 	if holders.size() == 1:
@@ -523,14 +555,15 @@ static func held_by_children(node: Node, property: String) -> String:
 
 
 ## A sentence for each node path in [param given], by property, that names no node from
-## [param node]. A path is written whatever it names, as the inspector writes one, since the node may
-## be added next; a joint whose node_a named nothing then joined nothing, and no answer said so.
+## [param node]. A path is written whatever it names, as the inspector writes one, since the node
+## may be added next; a joint whose node_a named nothing then joined nothing, and no answer said so.
 static func naming_nothing(node: Node, given: Dictionary) -> Dictionary:
 	var said: Dictionary = {}
 	for property: String in given:
 		if "/" in property or ":" in property:
 			continue
-		# What the node holds, since a path given as text is held as text until the engine stores it.
+		# What the node holds, since a path given as text is held as text until the engine stores
+		# it.
 		var path: Variant = node.get(property)
 		if not path is NodePath:
 			continue
@@ -539,8 +572,8 @@ static func naming_nothing(node: Node, given: Dictionary) -> Dictionary:
 			continue
 		said[property] = (
 			(
-				"%s names no node from %s. It is written, as the editor writes one, since that node may "
-				+ "be added next; until it is, %s finds nothing."
+				"%s names no node from %s. It is written, as the editor writes one, since that "
+				+ "node may be added next; until it is, %s finds nothing."
 			)
 			% [str(named), node.name, property]
 		)
@@ -553,7 +586,10 @@ static func naming_nothing(node: Node, given: Dictionary) -> Dictionary:
 static func no_uniform(material: ShaderMaterial, property: String) -> String:
 	var uniform: String = property.trim_prefix("shader_parameter/")
 	if material.shader == null:
-		return "The ShaderMaterial has no shader, so it has no parameter %s yet; set shader first." % uniform
+		return (
+			"The ShaderMaterial has no shader, so it has no parameter %s yet; set shader first."
+			% uniform
+		)
 	var shader: String = material.shader.resource_path
 	var named: String = shader if not shader.is_empty() else "Its shader"
 	var uniforms: Array = []