-
Notifications
You must be signed in to change notification settings - Fork 1
/
stubs_generator.py
664 lines (558 loc) · 22 KB
/
stubs_generator.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
"""
Convert json generated files to python stubs
Fixed:
* If a method has two usage with the same inputs but different outputs,
combine them and make multiple output types instead
* If the method is a constructor (eg ChannelStyle constructor),
figure out what to do with it
* GLView for some reason imports:
from , import _,
from import _
* Media_pool_item's class name contain spaces
* MtlGraph3D imports "from Request req import _Request req"
* Fetch all return types that aren't native but also not objects
TODO:
* How to deal with:
"info_text": "Discovered methods might be available in many contexts,
but most typically in Fuse scripts",
"""
import json
import re
from pathlib import Path
from manual_fixes import (
fixMethodReturnTypes,
fixInputTypes,
fixPropertyReturnTypes,
)
from manual_fixes.generate_default_files import (
generateToolClass,
generateToolScripts,
generateBuiltins,
)
from manual_fixes.additional_properties import additional_properties_list
from manual_fixes.additional_methods import additional_methods_list
return_types: list[str] = []
non_existing_types: list[str] = []
local_non_existing_types: list[str] = []
json_files: list[str] = []
add_overload = False
add_any = False
add_literal = False
content = ""
def removeParents(string: str) -> str:
return string.replace("(", "").replace(")", "").strip()
def removeBrackets(string: str) -> str:
return string.replace("[", "").replace("]", "").strip()
def removeColon(string: str) -> str:
return string.replace(":", "").strip()
def replaceDotsFromName(string: str) -> str:
return string.replace(".", "_").strip()
def replaceWithUnderscore(string: str):
return string.replace("-", "_").replace(" ", "_")
def checkIfToAddList(string: str) -> str:
if string == "int | str | bool | dict[Any, Any]":
return "int | str | bool | dict[Any, Any] | list[Any]"
return string
def fixProbChars(string: str):
"""Remove characters that shouldn't be there from the Fusion Docs"""
return (
string.replace("�@�vIh�%<�", "")
.replace("ð@‚vIhÂ%<½", "")
.replace("�@�vIh�%<�", "")
.replace("@vIh%<", "")
)
def fixIllegalNames(string: str) -> str:
if string in {
"def",
"from",
}:
string = f"{string}_"
return string
def fixMultiInputNames(string: str) -> str:
return string.replace("|", "_or_")
def generateNonExistingClasses(non_existing_types: list[str]) -> str:
content = "".join(f"class {obj}_:\n\t...\n" for obj in non_existing_types) + "\n"
for obj in non_existing_types:
content += f"{obj} = {obj}_\n"
content += "\n"
return content
def typeConverter(
type_string: str, is_optional=False, name: str = ""
) -> tuple[str, str]:
return_string = ""
custom_return = ""
if type_string == "boolean":
return_string = "bool"
elif type_string in {
"number",
"number (integer)",
"integer",
"int",
"int8",
"uint8",
"int16",
"uint16",
"int32",
"uint32",
"int64",
"uint64",
"size_t",
}:
return_string = "int"
elif type_string in {
"value",
"float32",
"float64",
}:
return_string = "float"
elif type_string in {
"string",
"char",
"char_t",
"char8",
"char8_t",
"char16",
"char16_t",
"char32",
"char32_t",
"char64",
"char64_t",
}:
return_string = "str"
elif type_string == "table":
global add_any
add_any = True
return_string = "dict[Any, Any]"
elif type_string == "nil":
return_string = "None"
elif "dict[" in type_string:
return_string = type_string
else:
return_string = f"{type_string}_"
global return_types
if type_string != name and type_string not in return_types:
custom_return = type_string
if is_optional:
return_string += f" = {return_string}()"
return return_string, custom_return
def addExtraImports(extra_imports) -> None:
if not isinstance(extra_imports, list):
extra_imports = [extra_imports]
# Remove the trailing "_" that gets added by typeConverter()
for extra_import in extra_imports:
extra_import = extra_import.replace("_", "")
global json_files
global non_existing_types
global local_non_existing_types
global return_types
if extra_import != "Tool" and f"{extra_import}.json" not in json_files:
if extra_import not in local_non_existing_types:
local_non_existing_types.append(extra_import)
if extra_import not in non_existing_types:
non_existing_types.append(extra_import)
if extra_import and extra_import not in return_types:
return_types.append(extra_import)
if "Any" in extra_import:
global add_any
add_any = True
def addReturnType(return_type: str, extra_import: str | None):
global return_types
global add_any
if extra_import and extra_import not in return_types:
return_types.append(extra_import)
if "Any" in return_type:
add_any = True
def checkPropertyReturnType(item, class_name: str, obj_name: str) -> str:
content = ""
return_type, extra_import = fixPropertyReturnTypes(class_name, obj_name)
if return_type:
addReturnType(return_type, extra_import)
content += f": {return_type}"
else:
returned_types, extra_imports = typeConverter(
item["return_type"], name=class_name
)
content += f": {returned_types}"
if extra_imports:
addExtraImports(returned_types)
return content
def checkMethodReturnType(class_name: str, obj_name: str, old_return_type: str) -> str:
return_type, extra_import = fixMethodReturnTypes(
class_name, obj_name, old_return_type
)
if return_type:
addReturnType(return_type, extra_import)
else:
return_type = ""
return return_type
def genTypeList(types: list[str] | str, is_optional=False, name="") -> tuple[str, str]:
extra_imports = ""
if isinstance(types, str):
types = types.split("|")
for i in range(len(types)):
return_types, extra_imports = typeConverter(types[i], is_optional, name)
types[i] = return_types
if len(types) > 1:
return " | ".join(types), extra_imports
else:
return "".join(types), extra_imports
def genInputType(txt: str, obj_name: str, is_optional=False, class_name=""):
# Split at the first space only
txt_list = txt.split(" ", 1)
if len(txt_list) == 1:
return fixMultiInputNames(fixIllegalNames(replaceWithUnderscore(txt_list[0])))
input_name = fixMultiInputNames(fixIllegalNames(replaceWithUnderscore(txt_list[1])))
input_type = ""
extra_imports = ""
if "§" in input_name:
global add_literal
add_literal = True
literals = input_name.split("§")
rest_literals = ", ".join(f'"{literal}"' for literal in literals[1:])
input_name = literals[0]
input_type = f"Literal[{rest_literals}]"
else:
input_type, extra_imports = genTypeList(txt_list[0], is_optional, class_name)
new_input_type, new_extra_imports = fixInputTypes(
class_name, obj_name, input_name, input_type
)
if new_input_type:
input_type = new_input_type
if new_extra_imports:
addExtraImports(new_extra_imports)
elif extra_imports:
addExtraImports(extra_imports)
return f"{input_name}: {checkIfToAddList(input_type)}"
def genProperties(o):
global add_any
if additional_properties_list.get(o["name"]):
o["properties"] = o["properties"] | additional_properties_list[o["name"]]
o["properties"] = {
key: o["properties"][key] for key in sorted(o["properties"].keys())
}
content = "\n\t#---Properties---#\n"
for name, key in o["properties"].items():
if isinstance(key, str):
continue
content += f"\t{name}"
# If key is list, meaning no real information inside:
if isinstance(key, list):
content += ": Any\n"
add_any = True
continue
if key.get("return_type"):
content += checkPropertyReturnType(key, o["name"], name)
else:
content += ": Any"
add_any = True
content += "\n"
if key.get("short_help") or key.get("description") or key.get("access_class"):
content += '\t"""\n'
if key.get("short_help"):
content += f'\t{key["short_help"]}\n\n'
if key.get("description"):
# Split the string into lines
lines = key["description"].split("\n")
# Add two tabs (8 spaces) to each line except the first one
indented_lines = [line if line.strip() else line for line in lines]
# Convert any two spaces to four spaces
converted_lines = [line.replace(" ", "\t") for line in indented_lines]
# Join the lines back together
output_string = "\n".join(converted_lines)
content += f"\t{output_string}\n\n"
if key.get("access_class"):
content += f'\t{key["access_class"]}\n'
# As we don't know if short_help and description exist well
# delete the two last characters in the string here to make sure
# we end up on one single new line
content = content[:-1]
content += '\n\t"""'
content += "\n"
return content
def genAttributes(o):
content = "\n\t#---Attributes---#\n"
for name, key in o["attributes"].items():
content += f"\t{name}"
if key.get("value"):
return_types, extra_imports = typeConverter(key["value"], name=o["name"])
content += f": {return_types}\n"
if extra_imports:
addExtraImports(return_types)
content += "\n"
return content
def removeDuplicateMethods(o):
"""
Process the methods to look for duplicate objects
with same input variables. If found, combine them into one
"""
for key in o["methods"].keys():
do_process = len(key) > 0 and isinstance(key, dict)
if do_process and key.get("usage") and len(key["usage"]) > 1:
new_usage: list[str] = []
for usage in key["usage"]:
splits = usage.split(" :")
# Process the input types
if len(splits) > 1:
new_nu = True
for i, nu in enumerate(new_usage):
nu_splits = nu.split(" :")
if len(nu_splits) > 1 and splits[1] == nu_splits[1]:
new_nu = False
new_usage[i] = f"({splits[0]}|{nu_splits[0]}) :{splits[1]}"
break
if new_nu:
new_usage.append(f"{splits[0]} :{splits[1]}")
key["usage"] = new_usage
return o
def genMethodShortHelp(key) -> str:
short_help = '\t\t"""\n'
if key.get("short_help"):
short_help += f'\t\t{key["short_help"]}\n\n'
if key.get("description"):
# Split the string into lines
lines = key["description"].split("\n")
# Add two tabs (8 spaces) to each line except the first one
indented_lines = ["\t\t" + line if line.strip() else line for line in lines]
# Convert any two spaces to four spaces
converted_lines = [line.replace(" ", "\t") for line in indented_lines]
# Join the lines back together
output_string = "\n".join(converted_lines)
short_help += f"{output_string}\n\n"
# As we don't know if short_help and description exist well
# delete the two last characters in the string here to make sure
# we end up on one single new line
short_help = short_help[:-1]
short_help += '\t\t"""\n'
return short_help
def genMethodInputTypes(o, obj_name, splits) -> str:
# Pattern to catch everything within ()
input_type_pattern = r"\((?:[^()]*|\((?:[^()]*|\([^()]*\))*\))*\)"
content = ""
if matches := re.findall(input_type_pattern, f"({splits[1]}"):
# If the match is just an empty (), continue
if matches[0] != "()":
content += ", "
matches = replaceDotsFromName(matches[0]).split(", ")
# Check if string is of type Literal
# If litterlas are found, tag them with §
filtered_matches = []
is_literal = False
for match in matches:
if ":" in match and is_literal is False:
is_literal = True
match_split = match.split(": ")
filtered_matches.append(f"{match_split[0]}§{match_split[1]}")
elif is_literal is True:
if " " in match: # No longer literals
is_literal = False
filtered_matches.append(match)
else: # Literals - Add § between each object
filtered_matches[-1] += f"§{match}"
else:
filtered_matches.append(match)
# Go through all matches and extract input types
for i, match in enumerate(filtered_matches):
match = removeParents(match)
if i > 0:
content += ", "
is_optional = False
if match[0] == "[":
is_optional = True
match = removeBrackets(match)
content += genInputType(
match, obj_name, is_optional, class_name=o["name"]
)
return content
def genMethodReturns(o, obj_name, splits) -> str:
extra_imports = ""
return_content = ""
return_imports = []
# Define the regular expression pattern
return_type_pattern = r"\|(?![^(]*\))"
splits[0] = removeColon(fixProbChars(splits[0]))
return_type_result = re.split(return_type_pattern, splits[0])
for r_i, r_splits in enumerate(return_type_result):
if r_i > 0:
return_content += " | "
usage_types = removeParents(r_splits)
usage_splits = usage_types.split(", ")
if usage_splits[0] == "":
return_content += "None"
else:
# Catch errors in the fusion docs:
# If the return type is an empty whitespace
# remove it from the list
for i, splits in enumerate(usage_splits):
if splits == ",":
del usage_splits[i]
# Check if it's a constructor:
construct_split = usage_splits[0].split(" ")
if len(construct_split) > 1 and removeParents(
construct_split[0]
) == removeParents(construct_split[1]):
return_content += f"{removeParents(construct_split[0])}_"
else: # Normal return type
if len(usage_splits) > 1:
return_content += "tuple["
for i, splits in enumerate(usage_splits):
if i > 0:
return_content += ", "
multi_splits = splits.split("|")
returned_types, extra_imports = genTypeList(
multi_splits, name=o["name"]
)
if extra_imports:
return_imports.append(extra_imports)
return_content += returned_types
if len(usage_splits) > 1:
return_content += "]"
if new_return_type := checkMethodReturnType(o["name"], obj_name, return_content):
return_content = new_return_type
if return_imports:
addExtraImports(return_imports)
return checkIfToAddList(return_content)
def genMethods(o) -> str:
global add_overload
if additional_methods_list.get(o["name"]):
o["methods"] = {key: o["methods"][key] for key in sorted(o["methods"].keys())}
o["methods"] = o["methods"] | additional_methods_list[o["name"]]
o["methods"] = {key: o["methods"][key] for key in sorted(o["methods"].keys())}
# Remove duplicates in the method
o = removeDuplicateMethods(o)
content = "\n\t#---Methods---#\n"
for name, key in o["methods"].items():
# Check if the item is something to process (only process dicts)
do_process = len(key) > 0 and isinstance(key, dict)
# Fetch the help-string
short_help = ""
if do_process and (key.get("short_help") or key.get("description")):
short_help += genMethodShortHelp(key)
short_help += "\t\t...\n"
# Process all usage types
if do_process and key.get("usage"):
if is_overload := len(key["usage"]) > 1:
add_overload = True
for usage in key["usage"]:
if is_overload:
content += "\t@overload\n"
content += f"\tdef {name}(self"
# Split the input and return types
splits = usage.split(f"{name}(")
# Process the input types
if len(splits) > 1:
content += genMethodInputTypes(o, name, splits)
# process all return types
content += ") -> "
content += genMethodReturns(o, name, splits)
content += ":\n"
content += short_help
else:
content += f"\tdef {name}(self) -> None:\n{short_help}"
return content
def genStubs(o) -> str:
print("Name: ", o["name"])
global content
global return_types
global add_overload
global add_any
global local_non_existing_types
global add_literal
add_overload = False
add_any = False
return_types = []
local_non_existing_types = []
add_literal = False
content = f'class {replaceWithUnderscore(o["name"])}_:\n'
# Check if object is empty:
if not o.get("properties") and not o.get("attributes") and not o.get("methods"):
content += "\t...\n"
return content
## PROPERTIES ##
if o.get("properties") and len(o["properties"]) > 0:
content += genProperties(o)
## ATTRIBUTES ##
if o.get("attributes") and len(o["attributes"]) > 0:
content += genAttributes(o)
## METHODS ##
if o.get("methods") and len(o["methods"]) > 0:
new_content = genMethods(o)
content += new_content
return content
if __name__ == "__main__":
stub_names: list[str] = []
object_data = None
# Loop through all files inside the json_stubs folder
root_folder = Path(__file__).parent
json_stubs_folder = root_folder / "json_stubs"
typings_folder = root_folder / ".fusion_typings"
# Get a list of all filenames available
json_files = [
file.name
for file in json_stubs_folder.iterdir()
if file.is_file() and file.suffix == ".json"
]
## Process all json files ##
for file_path in json_stubs_folder.iterdir():
if file_path.is_file() and file_path.suffix == ".json":
# Read the Markdown content from the file or fetch it from a URL.
object_data = None
with open(file_path, "r", encoding="utf-8") as f:
object_data = json.load(f)
stubs_content = genStubs(object_data)
imports_list = []
if add_any:
imports_list.append("Any")
if add_overload:
imports_list.append("overload")
if add_literal:
imports_list.append("Literal")
imports = (
"from typing import " + ", ".join(imports_list) + "\n\n"
if imports_list
else ""
)
if len(return_types) > 0:
for imp in return_types:
if imp not in local_non_existing_types:
imports += f"from {imp} import {imp}_\n"
if len(local_non_existing_types) > 0:
imports += "from _non_existing import "
for i, imp in enumerate(local_non_existing_types):
if i > 0:
imports += ", "
imports += f"{imp}_"
imports += "\n"
if len(return_types) > 0 or len(local_non_existing_types) > 0:
imports += "\n\n"
stubs_content = imports + stubs_content
name_with_underscores = replaceWithUnderscore(object_data["name"])
stubs_content += f"\n{name_with_underscores} = {name_with_underscores}_"
stub_names.append(name_with_underscores)
# Save the stubs to a .pyi file
with open(
f"{typings_folder / file_path.stem}.pyi", "w", encoding="utf-8"
) as f:
f.write(stubs_content)
## Write non-existing objects to file ##
with open(f'{typings_folder / "_non_existing.pyi"}', "w", encoding="utf-8") as f:
f.write(generateNonExistingClasses(non_existing_types))
## Write tool class ##
with open(f'{typings_folder / "Tool.pyi"}', "w", encoding="utf-8") as f:
f.write(generateToolClass())
## Write tool scripts ##
with open(f'{typings_folder / "_tool_scripts.pyi"}', "w", encoding="utf-8") as f:
f.write(generateToolScripts())
## Generate __builtins__ files
with open(f'{typings_folder / "__builtins__.pyi"}', "w", encoding="utf-8") as f:
f.write(generateBuiltins())
# Add "Tool" to the list as it doesn't exist as .json file
json_files.append("Tool")
# Generate Stubs objects list
for file in json_files:
object_name = file.replace(".json", "")
f.write(f"from {object_name} import {object_name}_\n")
f.write("\n__all__.extend([\n")
for file in json_files:
object_name = file.replace(".json", "")
f.write(f'\t"{object_name}_",\n')
f.write("])")