llvm / llvm/circt

[PyCDE] Enable client code to type check properly

Open
#7,412 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

PyCDE
Dominant language
C++
Stars
2.2k
Forks
524
Avg merge
3d 2h
Merged PRs (30d)
46

Description

As of today, it is impossible to use the pycde API in a way which pleases python type checkers (e.g. mypy). Make this possible. Will require API changes. Not sure that this is even possible given that we parameterize classes/functions so much.

Different from #3581 in that it doesn't require generating pybind11 stubs. That was only for internal development.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the PyCDE API and the distinction from issue #3581. Investigate how client code is exposed to mypy and whether the parameterized classes and functions can support type checking without generating pybind11 stubs. Done means PyCDE client code can type check properly without those generated stubs.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.