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

[FEA] Provide type stubs for pylibcudf package #15190

Closed
wence- opened this issue Feb 29, 2024 · 1 comment · Fixed by #17258
Closed

[FEA] Provide type stubs for pylibcudf package #15190

wence- opened this issue Feb 29, 2024 · 1 comment · Fixed by #17258
Assignees
Labels
feature request New feature or request pylibcudf Issues specific to the pylibcudf package

Comments

@wence-
Copy link
Contributor

wence- commented Feb 29, 2024

Is your feature request related to a problem? Please describe.

As we build out the pylibcudf API, having type stubs for lsp and type-checking integration becomes increasingly useful.

Describe the solution you'd like

Provide type stubs (with docstrings) so that lsp/type-checker integration works.

We don't want to replicate docstrings in more than one place, I don't know if the right place for them is the type stub file.

Describe alternatives you've considered

Having the relevant pyx file open in an editor at the same time.

Additional context

There are a number of half-working auto-generation engines for stubs, but none of them seem to work that well, so we should probably just do this by hand.

@vyasr
Copy link
Contributor

vyasr commented Nov 6, 2024

We may want to look into cython/cython#3818. As @wence- mentioned, many of the existing autogenerators (listed in the linked Cython issue) aren't great, but getting something baked directly into Cython with all of the information Cython already has could in principle work much better.

@wence- wence- assigned wence- and unassigned Matt711 Nov 6, 2024
@GPUtester GPUtester moved this from Todo to In Progress in cuDF Python Nov 6, 2024
@rapids-bot rapids-bot bot closed this as completed in 7682edb Nov 12, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in cuDF Python Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature or request pylibcudf Issues specific to the pylibcudf package
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants