enhance code builder so get_vertex_codes() has the best return type

Author: hx2A

generator/codebuilder.py

@@ -63,11 +63,13 @@ def snake_case(name):
 
 
 @lru_cache(128)
-def _convert_type(jtype: str) -> str:
+def _convert_type(jtype: str, parameter=True) -> str:
     if jtype == "void":
         return "None"
-    elif jtype in ref.TYPE_OVERRIDES:
-        return ref.TYPE_OVERRIDES[jtype]
+    elif parameter and jtype in ref.PARAM_TYPE_OVERRIDES:
+        return ref.PARAM_TYPE_OVERRIDES[jtype]
+    elif not parameter and jtype in ref.RETURN_TYPE_OVERRIDES:
+        return ref.RETURN_TYPE_OVERRIDES[jtype]
     elif jtype.endswith("[][]"):
         return f"JArray({ref.JPYPE_CONVERSIONS[jtype[:-4]]}, 2)"
     elif jtype.endswith("[]"):
@@ -148,7 +150,7 @@ def _make_param_rettype_strs(self, fname, first_param, params, paramnames, retty
         paramstrs = [first_param] + [
             _param_annotation(pn, p) for pn, p in zip(parameter_names, params)
         ]
-        rettypestr = _convert_type(rettype)
+        rettypestr = _convert_type(rettype, parameter=False)
 
         return paramstrs, rettypestr
 

generator/reference.py

@@ -25,16 +25,21 @@
 
 PY5_SKIP_RETURN_TYPES = set()
 
-TYPE_OVERRIDES = {
-    # this is correct, see _return_list_py5shapes
-    "processing.core.PShape[]": "list[Py5Shape]",
+PARAM_TYPE_OVERRIDES = {
     "char[]": "list[chr]",
     "java.lang.String[]": "list[str]",
     "float[]": "Iterator[float]",
     "float[][]": "Iterator[Iterator[float]]",
     "int[]": "Iterator[int]",
 }
 
+RETURN_TYPE_OVERRIDES = {
+    # this is correct, see _return_list_py5shapes
+    "processing.core.PShape[]": "list[Py5Shape]",
+    "java.lang.String[]": "list[str]",
+    "int[]": "npt.NDArray[np.int32]",
+}
+
 JPYPE_CONVERSIONS = {
     "boolean": "JBoolean",
     "int": "JInt",

py5_docs/Reference/api_en/Py5Shape_get_vertex_codes.txt

@@ -7,7 +7,7 @@ category = vertices
 subcategory = None
 
 @@ signatures
-get_vertex_codes() -> Iterator[int]
+get_vertex_codes() -> npt.NDArray[np.int32]
 
 @@ description
 Get the vertex codes for a `Py5Shape` object. The vertex codes can be used to inspect a shape's geometry to determine what kind of vertices it has. Each can be one of `BREAK`, `VERTEX`, `BEZIER_VERTEX`, `QUADRATIC_VERTEX` or `CURVE_VERTEX`.