Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add stubs to python bindings to provide typing information. #2415

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

0mdc
Copy link
Contributor

@0mdc 0mdc commented Jun 25, 2024

Motivation and Context

This changeset adds stubs to python bindings to provide typing information.
Stub generation depends on pybind11-stubgen.

typing-2024-06-16_22.01.01.mp4

How to test:

  • pip install pybind11-stubgen.
  • Build habitat-sim normally.
  • Import the package in another project, and explore types in your IDE.

WIP:

  • Stubs contain some errors, but they mostly work.
  • CI is not yet handled.
  • Ideally, creating a stub package would scale better, but I could not make it work with bindings. See PEP 561.

How Has This Been Tested

Tested by importing habitat_sim in an external Python file.

Types of changes

  • New feature (non-breaking change which adds functionality)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@0mdc 0mdc requested review from mosra, jturner65 and aclegg3 June 25, 2024 19:07
@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Jun 25, 2024
Copy link
Contributor

@jturner65 jturner65 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see slack thread here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants