channable / channable/opsqueue

Add typing stubs (`.pyi` files) for PyO3-generated Python definitions

Open
#101 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
96
Forks
2
Avg merge
1h 2m
Merged PRs (30d)
2

Description

Even with https://github.com/channable/opsqueue/issues/8 resolved, type checkers will treat types that are exclusively defined via C bindings as `Any`. Typing stubs would fix this, but PyO3 currently does not generate them (https://github.com/PyO3/pyo3/issues/5137). Manually maintaining them would be annoying because it'd have to be kept in sync with the Rust definitions of the types, but it could still be valuable as a temporary solution.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the Rust definitions exposed through PyO3 and checking how the generated Python definitions are currently represented. Review PyO3 issue 5137 and the existing type-checking setup, then define which exported types and signatures the stubs must cover. Done means the stubs describe the relevant bindings without leaving those types as Any and are documented as maintainable alongside the Rust definitions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, rust
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.