Auto-Generated Stubs for Python Bindings #2028
Conversation
|
|
Seems like, when building through The stubgen command needs to be executed from where the .pyd files are. For that, I currently set the |
| ) | ||
| endif () | ||
| endif() | ||
|
|
||
| if(MATERIALX_INSTALL_PYTHON AND PYTHON_EXECUTABLE AND NOT SKBUILD) |
There was a problem hiding this comment.
I think you need to move this before stubgen, so it get's run after install.
There was a problem hiding this comment.
However to include the stubs in the package itself, You need to repackage.
I think the least number of steps is
- run this install step to produce the locally installed MaterialX package.
- run your stubgen logic to get the files output to the local
MaterialXfolder. - run this step again.
I think this should cover locally packaged plus packages generated via SKBUILD. ( I think think the wheels logic is run afterwards as an additional workflow in github actions ).
There was a problem hiding this comment.
Which part do you mean exactly? Or the whole code block?
There was a problem hiding this comment.
Sorry for lack of clarity:
- You need this if block to run to install.
- Then you need your entire stub logic block.
- Then you need this if block again.
| @@ -51,6 +51,7 @@ option(MATERIALX_BUILD_SHARED_LIBS "Build MaterialX libraries as shared rather t | |||
| option(MATERIALX_BUILD_MONOLITHIC "Build a single monolithic MaterialX library." OFF) | |||
| option(MATERIALX_BUILD_USE_CCACHE "Enable the use of ccache to speed up build time, if present." ON) | |||
| option(MATERIALX_PYTHON_LTO "Enable link-time optimizations for MaterialX Python." ON) | |||
| option(MATERIALX_PYTHON_STUBS "Enable the automated generation of MaterialX Python '.pyi' stub files through mypy's stubgen." OFF) | |||
There was a problem hiding this comment.
If this is set then you need to ensure that MATERIALX_INSTALL_PYTHON is set as well
since your running stubgen off the installed package.
| ) | ||
| endif () | ||
| endif() | ||
|
|
||
| if(MATERIALX_INSTALL_PYTHON AND PYTHON_EXECUTABLE AND NOT SKBUILD) |
There was a problem hiding this comment.
However to include the stubs in the package itself, You need to repackage.
I think the least number of steps is
- run this install step to produce the locally installed MaterialX package.
- run your stubgen logic to get the files output to the local
MaterialXfolder. - run this step again.
I think this should cover locally packaged plus packages generated via SKBUILD. ( I think think the wheels logic is run afterwards as an additional workflow in github actions ).
PR for #2024
MATERIALX_PYTHON_STUBSto enable/disable automated build of Python stubs through mypy stubgenpython/CMakeLists.txtto account for the logic, if the stubgen executable can be found and if the option is turned onpyproject.tomlto addmypyas a build dependency and turn on the automated stubs buildingCurrently, this is still a WIP/Draft. When building with a command such as:
cmake -S . -B build -DMATERIALX_BUILD_PYTHON=ON -DMATERIALX_PYTHON_STUBS=ON -DMATERIALX_BUILD_VIEWER=OFF -DMATERIALX_BUILD_GRAPH_EDITOR=OFF -DMATERIALX_BUILD_TESTS=ON -DMATERIALX_TEST_RENDER=OFF -DMATERIALX_WARNINGS_AS_ERRORS=ON -G "Visual Studio 17 2022" -A "x64"; cmake --build build --target install --config Release --parallel 2the stubs can be found and work properly in the MaterialX installation. However, when building through pip, such as
pip install ., it seems like it doesn't find some folder or file - I'm assuming the envvars are slightly different when building through pip, and I'm currently not taking that into account. Any help would be appreciated!