How to stubs with editable install?

[kj4tmp]

How do I have stub generation + editable install (pip install -e .)?

I'm trying to get my vscode to show type hints for my extension module during development.
I believe this is related to stub generation and editable installs.
I have installed nanobind using the git submodule method.

[kj4tmp]

my package does successfully install locally, and I can see that the function signature is there, but I'm not getting any help from my IDE

root@39125bc93608:/workspaces/pyethercat# python
Python 3.12.3 (main, Apr 10 2024, 14:35:18) [GCC 12.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import pyethercat
>>> pyethercat.add.__nb_signature__
(('def add(a: int, b: int) -> int', 'This function adds two numbers and increments if only one is provided.', None),)
>>> 

[kj4tmp]

similar story with the py.typed

[kj4tmp]

figured out that i was missing
install(FILES py.typed my_ext.pyi DESTINATION ".") from cmakelists, but now its failing with

Building wheels for collected packages: pyethercat
  Building wheel for pyethercat (pyproject.toml) ... error
  error: subprocess-exited-with-error
  
  × Building wheel for pyethercat (pyproject.toml) did not run successfully.
  │ exit code: 1
  ╰─> [19 lines of output]
      *** scikit-build-core 0.9.1 using CMake 3.29.2 (wheel)
      *** Configuring CMake...
      loading initial cache file build/cp312-abi3-linux_x86_64/CMakeInit.txt
      -- Configuring done (0.2s)
      -- Generating done (0.1s)
      -- Build files have been written to: /workspaces/pyethercat/build/cp312-abi3-linux_x86_64
      *** Building project with Ninja...
      [1/3] Linking CXX static library libnanobind-static-abi3.a
      [2/3] Linking CXX shared module pyethercat_ext.abi3.so
      [3/3] Generating py.typed, pyethercat_ext.pyi
      *** Installing project into wheel...
      -- Install configuration: "Release"
      CMake Error at build/cp312-abi3-linux_x86_64/cmake_install.cmake:51 (file):
        file INSTALL cannot find "/workspaces/pyethercat/py.typed": No such file or
        directory.

[kj4tmp]

i was able to get the py.typed and pyi files into the correct directory using
install(FILES "${CMAKE_CURRENT_BINARY_DIR}/pyethercat_ext.pyi" "${CMAKE_CURRENT_BINARY_DIR}/py.typed" DESTINATION pyethercat)

[nurpax]

I'm doing something similar and this seems to work for me:

nanobind_add_stub(
  imgui_ext_stub
  MODULE imgui_ext
  OUTPUT "${CMAKE_SOURCE_DIR}/src/imgui/imgui_ext.pyi"
  PYTHON_PATH $<TARGET_FILE_DIR:imgui_ext>
  DEPENDS imgui_ext
  INCLUDE_PRIVATE
)

install(TARGETS imgui_ext LIBRARY DESTINATION imgui)
install(FILES "${CMAKE_SOURCE_DIR}/src/imgui/imgui_ext.pyi" DESTINATION imgui)

[kj4tmp]

thanks!!

this is what i ended up with

nanobind_add_stub(
  soem_ext_stub
  MODULE soem_ext
  OUTPUT "${CMAKE_SOURCE_DIR}/src/pyethercat/soem/soem_ext.pyi"
  PYTHON_PATH $<TARGET_FILE_DIR:soem_ext>
  DEPENDS soem_ext
  MARKER_FILE py.typed
)
# Install directive for scikit-build-core

install(TARGETS soem_ext LIBRARY DESTINATION "pyethercat/soem")
install(FILES "${CMAKE_SOURCE_DIR}/src/pyethercat/soem/soem_ext.pyi" DESTINATION "pyethercat/soem")
install(FILES "${CMAKE_CURRENT_BINARY_DIR}/py.typed" DESTINATION "pyethercat/soem")

[ianhbell]

I used basically exactly what @kj4tmp did and it works great