BMD Fusion scripting stubs

A script to generate python stubs from Fusion.

Info

All stubs are generated for Python 3.10+

If you wish to use this in VSCode I recommend installing my VSCode extension BMD Fusion scripting

Usage

It uses a modified version of Roger Magnusson's Class Browser Extractor script to genenrate the needed json files Simply run the script and select the json_stubs folder. When the UI opens the files have bin generated. Now run the stubs_generator script and you'll find all the newly created stubs in the typings folder.

Add the typings folder to your language interpreters extra folder. In VSCode and Pylance add this string to your settings.json:

"python.analysis.extraPaths": [
    "./fusion_typings"
],

The script adds the tool-script objects to builtins.pyi so your python files will find these classes without the need to import anything in your python script (that would break the script when ran from Fusion as Fusion already have those classes in the global space)

Note

The class names of objects is the object name with a trailing _. So if you have a function that you want to add types to, enter the object name + _:

def getCurrentCompAndClearLogs(fusObj: Fusion_) -> Composition_:
    fusObj.ClearFileLog()
    return fusObj.GetCurrentComp()


cur_comp = getCurrentCompAndClearLogs(fusion)