Feature request: Generate API Stubs for Dynamo

[LoganAC34]

Is your feature request related to a problem? Please describe

Feature request: Add to the "Generate API Stubs" tool in DevTools to also export Dynamo API stubs like DynamoServices and Dynamo core, etc.

Describe the solution you'd like

Just add the dynamo API stubs generated from the appropriate dlls. These could be useful in developing scripts that use Dynamo.

Describe alternatives you've considered

In a desperate attempt, I tried modifying the "Generate API Stubs" python script to include only DynamoCore and DynamoServices in the ASSMS list, but the labs.PythonStubsBuilder.BuildAssemblyStubs function just seems to ignore them.

[LoganAC34]

I figured out a bandaid fix for now, but it could use improvement from someone who knows what they are doing. If anyone else finds this useful; i forked a repository here where i used it to generate stubs:
https://github.com/LoganAC34/pythonstubs

[tay0thman]

did you try pyrevit-stubsbuilder.exe? that ships with pyrevit?

[LoganAC34]

did you try pyrevit-stubsbuilder.exe? that ships with pyrevit?

I couldn't find it in the current build... until just now. I searched and searched, but couldn't find it in either the repo or on my machine, but I might just be blind.

I searched the other day in paths that varius forum posts showed, but I either didn't have the pyRevit-Master folder where they had it, or it just wasn't there in \bin. I also didn't see it in the repo, so i figured what I saw online was old. I figured i'd try reinstalling PyRevit since you mentioned it is in the latest build, and it seems now i have a pyRevit-Master directory when i previously didn't, but the .exe is still not in the location everyone else seemed to have it. I had to search with Everything and eventually found it in %appdata%\pyRevit-Master\bin\netfx.

Is there an official source somewhere that states its in this location?

Regardless, I tried using it and i just get the error:

Unhandled Exception: System.IO.FileNotFoundException: Could not load file or assembly 'DocoptNet, Version=0.0.0.0, Culture=neutral, PublicKeyToken=7a38c71da49a547e' or one of its dependencies. The system cannot find the file specified.
   at pystubsbuilder.Program.Main(String[] args)

Code (using my repo):

Details

function Get-SearchArgs {
    param(
        [string[]]$Paths
    )
    $searchArgs = @()
    foreach ($path in $Paths) {
        $searchArgs += "--search=$path"
    }
    return $searchArgs
}

# configs
$mypath = (Get-Item -Path ".\").FullName
$stubsdest = "$mypath\stubs"
$dynamobase = "C:\Program Files\Dynamo\Dynamo Core\2"
$revitbase = "C:\Program Files\Autodesk\Revit 2022"
$revitdynamobase = "$revitbase\AddIns\DynamoForRevit\Revit"

$searchPaths = @($revitbase, $revitdynamobase, $dynamobase)
$searchArgs = Get-SearchArgs -Paths $searchPaths

cd "C:\Users\lcarrozza\AppData\Roaming\pyRevit-Master\bin\netfx"

# Dynamo
./pyrevit-stubsbuilder.exe --dest="$stubsdest" @searchArgs "$dynamobase\DynamoServices.dll"
./pyrevit-stubsbuilder.exe --dest="$stubsdest" @searchArgs "$dynamobase\DynamoCore.dll"
./pyrevit-stubsbuilder.exe --dest="$stubsdest" @searchArgs "$dynamobase\DynamoApplications.dll"
./pyrevit-stubsbuilder.exe --dest="$stubsdest" @searchArgs "$dynamobase\DynamoArduino.dll"
./pyrevit-stubsbuilder.exe --dest="$stubsdest" @searchArgs "$dynamobase\DynamoPython.dll"
./pyrevit-stubsbuilder.exe --dest="$stubsdest" @searchArgs "$dynamobase\DynamoManipulation.dll"
./pyrevit-stubsbuilder.exe --dest="$stubsdest" @searchArgs "$dynamobase\DSCoreNodes.dll"

# pyrevit-stubsbuilder
./pyrevit-stubsbuilder.exe --dest="$stubsdest" @searchArgs "$revitbase\RevitAPI.dll"
./pyrevit-stubsbuilder.exe --dest="$stubsdest" @searchArgs "$revitbase\RevitAPIUI.dll"
./pyrevit-stubsbuilder.exe --dest="$stubsdest" @searchArgs "$revitdynamobase\RevitServices.dll"
./pyrevit-stubsbuilder.exe --dest="$stubsdest" @searchArgs "$revitdynamobase\RevitNodes.dll"

# back to where started
cd $mypath

I get the same error if I just do .\pyrevit-stubsbuilder.exe --help in a fresh shell console.

[tay0thman]

I think I see the root cause of your issue, I think pyrevit-stubs is built for .Net Framework, while the Dynamo DLLs are compiled for .Net Core.

is this the case @dosymep ?

[tay0thman]

@jmcouffin @sanzoghenzo Quick question,
do you have any concern if we clone Mcneel's git and stubbler into our netcore folder?

I have it working on my system and potentially I can update the pyrevit-dev tools to include the new stubs generator,
Additionally is there a method in HOST_APP to indicate if we are running netfx or netcore? or I can just rely on HOST_APP.version?

[dosymep]

@tay0thman Yes, that's true, I couldn't find the source code for this app to be able to rebuild it on the new version of dotnet.

[sanzoghenzo]

Do we need both versions, or does the .net (core) compiled pystubber works with .net framework assemblies? If it does, we could drop the old one, since we just call a separate process that would work regardless of the revit .net runtime.

Just thinking out loud here 😅

[tay0thman]

@sanzoghenzo No they don't, I tested the netcore stubber with revit 2023 and 2024 and it fails to extract the stubs from the dlls.

I think what we have works now, I'm just adding the dynamo assemblies to the assembly list and give the use the option if they want to extract these stubs as well

@LoganAC34 are these assemblies are the ones you are looking for?

'DynamoServices',
'DynamoCore',
'DynamoApplications',
'DSCoreNodes',
'RevitServices',
'RevitNodes',

If so , I'll generate a PR shortly

[LoganAC34]

@tay0thman Probably. The only other ones i found that seemed to work with the repo i forked is DynamoArduino.dll and DynamoPython.dll but i honestly I don't know if they are necessary or what they even are. I just included them because they are in the directory and they didn't cause errors when used with the script.

Thanks all for looking into this and so quickly.

[tay0thman]

PR Created here "
#2813