Typed objects for function input and output

[AdminCrystal]

Versions

What versions of Godot do you want to use this feature in?
Whenever

The Feature

Adding types where possible to public facing methods mainly but technically could be any of them
An example
func was_called(variant, method_name, parameters=null):
could be replaced with
func was_called(variant: Variant, method_name: String, parameters=null) -> bool:
I believe parameters can be array or dictionary so may need to put parameters as Variant or if its dictionary or array I can put empty one as default

I was thinking about doing a couple, if you are ok i can create a Pr for a few

[bitwes]

I would entertain a PR for this. I am ok with adding types to user facing methods. I am less ok with adding them to public methods that aren't documented. I don't want to add them to the internals of GUT since I rarely use them, and I'll have to start to keep the code consistent.

Some caveats:

• Adding types to scripts that do not have a class_name won't help with autocomplete, and I'm very stingy with adding class_name.
• I thought this was going to be a longer list.

[AdminCrystal]

I have done some of them here
https://github.com/bitwes/Gut/pull/773/files
But as im running through the tests built into the app I am seeing that adding types may be a breaking change for some things, an example being
func assert_string_contains(text: String, search: String, match_case: Variant = true) -> void:

Although the code in the function actually checks if its strings it would previously do a _fail() but now it would cause runtime failure when passing things like null

Invalid type in function 'assert_string_contains' in base 'Node (GutTest)'. Cannot convert argument 1 from Nil to String. 

Other example being

func is_failing() -> bool:
	if(gut.get_current_test_object() != null and
		!['before_all', 'after_all'].has(gut.get_current_test_object().name)):

		return gut.get_current_test_object().is_failing()
	else:
		_lgr.error('No current test object found.  is_failing must be called inside a test.')
		return true

this used to return null in the error case but a bool can't be null in gdscript so I would have to change the return value to true or false, or return a Variant which can be null which isn't really that helpful in grand scheme of things.

Maybe I was a little over ambitious lol.

EDIT: I (bitwes) edited this comment to format code.