Skip to content

[BUG] Generate proper Python stubs #283

@NikilXYZ

Description

@NikilXYZ

Describe the bug
A clear and concise description of the bug.
Python API doesn't have stubs which means that IDEs have no idea what functions are even available.

Steps/Code to reproduce bug
Follow this guide
http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports to craft a
minimal bug report. This helps us reproduce the issue you're having and resolve
the issue more quickly.

Expected behavior
A clear and concise description of what you expected to happen.
When I type cvcuda. in my IDE (like VS Code) I expect it to show all the options for the API including the docstrings that match the help text which I can see when running help(cvcuda.osd_into) or whatever for any functions. Also osd_into in particular isn't even documented on the API website but it's an important and useful feature (don't remove the function!).

Environment overview (please complete the following information)

  • Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)] installed w poetry and pyenv. IDE VS Code
  • Method of cuDF install: [Docker, pip, or from source] poetry
    • If method of install is [Docker], provide docker pull & docker run commands used

Environment details
Please run and paste the output of the cvcuda/print_env.sh script here, to gather any other relevant environment details
That file doesn't exist in the python installation from pypi cvcuda-cu12 using version 0.16.0 so I can't even run this

Additional context
Add any other context about the problem here.
In my pyenv, these are the cvcuda files that I see:

Image

and this is what is in the init

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working as expected (software, install, documentation)

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions